wifidog 认证 Wiwiz Setup API参考手册与接口规范

1. 功能描述
Wiwiz Setup API是Wiwiz HotSpot Builder提供的基于Web的外部开发接口。调用它可以用于查询热点信息，创建、修改、删除热点，查询、添加、删除电子招待券，查询、创建、修改、删除访问控制规则等。

2. 使用条件与准备工作

已拥有Wiwiz专业版账户。
查询Wiwiz账户的User Key。
查询User Key的方法是：登录Wiwiz Web面板，点击“用户菜单”页面上的“升级选项”->“查询User Key”。

3. 调用概要
调用本API时，用户需向指定URL发送HTTP请求，发送请求时应根据接口规范指定参数（POST方式）。结果数据以HTTP响应的形式（XML格式）返回。

4. 共通说明

请求URL：
所有的请求都必须发送至 http://cp.wiwiz.com/as/s/setupapi/
所有的HTTP请求参数必须以HTTP POST的方式传送。
共通请求参数：
所有的请求都必须包含以下HTTP请求参数：

5. 接口规范
5.1. 查询热点基本信息
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
　　<status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误（*注1） -->
　　    <code>OK</code>
　　    <!-- message:  调用结果状态说明（供调试参考） -->
　　    <message>Operation Completed</message>
　　</status>
　　<data> <!-- 仅在code为OK时出现 -->
　　    <record> <!-- 每个record标签代表一条热点信息记录 -->
　　        <hotspot_id>1374085CF3C</hotspot_id> <!-- HotSpot ID -->
　　        <name>XXXXXX</name> <!-- 热点名称 -->
　　        <running_status>1</running_status> <!-- 认证接受状态。1代表接受认证，0代表拒绝认证 -->
　　    </record>
　　</data>
</result>

5.2. 查询热点详细设置信息
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误 -->
        <code>OK</code>
        <!-- message:  调用结果状态说明（供调试参考） -->
        <message>Query Completed</message>
    </status>
