Our API provides flexible authentication options to suit different use cases. This section explains how to authenticate using credentials, Two-Factor Authentication (2FA), or ussing the Access Tokens.Authenticate with Username and Password#
Use this method to authenticate with a user's credentials (username and password). Depending on whether 2FA is enabled, the process may require an additional step.All API requests must include the API key in the headers. This is required for all endpoints, regardless of the authentication method used.# Headers Example
x-api-key: your-api-key
1.
Send a POST
request to /auth/sign_in
with the username and password.
2.
The server responds with an authentication token, which must be included in the Authorization
header for subsequent requests.
Example Request#
POST /auth/sign_in
Content-Type: application/json
{
"username": "your_username",
"password": "your_password"
}
Example Response#
{
"token": "your-auth-token",
}
Authorization: Bearer your-auth-token
Authentication with Access Token#
The Access Token method allows long-term authentication without requiring a login for each session. This is ideal for applications or scripts that need to interact with the API regularly.Generate an Access Token#
Access Tokens can be generated in the My Settings section of the portal or by using the PUT /v2/user/generate_access_token
endpoint. Once generated, the token does not expire and can be used for all API requests.Use an Access Token#
Include the token in the Authorization
header of your requests:Authorization: Basic your-access-token
Modified at 2025-04-24 11:02:04