Authentication

Depending on your use case, you can choose between three different ways of authentication.

API Key

This is mainly used for automated systems. Two types of API Keys are provided

On-premises API keys

They are used to access the Edge in the same network environment with low latency. They are not linked to any user and grant full access to the on-premises API. To use them, you need to send the X-EDGE-API-KEY header as part of your HTTP request. Take a look at the following API calls to manage your on-premises API keys.

  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. On the right side, you will see the API key, as well as the ability to manage it by removing or adding new ones.


Cloud API keys

They are used to access the Cloud API and are linked to a user. You need to send the X-API-KEY header as part of your HTTP request. Take a look at the following API calls to manage your on-premises API keys.

  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 into your profile. On the right side, you will see the API key, as well as the ability to manage it by removing or adding new ones.


JWT

In addition to using API Keys for your user, a JWT can also be created. This token has an expiry time.

To create the token, use the Login User endpoint.

App Token

This token is useful if you want to give any user a temporary access. This user does not need to sign up on the LoconIQ system. The token has only access to a specific environment(s), Loci(s), and zone(s). A use case might be if you are integrating LoconIQ's localization system in your app and you want to restrict your user's access to certain Loci(s), zone(s), etc.

An app token is created using the Create App Token endpoint.