中国联通WLAN客户端接口规范V1.0(20120113).doc

中国联通WLAN客户端接口规范V1.0中国联通网络公司网络建设部2012年1月1.概述32.术语和缩略语33.接口规范33.1WLAN客户端登录接口33.1.1客户端与AC接口43.1.2AC响应客户端接口53.1.3客户端向PORTAL发送认证请求接口53.1.4用户身份鉴权接口83.2WLAN客户端退出接口83.1.1客户端向PORTAL发送注销请求接口93.1.2PORTAL响应客户端请求接口111. 概述联通WLAN客户端主要用于Windows PC用户、移动智能终端Android、iOS用户在联通WLAN信号覆盖区域进行接入退出、自助服务等功能的软件。该软件可以帮助用户免去通过页面重定向登录的繁琐方式，通过后台程序向Portal服务器进行认证登录退出等相关操作。本接口协议基于HTTP协议，定义了客户端与Portal服务器端进行通信报文的相关参数和格式。2. 术语和缩略语AAAAuthentication Authorization and Accounting认证、授权、计费APAccess Point接入点BRASBroadband Access Server宽带接入服务器CHAPChallenge Handshake Authentication Protocol盘问握手认证协议DHCPDynamic Host Configuration Protocol动态主机配置协议HTTPHyper Text Transport Protocol超文本传输协议HTTPSHypertext Transfer Protocol over Secure Socket Layer安全的HTTPIPInternet Protocol互联网协议WLANWireless LAN无线局域网PORTALPORTAL门户3. 接口规范3.1 WLAN客户端登录接口l 接口描述基于PC、iOS移动终端、Android移动终端的WLAN客户端，向Portal后台服务器发送认证请求。l 接口方向WLAN客户端ACRequestResponseWLAN客户端Portal服务器RequestResponsel 调用方式Http协议l 接口名称POSTSUBMIT3.1.1 客户端与AC接口WLAN客户端ACRequestl 消息名称Http getl 消息函数doGetl 消息参数接口请求消息包含如下信息：名称说明数据类型长度（字节）URL任意URL,如“”StringMethodHTTP_VERB_GETLPCTSTR3.1.2 AC响应客户端接口WLAN客户端AC Redirectl 消息名称Http redirectl 消息函数AC端提供l 消息参数1. 消息响应源：AC2. 消息响应数据格式名称说明数据类型长度（字节）http数字证书如HTTP/1.1 302 Moved temporarilyrnstringHostPortal域名地址string3.1.3 客户端向PORTAL发送认证请求接口WLAN客户端Portal服务器Postl 消息名称Http postl 消息函数OpenRequest、SendRequestExl 消息参数接口请求消息包含如下信息：名称说明数据类型长度（字节）URLLogin URL （Portal重定向地址）stringMethodHTTP_VERB_POSTLPCTSTRRequest包含http文件头和用户信息部分stringl Request参数包括header和userinfo，通过AddRequestHeaders连接。header参数如下：名称说明数据类型长度（字节）http数字证书POST /login.do HTTP/1.0stringAcceptimage/gif, image/jpeg, image/pjpeg, image/pjpeg, application/x-shockwave-flash, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, application/xaml+xml, application/x-ms-xbap, application/x-ms-application, */*stringRefererClient URL/wlan.exestringUser-Agent用于标示请求来源：l 联通WINDOWS PC版客户端软件：User-Agent: Chinaunicom /1.0 (Wlan Client;Windows NT5.1)l 联通iPhone版客户端软件： User-Agent: Chinaunicom /1.0 (Wlan Client;iOS4.1)l 联通Android版客户端软件： User-Agent: Chinaunicom /1.0 (Wlan Client;Android 1.6)stringContent-Typeapplication/x-www-form-urlencodedstringAccept-Encodinggzip, deflatestringHostPortal服务器地址：例如7stringContent-Length 176（根据request长度不同）stringConnectionKeep-AlivestringCache-Controlno-cachestringCookie 动态验证码，Portal认证过程中未使用stringuserinfo参数如下：名称值数据类型localArea用户所在地(各省份拼音简称)stringlocalNeedAuthIdyesstringroamNeedAuthIDnostringallowNumber186%2C156%2C130%2C133%2C131%2C132stringbasname空username用户手机号stringuserOpenAddress（用户手机开户地）stringpassword用户密码stringpasswordType6(用户密码长度)string3.1.4 用户身份鉴权接口l 消息名称Http Authentication Replyl 消息函数Portal服务器端提供l 消息参数1. 消息响应源：Portal服务器2. 消息响应数据格式：html名称说明数据类型长度（字节）http数字证书如HTTP/1.1 302 Moved temporarilyrnstring200认证成功；71“用户名/密码错误”；72“认证链接已经建立”；73“认证失败！确认是合法登录”；74“非法IP地址”stringServerApache-Coyote/1.1stringSet-Cookie设置cookie user_name,OpenAddress,savepwd等stringLocation7/online.jspstringContent-typetext/htmlstringContent-Length0stringDatestringConnectionstring3.2 WLAN客户端退出接口l 接口描述WLAN客户端向Portal后台服务器发送基于HTTP协议的下线请求。l 接口方向WLAN客户端Portal服务器RequestResponsel 调用方式Http协议l 接口名称POSTSUBMIT3.1.1 客户端向PORTAL发送注销请求接口1. 消息名称Http Logoffl 消息函数OpenRequest、SendRequestExl 消息参数接口请求消息包含如下信息：名称说明数据类型长度（字节）URLLogoff URL （Portal重定向地址）stringMethodHTTP_VERB_GETLPCTSTRRequest包含文件头和用户信息stringl Request参数包括header和userinfo，通过AddRequestHeaders连接。header参数如下：名称说明数据类型长度（字节）http数字证书POST /logout.do ?timelong=00:00:06 HTTP/1.0stringAcceptimage/gif, image/jpeg, image/pjpeg, image/pjpeg, application/x-shockwave-flash, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, application/xaml+xml, application/x-ms-xbap, application/x-ms-application, */*stringRefererClient URL/wlan.exestringUser-Agent用于标示请求来源：l 联通WINDOWS PC版客户端软件：User-Agent: Chinaunicom /1.0 (Wlan Client;Windows NT5.1)l 联通iPhone版客户端软件： User-Agent: Chinaunicom /1.0 (Wlan Client;iOS4.1)l 联通Android版客户端软件： User-Agent: Chinaunicom /1.0 (Wlan Client;Android 1.6)stringContent-Typeapplication/x-www-form-urlencodedstringAccept-Encodinggzip, deflatestringHostPortal服务器地址：例如7stringContent-Length 176（根据request长度不同）stringConnectionKeep-AlivestringCache-Controlno-cachestringCookie 动态验证码，Portal认证过程中未使用stringuserinfo参数如下：名称值数据类型showtimenostringtipflagnostringlocalArea(用户所在地)stringopenAddress(用户手机开户地）stringloginTipnostring3.1.2 PORTAL响应客户端请求接口l 消息名称Http Authentication Replyl 消息函数Portal服务器端提供l 消息参数1.