Skip to main content

​
Adullam Get Token API

The Get Token API allows you to obtain an access token for authenticating your requests to the Adullam platform. This documentation provides details on how to use the Get Token API, including the required parameters and response format.

​
Endpoint

POST /v1/oauth/token

​
Request Parameters

The Get Token API requires the following parameters in the request body:
  • grant_type (string, required): The type of grant being used. Common values include client_credentials and authorization_code.
  • client_id (string, required): Your application’s client ID.
  • client_secret (string, required): Your application’s client secret.
  • code (string, optional): The authorization code received from the authorization server (required for authorization_code grant type).
  • redirect_uri (string, optional): The redirect URI used in the authorization request (required for authorization_code grant type).

​
Example Request

POST /v1/oauth/token
Content-Type: application/json
{
  "grant_type": "client_credentials",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}

​
Example Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 3600,
    "scope": "read write"
}

​
Response Parameters

The response from the Get Token API includes the following parameters:
  • access_token (string): The access token to be used for authenticating API requests.
  • token_type (string): The type of token issued (typically “Bearer”).
  • expires_in (integer): The duration in seconds for which the access token is valid.
  • scope (string): The scopes associated with the access token.

​
Using the Access Token

To use the access token, include it in the Authorization header of your HTTP requests to the Adullam REST API. The header should be formatted as follows: 
Authorization: Bearer YOUR_ACCESS_TOKEN
Replace YOUR_ACCESS_TOKEN with the actual access token you received.

​
Support

For assistance with the Get Token API, please refer to the support documentation or contact our support team at [email protected].