api-docs v5.116.0

API Docs

Table of contents

• Authentication
  • Authentication - Authenticate
  • Authentication - Generate Token

Authentication

Authentication - Authenticate

Back to top

Authenticate using email/password

POST /authentication

Examples

Example usage:

curl "https://yourdomain.com/authentication" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "email": "email@domain.com",
    "password": "password"
  }'

Success response

Success response - Success 200

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "accessToken": "short-term-accesstoken",
  "uid": "user-uid"
}

Authentication - Generate Token

Back to top

Generate api token (long-lived access token)

POST /authentication

Examples

Example usage:

curl "https://yourdomain.com/authentication" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "action": "generateAPIToken"
  }'

Success response

Success response - Success 200

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "accessToken": "long-term-api-token",
  "type": "api"
}