Authentication

Choose from three authentication methods depending on your use case.

API Key

Use API keys for automated systems. Two types are available:

On-premises API keys

On-premises API keys access the Edge in the same network environment with low latency. These keys are not linked to any user and grant full access to the on-premises API. Send the X-EDGE-API-KEY header as part of your HTTP request to authenticate.

Manage your on-premises API keys with the following endpoints:

  1. List On-Premise API Key
  2. Create On-Premise API Key
  3. Delete On-Premise API Key

Where to find the On-premises API keys

To find the on-premises API keys, log in to the dashboard and click on an edge. The API key appears on the right side, where you can also remove or add new keys.

On-premises API key shown in the edge detail panel of the dashboard

Cloud API keys

Cloud API keys access the Cloud API and are linked to a user. Send the X-API-KEY header as part of your HTTP request to authenticate.

Manage your cloud API keys with the following endpoints:

  1. Create API Key
  2. Delete API Key

Where to find the cloud (user) API keys

To find the cloud (user) API keys, log in to the dashboard and go to your profile. The API key appears on the right side, where you can also remove or add new keys.

Profile page in the dashboard showing the cloud API key section Cloud API key management options in the dashboard profile

JWT

In addition to API keys, you can create a JWT (JSON Web Token) for your user. This token expires after a set duration.

To create the token, use the Login User endpoint.

App Token

Use app tokens to grant temporary access to users who do not have a LoconIQ account. Each token restricts access to specific environments, Loci, and zones. For example, if you integrate LoconIQ's localization system into your app, use an app token to limit a user's access to designated Locis and zones.

Create an app token with the Create App Token endpoint.