Before your application can communicate with HelloID via the API, you must create an API key. Full documentation on the HelloID API is available here.
Navigate to Security > API to add an API key for use within your organization's HelloID environment.
Note: We recommend creating an API key for each individual application that will be accessing HelloID. That way, if you have to disable an API key, you don't affect more than one application.
Add an API Key
- On the API Key overview, click on the Add API Key button.
- The next page has the following fields. Take note of the Key and Secret field values for use in your application, as both of them will be needed to access the API.
- Key: This is your API key. It is automatically generated and cannot be changed.
- Secret: This is the secret, or password, for the API key. It is automatically generated and cannot be changed. Click the Show secret toggle to view the secret.
- Enabled: You may create the new API key in a disabled state, if you wish to enable it later on. Disabled API keys are not able to access data within HelloID.
- Allowed IP addresses: You may limit access to the HelloID API with your key to one or more IP addresses. This is recommended for security purposes.
- Note: In the Note field, you may provide a short note on the purpose of an API key, and which applications and developers will be using it. This will be displayed in the API key overview, and is searchable.
- Click the Save button when you are finished. The new API key will be added to HelloID and is ready for use in your application.