▶️API Authentication

The first step to integrate with Unitary's API is setting up authentication. Unitary's API provides an authentication endpoint which uses your API key to generate a Bearer token that must be included in any subsequent API requests you wish to make.

The endpoint reference below gives more detail about how to use the authentication endpoint, how to use the returned Bearer token, and the expiration of tokens.

This API Authentication guide assumes you have your API key already set up. If this is not the case, please email at [e-mail].

Endpoint reference

Authenticate with API Key to obtain an API token

Clients wishing to interact with the Unitary API must first authenticate by calling this endpoint with a valid API Key in the request body.

The resulting api_token should be used in subsequent API requests by including a header with the format:

Authorization: Bearer {api_token}

The api_token will be valid for a period of time (default 24 hours) and should be used for all subsequent API requests until it expires, or is invalidated.

This endpoint is rate-limited and may return error codes if too many authentication requests are submitted within a short time frame. For this reason clients should avoid re-authenticating too often.

POST/authenticate

Body

application/x-www-form-urlencoded

key*Key

Response

200422

Successful Response

Body

application/json

api_token*Api Token

expiry*Expiry

Request

JavaScriptCurlPython

const response = await fetch('/authenticate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "key": "password"
    }),
});
const data = await response.json();

Response

200422

{
  "api_token": "text",
  "expiry": "2024-11-21T07:09:18.275Z"
}

Example code

cURL

curl --location --request POST 'https://api.unitary.ai/v1/authenticate'
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode 'key={API_KEY}' 

Python

import requests
url = "https://api.unitary.ai/v1/authenticate"
API_KEY = "<api_key>"

payload = f"key={API_KEY}"
headers = { 'Content-Type': 'application/x-www-form-urlencoded' }
response = requests.request("POST", url, headers=headers, data=payload)

token = response.text["api_token"]
expiry = response.text["expiry"]

print(token, expiry)

Javascript

const fetch = require('node-fetch'); // Make sure you have 'node-fetch' installed for this to work
const url = "https://api.unitary.ai/v1/authenticate";
const API_KEY = "<api_key>";
const headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
const body = `key=${API_KEY}`;

fetch(url, { method: 'POST', headers: headers, body: body })
  .then(response => response.json())
  .then(json => {
    const token = json.api_token;
    const expiry = json.expiry;
    console.log(token, expiry);
  })
  .catch(error => console.error('error:', error));