Skip to main content
OpenEye Knowledge Base

OWS Access Keys

The OWS Access Key is used to make the connection between a specific OWS account and a 3rd party integration. Because the Access Key is the method used to create an association between an OWS account and a third-party integration, OWS will not respond to commands from the third-party integration without it. Once created, the Access Key is entered into a 3rd party application or service as part of the setup and configuration process to enable the integration to communicate with the OWS account.

The information on Access Keys provided below can be used to support the following integrations:

  • Event Receiver API: To deliver event data, including analytics, access and intrusion events, to OWS
  • Access API: To access user data and point-of-sale date from OWS
API Integration
Add API Access
  1. In OWS, click on Management > Integrations.

Management Integrations Dropdown.png

  1. Select Integrations.
  2. Click the Add New Integration button.

Add New Integration Button.png

  1. Select an API Integration and click Next.

NOTE: Integration Management is not available for all End User account types.

Authentication
Creating an API Key
  1. Select the Management tab.
  2. Choose Integrations from the drop-down menu.
  3. Choose an API Integration.

Manage Integrations Event API.png

  1. Select Add Key in API Access Keys.

API Access Keys tab.png

Add Key button.png

  1. Copy the API Secret Key from the dialog box.

API Create New Access Token.png

NOTE: If the secret key is lost, a new API access token must be created.

  1. Click Add to close the dialog box.
  • Was this article helpful?