Authentication

Before using this API, you must obtain an Authentication Token from the authToken endpoint. Use that endpoint to pass your client credentials and receive an accessToken. Then hit the Authorize button and paste the token into that field. This will allow you to make requests to the protected endpoints.

Authentication

POST/authToken Retrieve an Auth Token for use with protected endpoints.

Returns an accessToken to be passed in the Authorization header for other endpoints. By default, the token lasts 24 hours, and the response will include the number of seconds the token expiresIn. This token is cached on the API, so subsequent calls are very fast and will return the same token until expiration is near.

It is an advisable best practice to either call the authToken endpoint before every call, or to cache the token on your end, and be prepared to respond to a 401 once the token has expired by retrieving a new token and resending the request.

application/json

Example Value / Schema
{
  "clientId": "abcdefg",
  "clientSecret": "hijklmnopqrstuvwxyz"
}

Responses

Code Description
200

Success

Media Type: application/json

Example Value / Schema

{
  "accessToken": "aBcDeFgGHiJkLmNoP",
  "expiresIn": 86400
}