How to authenticate to start using the API

Authentication

Sandbox

Identity will be provided by the Authorization header with a plain Api-Key access token.

Production

To identify your API requests, there are three methods of authentication: JSON Web Token (JWT), API Key, and X-Signature.

JSON Web Token (JWT)

You will have to provide your logging credentials, and you will receive a token that will be attached in every request made to the API using the Authorization header:

Authorization: {JWT token}

To know more about how to authenticate for the API using JWT, please refer to Sign In endpoint.

API Key

You can use an API key for authentication. The API key should be included in the Authorization header like this:

Authorization: {API key}

X-Signature

The X-Signature option allows you to authenticate your requests using a signature. The signature should be included in the X-Signature header like this:

X-Signature: {signature}

In case a request does not provide the authorization token, or the token provided is not valid, the response status will be a 401. For more information about errors, go to Errors Section.