Overview

The Northbound Portal interface supports the following JSON commands:
  • Login
  • Login Async
  • Logout
  • Status
  • Disconnect
  • Enrichment Info

These commands are used for user authentication, user status query, terminating user sessions and verifying that the enrichment information has the same content. For each command (JSON POST), both the UE-IP and UE-MAC may be included. Where both are present, the UE-MAC will be preferred.

The NBI decrypts the strings and returns the decrypted version within the response message. This is because the Captive Portal (CP) encrypts the IP and MAC address parameters in each redirection (See the Table for the full list of these parameters) to the subscriber portal. The controller decrypts the UE-IP and UE-MAC address before returning the response, by using the Encrypt and Decrypt API described in JSON Responses - GetConfig section.

Note: Northbound Interface (NBI) expects to receive encrypted UE-IP and UE-MAC address (For example, ENC12bc24c4777703327f2e0aabbf6b9f9e) when the request category is UserOnlineControl. In the GetConfig request category you do not need to encrypt UE-IP and UE-MAC address (For example: 172.21.134.87 or 2001::87)