To begin using the Mobile SDK, you will need the following:
- Download the SDK from the private GitHub
- Please contact Allegion support to request access.
- Detailed technical documentation, method definitions and sample code are included in the SDK itself.
- Your Subscription Key
-
- Your Integration ID
- Your Integration ID is necessary to identify your mobile application and support the SDK integration.
- Please contact Allegion support with help getting your Integration ID.
- At a high-level, the SDK performs the functions seen in the following image:
- The first step in creating your mobile app is deciding how to authorize the phone user with your access control system.
- This allows you to provide the phone user a token that associates the user with the mobile credential created via the Credentialing API
- Once the phone user is authenticated and the token has been obtained, the concepts above are very simple:
- Enroll Device: Tethers phone to user within your access control system
- Pull access rights/payloads: Obtains the user's credentials in order to interact with the ENGAGE devices
- Recommend refreshing rights/payloads frequently to ensure user only sees active credentials
- Scan for edge devices: Looks for ENGAGE devices that are nearby and support mobile credentials
- Present credential: This is how the user unlocks the ENGAGE device.
- A pre-connection feature allows the app developer to have full, granular control over intent
- Detailed method documentation, sample code, are available on the private GitHub
