EverPass Control API Credential Generation

The EverPass Control API allows third-party AV control systems to communicate directly with EverPass Devices. This article explains how to generate API credentials once access is approved.

Generating API Credentials

After signing in to the EverPass Manager:

1. Click the organization name in the upper-right corner. 
2. Click the Settings (gear) icon.
3. Navigate to the API Access tab.
4. Follow the instructions to generate a credential, which consists of a Client ID and Client Secret.

Important: Your Client Secret is displayed only once and cannot be retrieved later.

Never expose your credentials in client-side code, version control or logs. If you need to share credentials with a trusted partner, use a secure method such as an encrypted password manager or secure communication channel instead of email or chat.

Credential Inheritance Logic

EverPass organizations are arranged in a tree hierarchy. Each organization has its own numeric organization ID and may represent a parent account, a physical location, or a zone within a physical location. Devices are associated with organizations at the lowest level of the hierarchy.

Credentials are valid across the entire organization subtree. A credential issued at a parent organization can authenticate requests for any descendant organization. However, every control endpoint call must specify the organization ID that directly owns the target device. Using an ancestor organization ID with a device associated with a child organization will cause the request to fail, even though the credential itself is valid.

For example, a credential issued for CJ's (organization ID 10000) can authenticate a call targeting a device under CJ's Austin. However, the request must specify organization ID 10001 (CJ's Austin).

To view your organization hierarchy and associated devices, navigate to the Manage Your Devices section of the EverPass Manager.