Allegion Developer Portal
Allegion Developer Portal
The ENGAGE Gateway implements a general 30 second timeout for all commands below; it is suggested that Alliance Partners use a similar value when implementing a timeout on Gateway responses. In particular, the /edgeDevices/{linkId}/database resource can take many seconds to complete for large databases which must be first transferred and then queued by the Gateway before a response is returned to the initiating client.
Due to the Gateway’s webserver implementation, extraneous forward slashes (/) used in endpoint URLs shown below are ignored; while this would be a non-standard use case in a machine-to-machine developed solution, it is noted herein for clarity’s sake.
The reader-controller shares many of the same resources as the Gateway. The key difference being that the reader-controller is not linked to any other edge devices. As a result, the reader-controller will utilize the /edgeDevices/{linkId}/ resources, but the linkId will always be dev00000.
Persistent Connection API URIs | Device Applicability |
Gateway Configuration & Setup | |
GET /gateway/newCredentials | GWE |
PUT /gateway/newCredentials | GWE |
GET /gateway/time | GWE |
PUT /gateway/config | GWE |
GET /gateway/deviceInfo | GWE |
GET /gateway/scanList | GWE |
Linking and Controlling Edge Devices | |
POST /edgeDevices | GWE |
GET /edgeDevices/linkList | GWE |
DELETE /edgeDevices/{linkId} | GWE |
PUT /edgeDevices/lockControl | GWE |
PUT /edgeDevices/{linkId}/lockControl | GWE, RC |
GET /edgeDevices/lockStatus | GWE |
GET /edgeDevices/{linkId}/lockStatus | GWE, RC |
PUT /edgeDevices/{linkId}/database | GWE, RC |
DELETE /edgeDevices/{linkId}/database | GWE, RC |
GET /edgeDevices/{linkId}/dbDownloadStatus | GWE, RC |
PUT /edgeDevices/{linkId}/config | GWE, RC |
DELETE /edgeDevices/{linkId}/config | GWE, RC |
GET /edgeDevices/audits | GWE |
GET /edgeDevices/{linkId}/audits | GWE, RC |
DELETE /edgeDevices/audits | GWE |
DELETE /edgeDevices/{linkId}/audits | GWE, RC |
GET /edgeDevices/{linkId}/time | GWE, RC |
POST /edgeDevices/{linkId}/lastCredential | GWE, RC |
GET /edgeDevices/{linkId}/newCredentials | GWE, RC |
PUT /edgeDevices/{linkId}/newCredentials | GWE, RC |
Gateway Diagnostics | |
GET /gateway/gatewayNetworkStatistics | GWE |
GET /gateway/gatewayEventLog | GWE |
Last Modified: October 14, 2019