logo
API docs by Redocly

Authentication API (1.0)

Before interacting with our APIs, your application must authenticate and obtain an access token. This token authorizes API requests on behalf of your account, ensuring secure communication.

What You'll Learn on This Page:

  • How to authenticate and generate an access token
  • The required parameters for authentication

Authentication

Generate authentication token

Generates an authentication token. The token must be sent with the x-api-key header for all authenticated requests.

Authorizations:
bearerAuth
Request Body schema: application/json
required

The user credentials for authentication

username
required
string

Account username.

password
required
string

Account password.

method
required
string
Enum: "token" "cookie"

Authentication method;

name
string

useful to isolate activity of each token for the same user

twofa_token
string

2FA token. If not provided, an email will be sent with a new token. Required to receive an authentication token

Responses

Request samples

Content type
application/json
{
  • "username": "user123",
  • "password": "password123",
  • "method": "token",
  • "name": "string",
  • "twofa_token": "string"
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ1c2VyX2lkIjoiNzQifQH9Xrm7x1w3SldB9gUVShNquN9xdGK6qYivUB2G2xYWU"
}