In the setup environment in MICE, you can create and manage your own API keys. In this article you will find an explanation of what an API key is, the available options, and how to use them.
You can find the API key section via Setup > Integrations > API Keys.
What is an API Key?
An API key is a type of digital key. You can compare it to the key to your front door: only with the right key do you gain access. In this case, the API key grants your systems or apps access to data from your MICE account.
With an API key, you can securely and automatically exchange data between MICE and other systems you use.
⚠️ Important: Just like a real key, you should handle your API key with care. If someone else gets hold of it, they could also gain access to your data or systems (to read, modify, or delete data). Never share an API key with untrusted parties.
Features in the API Key Section
In the API key section, you can perform several actions:
1. Creating a new API Key
Users with the role Administrator can easily generate a new API key:
Go to Setup > Integrations > API keys.
Click the + New API key button.
Optionally, give the key a recognisable name (e.g. the name of the application or integration).
Confirm the action.
💡Tip: Create a separate API key for each integration and use a clear name. This way, you will always know which key belongs to which integration and data exchange.
API Key Overview
In the API key overview, you find all existing API keys. You can view:
The date and time when an API key was created.
The name of an API key.
A button to view the API key.
A button to regenerate the API key.
The status of the API key: Activated or Revoked.
2. Viewing and Copying an API Key
Click View Key to display the full API key.
To copy the key, click the clipboard icon (see example below).
3. Regenerating an API Key
If an API key has been accidentally shared or might be compromised, you can regenerate it:
Open the API key overview.
Next to the relevant API key, click Regenerate.
The old key is automatically invalidated and replaced with a new one.
4. Revoking or Releasing an API Key
If you no longer use an API key, or if it should be invalidated (for example, when an integration has ended), you can revoke it:
Open the API key overview.
On the right-hand side of the relevant API key, click Revoke.
The API key becomes invalid immediately. Any connected integrations lose access instantly.
Email Notifications for New API Keys
When someone in your organisation creates a new API key, all administrators automatically receive an email notification. This way, admins stay informed about new integrations and can take action if needed.
Example email:
Tips
Use separate keys per integration: This keeps things clear and makes it easier to revoke them if necessary.
Limit access: Revoke unused or unwanted API keys immediately.
Check regularly: Keep an eye on the overview and watch for unusual creation times.
Be cautious when sharing: Never share an API key via unsecured channels or with unknown people or email addresses.