Northbound Interface Overview

RUCKUS One provides a third-party captive portal integration. RUCKUS One administrator sets up network options and chooses a captive portal provider.

A guest user joining the network sees a guest portal landing page hosted by the third-party service. Marketing messages, customized logos, and terms and conditions set up in the external web portal are displayed to the user. The user submitsprox login credentials that are 'proxied' to the third-party service for authentication and authorization. The login flow and message exchanges between various components are described in this guide. The JSON interface defined in this reference guide provides a standard way for an external web portal server to communicate with RUCKUS One for this type of usage.

This reference guide describes RUCKUS One RESTful-like/JSON interfaces for external web portal servers.

The following hotspot components are part of the hotspot portal:
  • RUCKUS One northbound interface (NBI): Receives NBI requests forwarded from the access point and enriches the URL. RUCKUS One NBI is also responsible for redirecting the incoming URL request and passing user login credentials to the external AAA server.
  • External subscriber portal: A web service. User sends login credentials (username and password) to this portal through the NBI. The external subscriber portal can reach the NBI through the API.
  • External AAA server: Responsible for authenticating the UE through the UE’s login credentials.
RUCKUS One Integration with Third-Party Captive Portal