All Collections
API Integrations
How to start working with NikoHealth APIs
How to start working with NikoHealth APIs

How to work with Swagger UI to work with APIs

R
Written by Rachel
Updated over a week ago

If you have purchased an API license subscription, you will be provided with a sandbox environment where you can begin developing and testing using a swagger interface. The Swagger UI will allow you to quickly learn and experiment with requests.

In the Swagger UI, endpoints will be grouped.

Before making any requests, you would authorize your session by clicking the Authorize button and completing the information required in the Authorization modal pictured below:

A client_id and client_secret will be provided to you. Learn more about the authorization protocol.

To make a request:

  1. Expand the desired endpoint

  2. Click Try it out.

  3. After you click Try it out, the example value in the Request Body field becomes editable. Once you edit the desired values, Click Execute.

  4. Swagger UI submits the request and shows the curl that was submitted. The responses section shows the response.

Did this answer your question?