目錄
?
?
自定義 portal 頁(yè)對(duì)接文檔
?
1、認(rèn)證接口簡(jiǎn)介
自定義認(rèn)證接口V2.0 在V1.1 的基礎(chǔ)上,簡(jiǎn)化了相關(guān)的認(rèn)證流程及代碼,無(wú)研發(fā)經(jīng)驗(yàn)的商戶自己也可以通過(guò)簡(jiǎn)單的配置,設(shè)置屬于自己的認(rèn)證模版。
環(huán)境說(shuō)明:
固件 2.6.0 版本及以上的 iKuai 路由器。
?
?
2、主要認(rèn)證方式
目前愛(ài)快所支持認(rèn)證方式:
?
認(rèn)證方式 |
說(shuō)明 |
微信連Wi-Fi |
微信連Wi-Fi |
手機(jī)認(rèn)證 |
通過(guò)輸入手機(jī)號(hào)在填寫(xiě)驗(yàn)證碼,驗(yàn)證通過(guò)上網(wǎng) |
用戶認(rèn)證 |
通過(guò)輸入路由器中設(shè)置的用戶名和密碼認(rèn)證上網(wǎng) |
上網(wǎng)碼認(rèn)證 |
通過(guò)輸入商家發(fā)放的優(yōu)惠券認(rèn)證上網(wǎng) |
固定密碼認(rèn)證 |
輸入路由器中設(shè)置的固定密碼認(rèn)證上網(wǎng) |
QQ 認(rèn)證 |
通過(guò)騰訊QQ 賬號(hào)和密碼認(rèn)證上網(wǎng) |
微博認(rèn)證 |
通過(guò)新浪微博賬號(hào)和密碼認(rèn)證上網(wǎng) |
一鍵認(rèn)證 |
無(wú)密碼認(rèn)證,點(diǎn)擊直接上網(wǎng) |
倒計(jì)時(shí)認(rèn)證 |
通過(guò)等待制定的時(shí)間認(rèn)證上網(wǎng) |
試用認(rèn)證 |
限時(shí)免費(fèi)一鍵認(rèn)證 |
?
?
3、認(rèn)證流程
?
在配置了自定義認(rèn)證的環(huán)境,為認(rèn)證的用戶鏈接網(wǎng)絡(luò)將自動(dòng)跳轉(zhuǎn)到配置的認(rèn)證頁(yè)面(在愛(ài)快云平臺(tái)認(rèn)證配置中選擇自定義模版,填寫(xiě)“自定義 URL”),在認(rèn)證頁(yè)面完成認(rèn)證流程后,回調(diào)路由放行接口,通知路由此用戶完成認(rèn)證,允許上網(wǎng)。
?
?
4、配置方法
?4.1自定義認(rèn)證流程配置
?
?
4.2配置認(rèn)證頁(yè)面
第一步,在?Portal?頁(yè)面的認(rèn)證入口按鈕添加出發(fā)URL,不同的認(rèn)證方式添加不同的出發(fā)?URL,如下:
認(rèn)證方式 |
觸發(fā) URL |
用戶認(rèn)證 |
|
上網(wǎng)碼認(rèn)證 |
|
固定密碼認(rèn)證 |
|
手機(jī)認(rèn)證 |
|
QQ 認(rèn)證 |
|
微博認(rèn)證 |
|
一鍵認(rèn)證 |
|
倒計(jì)時(shí)認(rèn)證 |
|
微信連 Wi-Fi |
?http://portal.ikuai8-wifi.com/Action/webauth-up?type=12 |
?試用認(rèn)證 | http://portal.ikuai8-wifi.com/Action/webauth-up?type=11 |
?
第二步,添加 JS 方法,在自定義的頁(yè)面內(nèi)添加以下代碼:
?
?
代碼示例:
?
?
第三步,部署自定義頁(yè)面,將此頁(yè)面部署到服務(wù)器上,支持內(nèi)網(wǎng)服務(wù)器部署。將此頁(yè)面的 URL
地址配置在云平臺(tái)上。
?
4.3?填寫(xiě) Portal?頁(yè)面 URL
?
?
?
4.4設(shè)置認(rèn)證方式
配置與 Portal?頁(yè)面對(duì)應(yīng)的認(rèn)證方式,認(rèn)證成功的落地頁(yè)面在“成功后跳轉(zhuǎn)至”選項(xiàng)內(nèi),點(diǎn)擊保存,設(shè)置完成。
?
?
?
?
?
?
?
自定義認(rèn)證對(duì)接文檔
?
1、認(rèn)證接口簡(jiǎn)介
相比其它認(rèn)證方式,自定義認(rèn)證為客戶提供了一種更靈活的認(rèn)證方式,不僅可以自定義認(rèn)證頁(yè),也可以根據(jù)客戶需求自定義認(rèn)證方式(包括第三方小程序認(rèn)證);同時(shí),又豐富的審計(jì)字段,可以滿足審計(jì)需求。
?
2、環(huán)境說(shuō)明
固件 3.1.4 及以上版本支持;
?
?
3、對(duì)接方式
3.1?認(rèn)證流程
在認(rèn)證頁(yè)面完成認(rèn)證流程后,回調(diào)路由放行接口,通知路由此用戶完成認(rèn)證,允許上
網(wǎng)。
?
?
3.2?第三方認(rèn)證服務(wù)器驗(yàn)證成功以后,調(diào)用“放行接口”放行客戶端
此請(qǐng)求接口為通用的第三方認(rèn)證接口,請(qǐng)求方式: GET
放行接口示例:
?
a、網(wǎng)頁(yè)放行接口 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
?
說(shuō)明:第三方認(rèn)證服務(wù)器拼接放行 URI 后,返回給對(duì)應(yīng)客戶端,由客戶端主動(dòng)發(fā)起對(duì)路由器放行接口的請(qǐng)求。
?
?
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
?
?
愛(ài)快路由返回參數(shù)(適用小程序或 APP 認(rèn)證)
{
"result":10000, ---錯(cuò)誤碼
"errmsg":"認(rèn)證成功" ---接口返回成功或失敗的提示信息"data":{
expires ---過(guò)期時(shí)間 0 代表不過(guò)期
download ---下行限速u(mài)pload ---上行限速mac ---mac 地址
?
interface ---接口名webid --- 認(rèn) 證 id username ---用戶名ip_addr ---ip 地址
},
}
?
?
?
3.3?token計(jì)算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?參數(shù)說(shuō)明:
- key: 為云平臺(tái)生成的 appkey;
- user_ip客戶端 IP;
- timestamp時(shí)間戳;
- mac: 可以為空, mac為空時(shí), mac=參與計(jì)算 token。 不為空時(shí), mac=xxx?參與計(jì)算 token;
- upload上傳速率,單位KB,>= 0?的正整數(shù),0?表示不限速。如:upload=512;
- download下載速率,單位 KB,>= 0?的正整數(shù),0?表示不限速。如:
download=2048;
- user_id用戶名,可以為空, (審計(jì)字段);
- custom_name自定義認(rèn)證的名稱,字符小于 32 個(gè)字節(jié) (審計(jì)字段);
- phone 手機(jī)號(hào)碼,可以為空;
- name姓名,可以為空;
- comment備注,可以為空;
- timeout表示認(rèn)證超時(shí)時(shí)間, 單位為分鐘。 到期后,自動(dòng)踢下線。 0?表示不過(guò)期;
- token驗(yàn)證請(qǐng)求的合法性;
- release_type值為 1?通過(guò)網(wǎng)頁(yè)認(rèn)證,值為 2?則使用小程序或 APP?認(rèn)證(數(shù)據(jù)返回格式為 Json);
?
?
user_id?和 custom_name?所填充的賬號(hào)前需根據(jù)賬號(hào)類型增加前綴,前綴定義: “賬號(hào)前綴_賬號(hào)類型”;
示例:
“1020003_?IMSI“;
“1020004_?手機(jī)號(hào)”; “1020006_ IMEI“;
“1021111_ 身份證“;
user_id 可以為多個(gè)類型賬號(hào)拼接,使用逗號(hào)作為分隔符,如: user_id=1020003_imsi,1020004_phone_number,1020006_imei;
?
注意:傳參數(shù)的時(shí)候不能把 key 也加入,key 只在計(jì)算 token 時(shí)使用。
?
?
4、配置方法
1、在愛(ài)快云平臺(tái)認(rèn)證配置中選擇“自定義”認(rèn)證類型,然后選擇“自定義認(rèn)證”,并填 寫(xiě)“自定義鏈接”,認(rèn)證頁(yè)面和認(rèn)證方式完全由客戶自定義開(kāi)發(fā),也可以滿足 app?及微信小程序?qū)拥男问酵瓿烧J(rèn)證操作,通過(guò) app?上操作來(lái)觸發(fā)認(rèn)證流程;
2、手動(dòng)填寫(xiě)或者點(diǎn)擊“生成”按鈕獲取 appkey,進(jìn)行對(duì)接開(kāi)發(fā)并驗(yàn)證;
?
?
?
?