TIP OpenWiFi project is a data-model driven design, meaning the features in the solution are designed as interfaces to be consumed either by micro-services, network devices, or other applications integrating with the solution.
The most useful way to learn the TIP OpenWiFi API is to consume the Swagger interface that fully describes all implemented REST methods.
TIP OpenWiFi controller uses OAuth for authentication. A bearer token must first be obtained for subsequent API calls to succeed.
Use the value from access_token for subsequent API calls into the controller
Online and Local Open API Access
TIP Open Wi-Fi controller implements an Open API compliant NorthBound Interface (NBI) to assist with integration and related back office features.
Cloud SDK north bound API is a key function for most open source community members or vendors seeking to consume the SDK for integration or for value added software development above the SDK layer.
Swagger is a useful tool to explore and learn any system API. Both online and local options are available to help development teams consume the Cloud SDK.
Running a local Swagger instance requires a current version of NodeJS installed.
Current SDK open API is available at the following URL:
When running a local instance of Swagger, first obtain the most current Cloud SDK open API from source control:
With Swagger running, open the Open API data model file and begin to use locally on port 9091 or add your own TIP Open Wi-Fi controller to the Swagger definitions. Remember to obtain an token to 'Authorize' your session.
