# Open API

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.

## Online Swagger - Cloud SDK Open API

Current SDK open API is available at the following URL: [CloudSDK Open API](https://l.workplace.com/l.php?u=https%3A%2F%2Fapi.lab.wlan.tip.build%2F\&h=AT2qj4RJnFaxruxpxP2s8O-XjRQMEbCC7aoVbHaHxmOxgfOgi5LHv6lWdCU4aV8x2vJcsxGmY-UKxb8W86xaDH-VtVLomBcBkdEHVxlpssluOoSPiIMC-vXU0NtGW44qktgKDJc934Dl2kr0QnRyZw)

## Local Swagger - Obtain latest Cloud SDK Open API Model

When running a local instance of Swagger, first obtain the most current Cloud SDK open API from source control:

{% embed url="<https://github.com/Telecominfraproject/wlan-cloud-services/blob/master/portal-services/src/main/resources/portal-services-openapi.yaml>" %}
TIP Github repo link to Open API data model&#x20;
{% endembed %}

### Install Swagger

```
mkdir ~/swagger
cd ~/swagger
git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
git clone https://github.com/swagger-api/swagger-ui.git
cd ~/swagger/swagger-editor
npm install
npm run build
npm start
```

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 [OAuth bearer ](https://tip-1.gitbook.io/openwifi/master/api/..#curl-request-to-controller-for-bearer-token)token to 'Authorize' your session.

![Successful login to Swagger on localhost:9091 ](https://4234315876-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MMa5rA2dKyutvejS11x%2F-MNKxsIBMlz8GzQ-6X5U%2F-MNL0J4v8I0bT9X4fpsQ%2Fswagger.jpeg?alt=media\&token=0ff0323d-9c67-4c57-81d2-b3a0c92f38ea)