Authentication
Generate Token
To access the API, a bearer token has to be included as a header while making requests. This token is obtained by accessing the auth endpoint, providing necessary credentials. Authentication involves the below steps:
-
Authentication Endpoint: Generating a token requires a
POSTrequest to the/auth/tokenendpoint. Auth API Reference -
Payload: Respective
clientIdandsecretkeys have to be included in request body. These fields can be accessed in the Settings tab after logging into WebApp -
Receive Token: If authentication is successful, the API response will include the token in the
access_tokenkey. -
Using the Token: Include the received token as a bearer token in the
Authorizationheader in subsequent API requests. The header format will beAuthorization: Bearer <access_token>.
Say the access-token string is: "ey.abcd.1234". This will be passed as a request header as in "Authorization': Bearer ey.abcd.1234".