User's Manual

C External Landing Page API
272 Installation and User Guide: Airgo Access Point
b The SSID that the station used to associate to the AP
c The IP address of the AP
3 Have available the server key that is shared with the AP. This secret key authenticates the
server to the AP.
4 Create the partial URL using the URL parameters of the form:
Xcmd=<cmd>&Xnp=<nextUrl>&Xid=<userId>&Xip=<ipAddress>&Xssid=<ssid>&Xmac=
<staMac>&Xdata=<data>&Xts=<timeStamp>
Any of the unused option parameters should be included, but the strings should be set to null.
The Order of these parameters MUST be the exactly as shown - else the check value will not
match.
For example:
Xcmd=crq&Xnp=www.hotspot.com&Xid=smith&Xip=&Xssid=coffeeShop&Xmac=00:0A:F
5:00:00:00&Xdata=60&Xts=0410280408
5 Calculate the SHA1 has algorithm over the string formed by placing the server key before and
after the partial URL:
hash = SHA1(server key | partial URL | server key)
6 Take only the first 8 octets of the hash and convert these octets to hex-ascii. This is the Xcv
parameter value.
7 Create the full URL by appending all of the above parameters to the base URL of the AP.
Unused parameters do NOT have to be included in the final URL sent to the AP. The base URL
is always of the form: https://<AP IP Address>/Forms/ExtCmd_html_1?
https://1.2.3.4/Forms/
ExtCmd_html_1?Xcmd=crq&Xnp=www.hotspot.com&Xid=smith&Xssid=coffeeShop&Xma
c=00:0A:F5:00:00:00&Xdata=60&Xts=0410280408&Xcv=92fbed6322fbd017
Response Return Codes
The Connect Response (crs) and the Disconnect Response (drs) carry result values to indicate
success or possible error conditions. The following response codes are supported:
Response Code Usage
0 Not used.
1 Invalid command.
2 Login success, filters removed for the station.
3 Digest check value error.
4 Time stamp error.
5 Duration value failure.
6 Connection request failure. Typically caused by station roaming to a
different AP.
7 Disconnect succeeded, filters reinstalled for the station.
8 Disconnect failed. Typically caused by the station already being
disassociated.
9 Not used.