Developer Overview

Authentication

5min

API Key Authentication
All requests must be made over HTTPS and must be authenticated using an API key passed as a header.
HTTP Header "X-API-KEY"
X-API-Key:{token}
Example:
X-API-Key: org-demo-key
Unauthorized calls will result in a 401 Unauthorized response.
JS
{
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Unauthorized",
    "error_details": {
        "detail": [
            "Unauthorized"
        ]
    }
}
{
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Unauthorized",
    "error_details": {
        "detail": [
            "Unauthorized"
        ]
    }
}
﻿
Generate API Keys
You can manage and generate your API keys from the API keys page in the settings section of the dashboard.
API keys can be managed and from the API keys page in the settings section. 
﻿
To generate a new API key:
Click on the Generate API Key button.
Give your key a name.
Click on the Generate button.
Generating an API key
﻿
The generated key will be displayed as an alert on the screen. You can only view the full key once so it's best to store it somewhere safe before moving on.
Security
Keep Api-Keys secret!
API keys must be kept secret. They should not be in your client-side code (browser, HTML or javascripts) or checked into your application's code. 
We recommend that Api-keys are stored in a "secret manager" along with your other secrets like Database credentials. Hint: GCP Secret manager or AWS Secret manager﻿
﻿

Updated 27 Sep 2023

Did this page help you?

Live vs Test Environment

Status Code

Docs powered by Archbee

TABLE OF CONTENTS

API Key Authentication

HTTP Header "X-API-KEY"

Keep Api-Keys secret!