API Authentication
Authentication Flow
Once you have your API key, you'll use it to authenticate via the authentication endpoint.
- Request Access Tokens
Send your API key to the authentication endpoint. In response, you'll receive:
- Access Token – used to authorise API requests
- Refresh Token – used to obtain a new access token when the current one expires.
The Access token will be valid for 15 minutes.
Use the Access Token
Include the access token in the Authorization header of every API request, using the following format:
Bearer {Access Token}Use the refresh endpoint
The /refresh endpoint should be used when a 401 is returned when authenticating a request. The refresh token acquired in the /authenticate request will need to be stored to then use in this request. On successful use of the /refresh endpoint a new access token and refresh will be supplied.