This article explains how to create and delete API Keys (authentication credentials used to authorise access to the Assure Customer API) within Assure. API Key management is available to users who hold the Manage API Supervisor Privilege. The API Access section is available to all customers immediately; however, API keys will not return data until the relevant API feature (data extraction or inbound user management) has been enabled and configured by Evotix. Up to 30 API keys can be created per customer. Each key must have a unique title. The key value is displayed only once at creation and cannot be retrieved later. Deleting a key immediately removes API access for any system using that key.
Prerequisites
- The user must hold the Manage API Supervisor Privilege in Assure.
- For data extraction or inbound user management to function, the relevant API must be enabled and configured by the Evotix Support Team.
- Data extraction (outbound API)
- User management integration (inbound API)
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:
| Limit | Value |
|---|---|
| Rate limit (requests per second) | 10 |
| Burst limit (requests per second) | 20 |
| Quota (requests per day) | 10,000 |
You can create up to 30 API keys to give you flexible for setting up your API integration to your requirement.
Settings > System Configuration > API Access
Each system interacting with the API should have its own dedicated API key. The title must:
- Be unique
- Clearly indicate the system using the key
- Be a maximum of 32 characters
- Contain only alphanumeric characters, underscores, and hyphens
The description should provide enough detail to understand the key's purpose.
- Click Show Key to reveal the key value.
- Click Copy Key to copy the value to the clipboard.
- Save the key value securely.
- Click Confirm.
AI Metadata
- Product Area: Customer API Management, System Configuration, API Access
- User Role: System Administrator (requires Manage API Supervisor Privilege); Evotix must enable the API functionality before use
- Tags: API Key, Customer API, API Access, data extraction, user management API, inbound API, outbound API, Manage API permission, rate limit, burst limit, usage plan, RESTful API
- Version/Region: All Assure versions; all regions
- Important Synonyms: API Key = API authentication key = API access key; Customer API = Assure Customer API = RESTful API; CDM = Customer Development Manager; CSM = Customer Success Manager; Manage API = Manage API Supervisor Privilege; data extraction API = outbound API; user management API = inbound API
- Suggested Embedding Keywords: create API key Assure, manage API keys Assure, delete API key Assure, Assure Customer API authentication, API Access System Configuration, Manage API permission Assure, Assure API rate limit, API usage plan Assure, how to add API key Assure, data extraction API key, inbound API key Assure
- Relevant Modules and Cross-Module Implications: This article sits within the System Configuration area of Assure, specifically API Access. API keys created here are used across multiple Assure API integrations including the Data Extraction API, the User Management API, the Person Register API, the Org Unit API, the SCIM API, and all inbound Customer API modules (Incident Analysis, Equipment Register, Claims Management, Supplier Contractor Register, and others). A single usage plan applies across all keys for a customer, combining inbound and outbound request counts. The Manage API Supervisor Privilege must be enabled before a user can access the API Access screen. Deleting a key impacts all external systems configured to use that key.