API Reference

Postman Collection

🚧

This page refers to the Legacy API which is deprecated

Swagger

Open API 3.0.0 specification for our APIs hosted here

You can use this specification to generate client libraries to interact with our REST API in your language of choice or swagger editor (eg this) to test our APIs.

You can also use this definition to create a postman collection for testing purposes as follows:

  1. Click this link. This will open the swagger JSON file in the browser.
  2. Copy the URL and import it into Postman as follows:
    a. Open Postman
    b. In your workspace click the Import button:

c. Select the Link tab and paste the swagger json URL into the URL field and click the Continue button:

d. Click the Import button:

e. The API will be imported into your postman collection. Happy requesting!!!