The API Key and Enterprise ID are used in our developer features, such as the Esper CLI, Device SDK, EAST, and more. Generate an API Key and unlock the power of Esper and your devices.
API keys are:
- Tied to the user who created it.
- Not shared with other users.
If you delete a user in User Management, then any keys associated with that user will also be deleted. That means the API key will stop working for any scripts it's part of. To avoid losing keys, you can create an account dedicated to API key creation.
Enterprise IDs are specific to a tenant and do not change.
In this article:
Creating an API Key
The first step in interacting with our API is to generate an API Key. To do this, navigate to the API Key Management section.
Then select Create Key.
You can copy the Enterprise ID, necessary for API calls, by clicking on the copy icon next to Enterprise ID on the top right of this section.
Enter a unique API key name and an optional description.
Click Create Key.
Then copy the key and close the window.
Managing an API Key
You can view, replace, or delete the API Key. To do so, click on the ellipsis (...) under the Actions column.
Viewing a key
When you view the key, you’ll be able to copy and view it.
To view the key, locate the key in API Key Management and click on its ellipsis (...).
Then select View.
Click on the eye icon to view the key or Copy to copy the key.
Replacing a key
When you replace the key, you generate a new key. All scripts tied to that key need be updated, and the previous key will stop working.
To replace a key, find the key in API Key Management and click on its ellipsis (...).
Then select Replace.
A replacement key will be generated. Copy the key and replace it in its scripts.
Deleting a key
To delete an API Key, find the key and click on its ellipsis (...).
Then select Delete.
You'll be asked to confirm the deletion.
Once deleted, key will be removed from the system, and any applications currently using that key will stop working.