OpenAPI

The Manager API is published as an OpenAPI Specification (OAS3). This standard allows you to import the file in many tools, either client or mock servers. There are also many tools to generate client code based on the specification. You can find more information about exsting tools on the OpenAPI Initiative webiste.

Postman

If you want to operate your gateway through the API for some testing, you can use the Postman API Client. We provide a full collection of requests provided by the API.

To set up Postman :

  1. Install Postman
  2. Download and import the OpenAPI specification
  3. Add a new Postman environment with the following variable

To execute the requests :

  1. Run the "API Info" request to check the connectivity.
  2. Update the "Login" request, set your own username/password in the "Authorization" tab.
  3. Execute the "Login" request. The authentication token will be saved into Postman.
  4. You can now execute the other requests. When the token times out, you will receive 401 error responses and you will have to log in again.