References¶
Retrieving an auth token¶
This endpoint can be called to exchange a client ID & client secret for a token which can then be used to call the other endpoints in the API.
POST /oauth2/token
Request¶
Headers¶
Note
The "token" here is your <clientID>:<clientSecret> base64 encoded.
| Header | Value |
|---|---|
| Authorization | Basic <token> |
| Content-Type | application/x-www-form-urlencoded |
URL Parameters¶
| Parameter | Type | Description | Required |
|---|---|---|---|
| grant_type | String | Indicates the grant type which will always be client_credentials |
Yes |
Sample Request¶
POST /oauth/token?grant_type=client_credentials
Response¶
| Fields | Type | Description |
|---|---|---|
| access_token | String | The access token you will use to make calls to the API endpoints. JSON Web Tokens is a popular format for implementing the access token. |
| token_type | String | The value will always be Bearer. |
| expires_in | Integer | If the access token expires, the server should reply with the duration of time in seconds the access token is granted for e.g. 3600. |
Sample Response¶
{
"access_token": "example-token",
"token_type": "Bearer",
"expires_in": 3600
}