Page Comparison

...

The best way to visualize and interact with the API is through Swagger.

Using Swagger Editor on the web

With Swagger Editor, you can view and edit the OpenAPI document inside your browser, while previewing the documentation in real time.

Visit https://editor-next.swagger.io/ and select File → Import file, or drag-and-drop the openapi.json file into the browser window.

You can then view and make edits to the OpenAPI document in the left panel (in YAML format) and visualize the UI in the right panel, or simply drag the divider all the way to the left if you are only interested in the UI.

Installing Swagger Editor locally

Swagger Editor can also be installed locally with https://github.com/swagger-api/swagger-editor, or by cloning the repository.

...

Then open index.html and import openapi.json.

You can then make edits to the OpenAPI document in the left panel (in YAML format) and visualize the UI in the right panel.

...

or drag-and-drop into the browser window.

Using Swagger UI standalone

If you do not need to view or edit the OpenAPI document, you can simply also use a standalone version of Swagger UI.

The tool https://github.com/vajahath/open-swagger-ui will allow you to open a local openapi.json file in the Swagger UI.

It requires Node.js >=10 and can be installed via npm:

npm i -g open-swagger-ui

Then, change to make sure you are in the directory containing openapi.json (or point the command to where it is located) and run:

open-swagger-ui .\openapi.json --open

...

In order to use the API, you will need to provide an authorization token.

When making an API call, use -H 'Authorization: Token 123abc', replacing 123abc with your token.

If you are using Swagger UI, click on the ‘Authorize’ button and use value Token 123abc, replacing 123abc with your token.

You can generate an authentication token from your username and password with a

{
  "username": "user123",
  "password": "pw123"
}

If you fail to authenticate, any API calls (except for /accounts/api-token-auth/) will return an error code 401.

When making an API call, use -H 'Authorization: Token 123abc', replacing 123abc with your token.

If you are using Swagger UI, click on the ‘Authorize’ button and use value Token 123abc, replacing 123abc with your token.

If you are using something like Postman, click on Headers and add these, replacing 123abc with your token.

...

Error Codes

The API uses conventional HTTP response codes to indicate the success or failure of an API request.

...

All API calls will generate a response in the format below:

{
  "requestId": null,
  "result": "",
  "error": null
}

• requestId contains a unique identifier for each request.

  • You can view the contents of a specific request with

    Status
    colour Blue title GET

    ​/api​/request​/{requestId}​/ .

• result contains the result of the request.

• error contains an error code and description if the request failed on the backend. (

  • Note: The API call, itself, will still be successful and return code 200

  )

  • .

Endpoints

...

...