Authentication

1. Overview

This API uses Breare Authorization API key for authentication to secure API requests and ensure data privacy. All requests must be authenticated with a valid token.

2. Authentication Methods

• API Keys

  • Key Location: In request header

  • Example: Authorization: Api-Key {your-api-key}

3. Obtaining Tokens

1. Log In to the Aitomatic DXA Factory

2. Choose Your Workspace

3. Access Workspace Settings

4. Navigate to the API Key tab

5. Generate a New API Key

4. Using Tokens

Example:

• Bearer Token Pass the access token in the Authorization header using the Bearer schema:

  Authorization: Bearer {access_token}

6. Error Responses

TBD

Example:

• 401 Unauthorized: Returned when the token is invalid or missing.

• 403 Forbidden: Returned when the token is valid but lacks required permissions.

Example Error Response:

{
  "error": "invalid_token",
  "error_description": "The access token expired"
}