目錄
?
?
自定義 portal 頁對接文檔
?
1、認證接口簡介
自定義認證接口V2.0 在V1.1 的基礎上,簡化了相關的認證流程及代碼,無研發(fā)經驗的商戶自己也可以通過簡單的配置,設置屬于自己的認證模版。
環(huán)境說明:
固件 2.6.0 版本及以上的 iKuai 路由器。
?
?
2、主要認證方式
目前愛快所支持認證方式:
?
認證方式 |
說明 |
微信連Wi-Fi |
微信連Wi-Fi |
手機認證 |
通過輸入手機號在填寫驗證碼,驗證通過上網 |
用戶認證 |
通過輸入路由器中設置的用戶名和密碼認證上網 |
上網碼認證 |
通過輸入商家發(fā)放的優(yōu)惠券認證上網 |
固定密碼認證 |
輸入路由器中設置的固定密碼認證上網 |
QQ 認證 |
通過騰訊QQ 賬號和密碼認證上網 |
微博認證 |
通過新浪微博賬號和密碼認證上網 |
一鍵認證 |
無密碼認證,點擊直接上網 |
倒計時認證 |
通過等待制定的時間認證上網 |
試用認證 |
限時免費一鍵認證 |
?
?
3、認證流程
?
在配置了自定義認證的環(huán)境,為認證的用戶鏈接網絡將自動跳轉到配置的認證頁面(在愛快云平臺認證配置中選擇自定義模版,填寫“自定義 URL”),在認證頁面完成認證流程后,回調路由放行接口,通知路由此用戶完成認證,允許上網。
?
?
4、配置方法
?4.1自定義認證流程配置
?
?
4.2配置認證頁面
第一步,在?Portal?頁面的認證入口按鈕添加出發(fā)URL,不同的認證方式添加不同的出發(fā)?URL,如下:
認證方式 |
觸發(fā) 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、環(huán)境說明
固件 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 后,返回給對應客戶端,由客戶端主動發(fā)起對路由器放行接口的請求。
?
?
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 個字節(jié) (審計字段);
- 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、在愛快云平臺認證配置中選擇“自定義”認證類型,然后選擇“自定義認證”,并填 寫“自定義鏈接”,認證頁面和認證方式完全由客戶自定義開發(fā),也可以滿足 app?及微信小程序對接的形式完成認證操作,通過 app?上操作來觸發(fā)認證流程;
2、手動填寫或者點擊“生成”按鈕獲取 appkey,進行對接開發(fā)并驗證;
?
?
?
?