WISPr Support for ZoneDirector Login Overview

The WISPr hotspot portal logon API supports the existing customer’s external logon page with a ZD-style login and logout (working with Zone Director (ZD). Customers, who already have a ZD deployment and have implemented their own external logon page for hotspot WLAN, can use ZD's API (provided by Ruckus) for UE authentication. The AP and controller provide the same API as that of ZD for customers to use their existing logon page.
Note: This new API is provided since controller's official portal integration using JSON requests does not support ZD login API. It is our recommendation that the customer works with the JSON API as documented in this guide - Hotspot Portal Integration Interface.

Customer Login

Customers who already have ZD deployment with their own external portal will be required to make a change to their login/logout URLs to match the new supported API.

The login/logout requests must include the parameters provided by controller's captive portal redirection. See Captive Portal Attributes Overview for details.

Login: The login request path in the external portal to the controller should be changed:

From: 

https://sip:9998/login

To: 

https://sip:9998/SubscriberPortal/hotspotlogin
Note: The login request also supports HTTP with port number 9997.
Note: This login request should include the customer login credentials such as the username and password parameters. It is expected that the customer's portal also sends the following parameters from Captive Portal's redirection -
  • url - the original URL which the user tried to browse
  • proxy - if the UE browser is set to Web proxy
  • uip - UE IP address
  • client-mac - UE MAC IP address

Customer Logout

The logout request path in the external portal to the controller should be changed:

From: 

https://sip:9998/logout

To: 

https://sip:9998/SubscriberPortal/hotspotlogout?uip=10.20.30.40

AP ZD-style Hotspot API

Customer external portal can use AP to send ZD-style login/logout requests. For logout/login examples, consult https://apIp:9998/SubscriberPortal/hotspotlogin and https://apIp:9998/SubscriberPortal/hotspotlogout.

Parent topic: WISPr Support for ZoneDirector Login