Authentication

Flare’s API is available at https://api.flare.io. Requests are authenticated with API tokens which can be obtained using an API key.

​

Authentication Objects and Purpose

​

Authentication Steps

​

1 - Obtaining an API key

Users can generate API keys by visiting the Profile page under the “API Keys” section.

Sidebar -> Configure -> Profile -> API Keys (bottom)

API keys are associated to a user and will have the same permissions as the user that generated them:

• If you can access a tenant, the API key will have access to that tenant.
• If you are an organization administrator, the API key will have organization administrator access.

​

2 - Obtaining an API Token

API tokens are obtained using Flare API keys. They can be generated using the tokens/generate

​

3 - Access an API endpoint

API tokens may then be used using by specifying the Authorization: Bearer <api-token> header.

API tokens can be tested using the tokens/test

​

Finding tenant IDs

Users can find the IDs of the tenants they have access to by visiting the Profile page under the “Tenants” section.

Sidebar -> Configure -> Profile -> Tenants

​

End-to-End Examples

These are end-to-end examples in various programming languages.

import os
import requests


api_key = os.environ.get("FLARE_API_KEY")
if not api_key:
    raise Exception("Please provide an API key")

# Generate the API token.
token: str = requests.post(
    "https://api.flare.io/tokens/generate",
    headers={
        "Authorization": api_key,
    },
).json()["token"]

# Now we can use our token to access the testing endpoint.
resp = requests.get(
    "https://api.flare.io/tokens/test",
    headers={
        "Authorization": f"Bearer {token}",
    },
)
print(resp.json())

import os

from flareio import FlareApiClient


api_key = os.environ.get("FLARE_API_KEY")
if not api_key:
    raise Exception("Please provide an API key")

client = FlareApiClient(api_key=api_key)

# Generate the API token.
token: str = client.generate_token()

# Now we can use our token to access the testing endpoint.
resp = client.get("/tokens/test")
print(resp.json())