Getting Started

Authorization

To access the endpoints exposed in the API, you must generate an authorized JWT token.

Authentication Request

POST [host]/api/auth

[!NOTE] Replace [host] with the environment URL

Headers

HeaderValueDescription
x-api-key{{api-key}}Your account or sandbox API key.

Response Example

{
    "success": true,
    "message": "Authorized",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIU[...]",
    "request_id": "227fc177af26703c1e3330e984b1919e"
}
{
    "success": true,
    "message": "Authorized",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIU[...]",
    "request_id": "227fc177af26703c1e3330e984b1919e"
}
[!IMPORTANT]
This JWT must be included as a Bearer token in the authorization header to access all session-related endpoints.

HTTP
Authorization: Bearer <your_jwt_token>