Skip to main content

Getting Started with Open API Authentication

Updated over a week ago

Connecting with our Open API is a simple process. It mainly involves generating and using an access token in three simple steps:

  1. Generate Access Token

  2. Use the Access Token

  3. Refresh the Token

Generate Access Token

Start by sending a request with the necessary details included in the request body. This will authenticate you and generate your access token.

Image

Use the Access Token

For this example, we’ve included the authorisation code, client ID, and client secret in the headers. These are used to call the authentication API. This API will return an access token, which is required to access any of our APIs.

To use the token, include it in the xxx-token header. In the example provided, you can see that the token has already been added

Image

Refresh the Token

Access tokens are valid for one hour. To keep your connection active without interruptions, use your refresh token to get a new access token.

We’ve added an API where you can pass your refresh token, and it will return a fresh access token along with a new refresh token.

Image

Note: Your new refresh token will be valid for 7 days.

Did this answer your question?