Allegion Developer Portal
Allegion Developer Portal
All requests to the Site Administration APIs must be made from a partner managed account type. ENGAGE managed login types cannot access these APIs.
The Site Administration APIs include the following:
| Term | Definitions |
|---|---|
| ENGAGE Managed | - If the site access management uses ENGAGE. It is common for an externally managed site, that this is false. |
| Role | - Operator - Manage - SiteAdmin |
| Site Name | - The 32-byte Site Key encryption key. The value is a hexadecimal value that is encoded in Base64 format. NOTE: The value should be Base64 encoded starting as a hexadecimal string of characters, not an ASCII representation of a hexadecimal string. |
| Default Host Address | - A URL to change the site's default hostname location. Value must be a valid URL including http or https. - Only valid when IsEngageManaged == FALSE. - This is an optional feature of site creation that is intended to reduce occurrences of manual errors created during commissioning of devices. - It makes client connection (e.g. WiFi) requests to a partner managed server for database updates and audit posting. |
| Site Software Key | - This string should be identical to the "Value" string provided by GET /engage/lookupsitesoftware. |
| Site Reference | - The reference ID of site the invite is assigned to. |
| Operator ID | - OperatorId is a unique 64 bit integer value on a per site basis. The same user has a different OperatorId for each site they are an "Operator", "Manager", or "SiteAdmin". |