This document explains how to authenticate with our API, ensuring secure access to endpoints. Authentication is required for all protected routes.

Authentication Methods 🔐

  • OAuth 2.0
    Use this token-based flow for third-party integrations.

    OAuth_2.0
    [Learn more about OAuth setup](/en/Documentation/API/OAuth)
  • API Key
    Generate a unique key in your Account Dashboard and include it in requests.

    API_Key_Generation
  • Session Token
    For short-lived access, use tokens issued by the Authentication Endpoint

Request Headers 📡

Include one of these headers in your GET requests:

  • Authorization: Bearer <token>
  • X-API-Key: <your_key>

Example:

GET /api/data HTTP/1.1
Host: api.example.com
Authorization: Bearer xyz123
Request_Header_Example

For security best practices, see our Security Policy document.