Auth

To authenticate a client, make a POST request to this endpoint, passing your clientId and clientSecret in the request body. These credentials are issued by the API provider and uniquely identify your client application on every request.

A successful request returns an accessToken, its tokenType, an expirationTime (EPOCH timestamp), and tokenValiditySec which is how long the token stays valid, in seconds.

The accessToken returned here must go in the Authorization header of every subsequent API call, so this endpoint is the required first step before anything else.

Headers

Name	Value	Description
Content-Type*	application/json	Format of the request payload

Body Parameters

Name	Data Type (Length)	Required	Description
clientId	string (100)		Unique identifier for the client application, issued by the API provider
clientSecret	string (100)		Secret key paired with the clientId, used to authenticate the client

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/auth/v1/authenticate' \
--header 'Content-Type: application/json' \
--data '{
  "clientId": "string",
  "clientSecret": "string"
}'

Response: 200

{
  "accessToken": "string",
  "tokenType": "string",
  "expirationTime": "long",//EPOCH time
  "tokenValiditySec": "long" //Token validity in Seconds
}