Creating and managing your API keys

Creating and managing your API keys

In this article we’ll cover how you can manage your Customer API keys to enable you to set up data extraction API for your Assure records, as well as inbound API for integrating user management to your systems.

API key management will only be available to users with the Manage API Permission. The functionality is available to all customers immediately, but will not return any data until data extraction via API or user management via API is enabled and set up by Evotix. Please contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) should you be interested in procuring these.  

Usage plans

When using our API Key’s, a usage plan has been developed to ensure that you maintain a reasonable level of API usage. There is a single plan for each customer which is linked to all API keys for that customer, this means that these limits are combined across requests from both the inbound and outbound API’s for a given period. 

The limits per customer usage plan can be found below:

ADDING AN API KEY

You can create up to 30 API keys to give you flexible for setting up your API integration to your requirement. 

Step 1: 

Navigate to API Access

Settings > System Configuration > API Access

Step 2: 

Click the ‘New Record’ button

 
Step 3: 

Add a name and description for your API Key

Note: We strongly recommend that each system that is going to interact with the API has its own API key.

Each API key must have a unique title which gives clear indication of the system using the API key. The title can have a maximum length of 32 characters and it can only contain alphanumeric characters, underscores and hyphens. The description should provide enough detail to understand the API key’s purpose.

Step 4: 

Once the key has been created, click on the ‘show key’ and ‘copy key’ buttons. 

Note: This has to be saved and cannot be retrieved later.

Click confirm after this has been saved.

DELETING AN API KEY

API Keys can be deleted at any time, please ensure that you are happy to do this as this will remove access from your current API setup. You will not be able to export data from Assure if the API Key is deleted.

Step 1:

Delete the key by clicking on the bin icon on the far right of the table of API Key’s.

Step 2: 

Confirm the name is the key you intend to delete since this will be deleted permanently.