Add an API Key
API Keys are created and added to Vbrick Rev for linking devices for use with Rev. You must create an API key for each type of device you plan to use with Rev, including LDAP Connectors. Once the API key is created, enter the key in the Rev API field of its corresponding device before you add the device in the Device module in Rev.
Additional Information: See the Device Initial Configuration and Set Up topic for more information on how to set up devices. |
To add an API key:1. Navigate to Admin > System Settings > API Keys > Add Key button.
2. Enter a descriptive API Key Name.
3. Enter the API Key. You may use any combination of letters and numbers of your choice.
Caution: It is highly recommended that symbols and special characters are not used in the API key field. |
Note: While an API Key is required for every device created in Rev, you do not have to create separate API Keys for each device. This is a distinction that is often overlooked. For example, you may create one API Key that is used for each location you have, such as headquarters (or the United States), and then use that same API Key for each device in that location if that is your preference. Then you may create a different API Key for a location in the UK or training rooms and use that key for the devices in only those locations. |
4. Enter any redirect URIs needed if you plan to use any integrations and the OAuth API. This field is checked that the redirect URIs specified in the authorization and token request match and provides an additional security check to ensure that the correct user is making the request. Multiple URIs may be provided but at least one must match the authorization request to be redirected.
5. Click Create.
6. Use this same key in the device you plan to add and link to Rev for use. See the corresponding device’s Admin technical manual for more information on where to enter this key.
Return to the main API module to display the API’s Secret that is generated (for use with Rev’s REST authorization API) if needed.