Our API uses API key-based authentication to ensure secure access. Every API request must be authenticated by including your API key in the HTTP request headers. Below is a detailed guide on how authentication works:

  • API Key Inclusion:

    All API requests should include your API key in the Authorization HTTPS header. The format should be as follows:

    Authorization: Bearer <YOUR_API_KEY>

    Replace <YOUR_API_KEY> with your actual API key obtained from the platform.

  • Obtaining Your API Key:

    1. User Registration & Login: 
      • Start by signing up or logging into the Aurora platform.
    2. Service Account Creation:
      • Navigate to your account’s organization settings.
      • In the API section, create a service account under the appropriate project.
    3. Generate API Keys:
      • Once the service account is created, generate one or more API keys.
      • These API keys are tied to specific projects of the service account and are used to authenticate your API calls.

  • Error Handling for Authentication:

    • 403 Forbidden: If your API key is missing, incorrect, or does not have the necessary permissions, the API will return a 403 error.
    • Tips: Ensure that the API key is correctly formatted in the header and that it hasn’t expired or been revoked.
Previous
Setting Up
Next