To interact with the API, you will need an API key. API keys inherit the rights of the user who created them, so if you want to use the API to manage group members, the user who owns the API key must belong to a role that has that permission.

To create a new API key or list existing keys, login to the Locktera application and navigate to:

1. Configuration

2. API Keys

Here you can see your individual user ID (needed for personal API calls) and existing API keys, as well as create a new API key. Take note of your user ID and API key you wish to use, as you will need them to authenticate any API calls.

Best PracticesCopied!

Consider your API key a secret. Anyone who has access to your API key will be able to act with your rights on your organization’s data, so take appropriate caution. For example, never hard-code your API key into program source; instead, use environment variables or a secret store to retrieve your API key at runtime. This will ensure that your API key never gets accidentally deployed or committed to repository history.