<data> <!-- 仅在code为OK时出现 -->
        <name>XXXXXX</name> <!-- 热点名称-->
        <running_status>1</running_status> <!-- 认证接受状态。1代表接受认证，0代表拒绝认证 -->
        <location>XXXX</location> <!-- 地点/街道地址 -->
        <timezone>Etc/GMT-8</timezone> <!-- 所在时区 -->
        <longitude></longitude> <!-- 经度 -->
        <latitude></latitude> <!-- 纬度 -->
        <owner_name>XXXX</owner_name> <!-- 管理员姓名 -->
        <owner_contact>XXXX</owner_contact> <!-- 管理员联系方式 -->
        <auth_agree>0</auth_agree> <!-- 要求认同条款认证方式。1代表启用，0代表禁用 -->
        <auth_voucher>0</auth_voucher> <!-- 电子招待券认证方式。1代表启用，0代表禁用 -->
        <auth_login>1</auth_login> <!-- 要求登录认证方式。1代表启用，0代表禁用 -->
        <logintype>0</logintype> <!-- 0代表“Wiwiz.com注册用户”方式，1代表“自定义账户”方式 -->
        <single_login>0</single_login> <!-- 禁止同一用户同时使用多个客户端。1代表启用，0代表禁用 -->
        <auth_api>0</auth_api> <!-- 调用Wiwiz Auth API认证方式。1代表启用，0代表禁用 -->
        <authapi_url></authapi_url> <!-- 认证URL（Wiwiz Auth API） -->
        <auth_sms>0</auth_sms> <!-- 手机验证认证方式。1代表启用，0代表禁用 -->
        <phone_country></phone_country> <!-- 国家地区代码（手机验证） -->
        <phone_repeat_interval>1</phone_repeat_interval> <!-- 重复验证间隔（手机验证） -->
        <phone_valid_interval>30</phone_valid_interval> <!-- 验证码有效期（手机验证） -->
        <phone_resend>0</phone_resend> <!-- 允许验证码有效期内重发短信（手机验证）。1代表启用，0代表禁用 -->
        <phone_maxtimes>5</phone_maxtimes> <!-- 每号码每日限制次数（手机验证） -->
        <phone_onlyonce>0</phone_onlyonce> <!-- 验证码仅限使用一次（手机验证）。1代表启用，0代表禁用 -->
        <phone_blacklst></phone_blacklst> <!-- 手机号码黑名单（手机验证）。多个值以“;”字符间隔 -->
        <phone_magic_code></phone_magic_code> <!-- 万能验证码（手机验证）。多个值以“;”字符间隔 -->
        <timeout>10</timeout> <!-- 认证超时 -->
        <isfree>0</isfree> <!-- 认证是否收取费用。1代表收费，0代表免费 -->
        <fee_min></fee_min> <!-- 费率(每分钟) -->
        <fee_quarter></fee_quarter> <!-- 费率(每一刻钟/15分钟) -->
        <fee_halfhr></fee_halfhr> <!-- 费率(每30分钟)  -->
        <fee_hr></fee_hr> <!-- 费率(每小时) -->
        <fee_day></fee_day> <!-- 费率(每天)  -->
        <fee_week></fee_week> <!-- 费率(每周) -->
        <fee_month></fee_month> <!-- 费率(每月) -->
        <fee_year></fee_year> <!-- 费率(每年) -->
        <currency></currency> <!-- 币种 -->
        <trial_time>0</trial_time> <!-- 可试用时长(分钟) -->
        <trymac_chk>0</trymac_chk> <!-- 阻止同一MAC地址设备重复试用。1代表启用，0代表禁用 -->
        <whiteaddr></whiteaddr> <!-- 域名/IP地址白名单。多个值以“;”字符间隔 -->
        <blackaddr></blackaddr> <!-- 域名/IP地址黑名单。多个值以“;”字符间隔 -->
        <incoming_max></incoming_max> <!-- 每连接最大接收流量 -->
        <outgoing_max></outgoing_max> <!-- 每连接最大发送流量 -->
        <authpage_type>1</authpage_type> <!-- 认证页面类型。0: 自定义URL; 1~99: 默认认证页面; 9999: 自定义HTML -->
        <authpage_url></authpage_url> <!-- 自定义认证页面URL -->
        <authpage_html></authpage_html> <!-- 自定义HTML -->
        <postauthpage_type></postauthpage_type> <!-- 认证后页面类型。0: 自定义URL; 1: 默认页面; 9999: 自定义HTML -->
        <postauthpage_url></postauthpage_url> <!-- 自定义认证后页面URL -->
        <postauthpage_html></postauthpage_html> <!-- 自定义认证后页面HTML -->
    </data>
</result>

5.3 创建新热点
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明（供调试参考）-->
        <message>HotSpot Created</message>
    </status>
<data> <!-- 仅在code为OK时出现 -->
        <!-- 创建的热点的HotSpot ID -->
        <hotspot_id>14006BD8DC6</hotspot_id>
    </data>
</result>

5.4 修改热点设置
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明（供调试参考）-->
        <message>HotSpot Updated</message>
    </status>
</result>

5.5 删除热点
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明（供调试参考）-->
        <message>HotSpot Deleted</message>
    </status>
</result>

5.6 查询电子招待券
请求参数说明：

返回数据示例与说明：

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <status>
        <!-- code: 调用结果状态码。
            值为OK代表调用成功；如果为以ERR开头的文字，则代表错误 -->
        <code>OK</code>
        <!-- message: 调用结果状态说明（供调试参考）-->
        <message>Operation Completed</message>
    </status>
    <data> <!-- 仅在code为OK时出现 -->
        <record> <!-- 每个record标签代表一条电子招待券记录 -->
            <voucher_id>9</voucher_id> <!-- 电子招待券的唯一存储标识 -->
            <voucher>123</voucher> <!-- 电子招待券文本。如果是多个电子招待券，则以“;”间隔 -->
            <onceonly>0</onceonly> <!-- 1代表仅可使用一次；0代表不限制；2代表仅可使用一次且已使用过 -->
            <minute>30</minute> <!-- 使用时长(分钟) -->
            <end_time></end_time> <!-- 截止时间 -->
            <expiretime></expiretime> <!-- 有效期 -->
            <client_num>0</client_num> <!-- 最大用户数。0代表不限制 -->
        </record>
    </data>
</result>

本文章由 http://www.wifidog.pro/2015/03/23/wifidog-wiwiz-setup-api.html 整理编辑，转载请注明出处

最新文章

分类

归档

其它