DocumentationAPI ReferenceGet Started
Documentation

API Keys

Suggest Edits

On this page:

Overview of API Keys

API Keys are required to access our REST API methods either through code or through our front end widgets. API keys give you access to your data, allow you to configure services, and permit access to our services.

🚧

Mandatory Requirement

API keys are not optional for any AutoQL API operation; any operation will fail without one.

How API Keys are Implemented

We will provide you with two API keys:

  • Sandbox Key (a key for your test/sandbox environment)
  • Production Key (a key for your live/production environment)

Providing two keys allows us to completely separate your environments and gives you internal control over who can access your customer's data. However, API keys only ensure that a request is coming from your company and is routed to the correct environment, they do not distinguish between agents or users. To distinguish between users, you will need to properly configure JWTs.

Accessing API Keys

In the Portal

Key cancelling and re-provisioning is performed through the AutoQL Integrator Portal within the API Keys section.

To access your API keys through the Integrator Portal, navigate to AutoQL Setup and select API Keys. Here, you'll find the keys that connect your Projects (both Sandbox and Production Projects) to the API.

Key generation, key cancelling, and key re-provisioning can be performed through the AutoQL Integrator Portal.

Using APIs

Supply your API key using a query parameter named key as shown in the following cURL example:

curl "https://${DOMAIN}/autoql/api/v1/health?key=${API_KEY}"

API Key Types

Two types of keys are made available:

  • Sandbox Keys - Key(s) for your test/Sandbox environment
  • Production Keys - Key(s) for your live/Production environment

API Key Statuses

Check the status of your API keys through the Integrator Portal:

  • In Use - status assigned to an active API key that should be distributed to all of your projects.
  • Idle - status assigned to an old key when a new one has been generated. This is intended to allow for a brief window of time for Integrators to transition between an old key and a new key (which will appear as "In Use" once active).

Generating New API Keys

To generate a new API key, find the existing key you wish to change and click the + icon (located in the far right column.) You'll be asked to confirm that you wish to update your existing API key. Proceeding with this step will generate a new key and convert the status of the old key to "Idle".

🚧

Implication of generating a new API key

When generating a new API key, we highly recommend that you update your team to ensure that anyone who may be affected by this change is aware that a new key has been generated and is "In Use".

Removing API Keys

Find the key you wish to remove and click the X icon on the far right column. This will generate a new API key, and convert the status of the old key to "Idle".

The option to remove a key is only available once a new key has been generated. Therefore, only "Idle" keys can be removed.

Because "In Use" keys cannot be removed, the remove option (X) is not available/will not show up beside these keys.

❗️

Implication of removing an existing API key

Ensure that the key you wish to remove is no longer "In Use" (has changed to "Idle" status) before attempting to delete it.

Updated over 2 years ago