Skip to main content

Authentication & Authorization 🔐

All API endpoints require authentication and are protected by an X-API-Key header containing a unique API key. This ensures secure access to resources. To access these endpoints, you must include a valid API key in the X-API-Key header of your HTTP request.

Obtaining an API Key​

  1. Contact Support or Company Representative: To receive an API key, please reach out to our support team or your company representative. They will guide you through the process based on your use case and access level.

  2. Key Issuance: Upon verifying your request, a unique API key will be issued to you. This key will serve as your credential for accessing the protected endpoints.

Using the API Key​

Once you have obtained your API key, include it in the X-API-Key header of each API request you make.

Example of Including API Key in Header​

GET https://api.hiveon.ai/api/endpoint HTTP/1.1
Host: api.hiveon.ai
X-API-Key: <your_api_key>

Replace <your_api_key> with the API key you received from support or your company representative.