目录
自定义 portal 页对接文档
1、认证接口简介
自定义认证接口V2.0 在V1.1 的基础上，简化了相关的认证流程及代码，无研发经验的商户自己也可以通过简单的配置，设置属于自己的认证模版。
环境说明：
固件 2.6.0 版本及以上的 iKuai 路由器。
2、主要认证方式
目前爱快所支持认证方式：
|
认证方式 |
说明 |
|
微信连Wi-Fi |
微信连Wi-Fi |
|
手机认证 |
通过输入手机号在填写验证码，验证通过上网 |
|
用户认证 |
通过输入路由器中设置的用户名和密码认证上网 |
|
上网码认证 |
通过输入商家发放的优惠券认证上网 |
|
固定密码认证 |
输入路由器中设置的固定密码认证上网 |
|
QQ 认证 |
通过腾讯QQ 账号和密码认证上网 |
|
微博认证 |
通过新浪微博账号和密码认证上网 |
|
一键认证 |
无密码认证，点击直接上网 |
|
倒计时认证 |
通过等待制定的时间认证上网 |
|
试用认证 |
限时免费一键认证 |
3、认证流程
在配置了自定义认证的环境，为认证的用户链接网络将自动跳转到配置的认证页面（在爱快云平台认证配置中选择自定义模版，填写“自定义 URL”），在认证页面完成认证流程后，回调路由放行接口，通知路由此用户完成认证，允许上网。
4、配置方法
4.1自定义认证流程配置
4.2配置认证页面
第一步，在 Portal 页面的认证入口按钮添加出发URL，不同的认证方式添加不同的出发 URL，如下：
|
认证方式 |
触发 URL |
|
用户认证 |
|
|
上网码认证 |
|
|
固定密码认证 |
|
|
手机认证 |
|
|
QQ 认证 |
|
|
微博认证 |
|
|
一键认证 |
|
|
倒计时认证 |
|
|
微信连 Wi-Fi |
http://portal.ikuai8-wifi.com/Action/webauth-up?type=12 |
| 试用认证 | http://portal.ikuai8-wifi.com/Action/webauth-up?type=11 |
第二步，添加 JS 方法，在自定义的页面内添加以下代码：
代码示例：
第三步，部署自定义页面，将此页面部署到服务器上，支持内网服务器部署。将此页面的 URL
地址配置在云平台上。
4.3 填写 Portal 页面 URL
4.4设置认证方式
配置与 Portal 页面对应的认证方式，认证成功的落地页面在“成功后跳转至”选项内，点击保存，设置完成。
自定义认证对接文档
1、认证接口简介
相比其它认证方式，自定义认证为客户提供了一种更灵活的认证方式，不仅可以自定义认证页，也可以根据客户需求自定义认证方式（包括第三方小程序认证）；同时，又丰富的审计字段，可以满足审计需求。
2、环境说明
固件 3.1.4 及以上版本支持；
3、对接方式
3.1 认证流程
在认证页面完成认证流程后，回调路由放行接口，通知路由此用户完成认证，允许上
网。
3.2 第三方认证服务器验证成功以后，调用“放行接口”放行客户端
此请求接口为通用的第三方认证接口，请求方式: GET
放行接口示例:
a、网页放行接口 https://portal.ikuai8-wifi.com/Action/webauth-
up?type=20&user_id=1234567890&custom_name=test&user_ip=192.168.88.100
×tamp=123456789&mac=00:50:56:c0:00:08&upload=0&download=0&toke
n=6b2f563f02a209a2f3ed510e3ea9f88d&release_type=1
说明：第三方认证服务器拼接放行 URI 后，返回给对应客户端，由客户端主动发起对路由器放行接口的请求。
b、小程序或APP 放行接口 https://portal.ikuai8-wifi.com/Action/webauth-
up?type=20&user_id=1234567890&custom_name=test&user_ip=192.168.88.100
×tamp=123456789&mac=00:50:56:c0:00:08&upload=0&download=0&toke
n=6b2f563f02a209a2f3ed510e3ea9f88d&release_type=2
爱快路由返回参数（适用小程序或 APP 认证）
{
"result":10000, ---错误码
"errmsg":"认证成功" ---接口返回成功或失败的提示信息"data":{
expires ---过期时间 0 代表不过期
download ---下行限速upload ---上行限速mac ---mac 地址
interface ---接口名webid --- 认 证 id username ---用户名ip_addr ---ip 地址
},
}
3.3 token计算token=md5(“user_ip=1.2.3.4×tamp=1542019734&mac=11:22:33:44:55:66& upload=10&download=10&key=xxx)
3.4 参数说明：
- key： 为云平台生成的 appkey；
- user_ip客户端 IP；
- timestamp时间戳；
- mac： 可以为空, mac为空时， mac=参与计算 token。 不为空时， mac=xxx 参与计算 token；
- upload上传速率，单位KB，>= 0 的正整数，0 表示不限速。如：upload=512；
- download下载速率，单位 KB，>= 0 的正整数，0 表示不限速。如：
download=2048；
- user_id用户名，可以为空, (审计字段)；
- custom_name自定义认证的名称，字符小于 32 个字节 (审计字段)；
- phone 手机号码，可以为空；
- name姓名，可以为空；
- comment备注，可以为空；
- timeout表示认证超时时间， 单位为分钟。 到期后，自动踢下线。 0 表示不过期；
- token验证请求的合法性；
- release_type值为 1 通过网页认证，值为 2 则使用小程序或 APP 认证（数据返回格式为 Json）；
user_id 和 custom_name 所填充的账号前需根据账号类型增加前缀，前缀定义： “账号前缀_账号类型”；
示例：
“1020003_ IMSI“；
“1020004_ 手机号”； “1020006_ IMEI“；
“1021111_ 身份证“；
user_id 可以为多个类型账号拼接，使用逗号作为分隔符，如: user_id=1020003_imsi,1020004_phone_number,1020006_imei；
注意：传参数的时候不能把 key 也加入，key 只在计算 token 时使用。
4、配置方法
1、在爱快云平台认证配置中选择“自定义”认证类型，然后选择“自定义认证”，并填 写“自定义链接”，认证页面和认证方式完全由客户自定义开发，也可以满足 app 及微信小程序对接的形式完成认证操作，通过 app 上操作来触发认证流程；
2、手动填写或者点击“生成”按钮获取 appkey，进行对接开发并验证；
