Creating & Managing API Keys

An API Key is a special token that can be used by a platform / software to connect to another system securely on behalf of a user.

Realhub can create API keys at user levels for integrations with other Domain solutions such as Engage and Real Time Agent, as well as third party platforms like Box+Dice, for example.

If the platform you’re working with requires an API Key for a user, you can manage these within the API Keys module of Agency Admin > Integrations.

Create a new API Key for a User

1. Click the Add API Key button in the bottom of the API Keys module.
2. Search for the user and select in the User box
3. Give the API Key a title. We recommend the name of the third party platform so it can easily be referenced, updated or deleted in the future.
4. Click Create API Key
5. You can now locate the new key in the list of keys, and copy/paste to update in your third party provider/platform.

Manage an Existing API Key

If there are already some API Keys created for users in your office, they will be listed in the API Keys module.

1. Click the pencil icon to edit an existing API key.
2. In the side modal you can add or edit the name of the key (used to reference the external platform the key is used for), turn the API Access of without deleting the key, or delete the API Key entirely.

Creating an API Key for All Users

There may be times where you need to create an API key for all users in your office. For example, if you want to setup a brand new integration with a platform that all users will need to access.

1. From the cog icon at the bottom of the API Keys module, click Bulk Create API Keys.
2. Enter a title/system that will apply across all the API keys and click Create API Keys.
3. An API Key wil be created for all users in your office.
4. From here, you can go to the Cog icon again and Download List.
5. This will generate a spreadsheet of all your API Keys which can be provided to your new integration / added to your external platform.

If providing external platforms with the downloaded list, be sure to check the file and only provide those keys that are relevant (you may have keys on the list for multiple platforms).

Deleting an API Key to prevent access

You can delete an API Key using either the trash icon next to an existing key, or by clicking the edit pencil and then Delete API Key button.

Deleted API Keys cannot be restored. If the user needs access again at a later stage, you will need to create a new API key to link to the platform. Alternatively, you can disable API Access for the key rather than deleting entirely.