The API Key and Enterprise ID are used in many of 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.
An API Key is tied to the user account used to create the key. If you delete a user via User management, then any keys associated with that user will also be deleted. The API Key will be rendered invalid for API, SDK, and CLI use. To avoid such unintended deletions, a best practice is to create a specific user account just for API Key management.
In this article:
- Creating an API Key
- Managing an API Key
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 name and description (optional) and click Create Key.
Click Generate Token. This will generate a unique OAuth-based API Key.
You can then copy the key (or renew if needed).
Managing API Keys
You can manage API Keys from the API Key Management section. To do so, click on the ellipsis.
To copy or renew the API Key, select Renew token.
You'll be able to copy, renew, or delete the key from this menu. API Keys are not renewed automatically.
To delete an API Key, select Delete Application. The key will be removed from the system, and any applications currently using that key will show error messages.