The primary purpose of this section is to provide a high-level information overview about the various modes of the ENGAGE Platform, device operation, expected protocols, format, and application programming interfaces available. It also illustrates how to integrate and interact with an ENGAGE enabled device.
This section is designed for an engineering audience with an in-depth understanding of HTTP (the overall protocol as well as the methods GET, PUT, POST, DELETE specifically) IP Security Protocols, encryption standards, REST web services, and JSON.
NOTE: As the Schlage NDE Cylindrical Lock was the first such marketed ENGAGE enabled device, the terms lock (device) and NDE are used throughout the Web Portal sections, the protocol, and in some cases even part of the defined interfaces themselves. For backward compatibility, these interfaces have kept with legacy terms despite ENGAGE technology application beyond the initial NDE lock (device). It can be assumed that when the general terms lock (now device) and/or NDE are shown in an example, any ENGAGE enabled device can be substituted. The philosophy of holding interfaces consistent throughout ENGAGE evolution is a core design tenant ensuring compatibility throughout firmware revisions, devices, and host implementations.
NOTE: The term 'lock' may still appear within code strings or JSON structures but most textual references have changed to 'device' going forward.
Operators of the ENGAGE Platform (hereafter referred to as ENGAGE) must first create an account with Allegion; a valid email address is required for successful creation.
Software Alliance Members (SAM) should create an account by going to the Create an ENGAGE Account page.
ENGAGE devices are managed in logical groupings called sites. Once an ENGAGE account has been created, users establish sites to setup and administer their ENGAGE devices.
There are two kinds of sites:
ENGAGE devices assigned to ENGAGE managed sites are controlled exclusively through Allegion software using the ENGAGE Web Portal. Third party software managed sites allow a Software Alliance Member to directly administer ENGAGE devices through their own software solutions.
NOTE: A default ENGAGE managed site is established upon account creation but that third party sites must be created programmatically through Site Administration APIs.
A newly installed ENGAGE device is registered to a specific site through a process known as commissioning. This required process is performed using Allegion’s ENGAGE iOS or Android mobile device application (MAPP). Each site makes use of its own encryption key (called the site key) to provide enhanced security; principally, a device uses this key to decrypt sensitive credential access information. Third party sites establish this site key during site creation via an API.
Only once registered to a site can the device be configured and managed by operators associated with that site. Operators and their permissions are assigned to sites through email invites. Invitations can be sent through either the ENGAGE MAPP or the API.
Last Modified: November 6, 2019
Privacy Policy | About Allegion
© 2019 Allegion plc. | Block D, Ivoagh Court, Harcourt Road, Dublin 2, Co. Dublin, Ireland
REGISTERED IN IRELAND WITH LIMITED LIABILITY REGISTERED NUMBER 527370
Allegion is an equal opportunity and affirmative action employer.