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, license plate recognition, access and intrusion events, to OWS
  • Access API: To access user data and point-of-sale date from OWS
API Integration
Add Integration
  1. In OWS, click on Management > Integrations.

Integrations Dropdown.png

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

Add New Integration button.png

  1. Select an API Integration from the list and click Next.

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

Authentication
Creating an API Key
  1. Select the Management > Integrations tab.
  2. Create a new integration or click Edit Edit button.png on an existing integration.
  3. Choose an API Integration.
  4. Select API Access Keys.

API Access Keys.png

  1. Select Add Key.

Add Key button.png

  1. Click Add Key and you will be presented with the Secret Key. Enter a Key Name and click Add.

NOTE: This is the only time you will be able to view the Secret Key. Be sure to copy it somewhere. If the secret key is lost, a new API access token must be created.

Create New Access Token.png

  • Was this article helpful?