Getting Started Guide
Introduction
Master Lock Connected Locks
Master Lock Connected Locks are electronic locks that connect to a phone via Bluetooth. They allow a user to unlock their lock with a phone, change settings such as manual codes, and view an audit report of the events that took place.
Please note that these locks do not have Wifi and therefore will not have real-time connectivitiy.
The SDK is comprised of two components:
This is a web API used for activating and retrieving information about your lock such as temporary codes and access profiles. Data used here will be used within the mobile frameworks.
iOS and Android Mobile Frameworks
These are the frameworks to be included within your mobile applications. They handle the bluetooth communication between the phone and locks.
Licenses and Framework Access
In order to start using the Master Lock Connected Products Web API and use the Mobile SDK frameworks, several licenses are needed once an NDA has been signed:
- Access to the Master Lock Connected Products Web API is granted via a license.
- Likewise, the iOS and Android SDKs require a license.
- The iOS and Android SDK frameworks are hosted in private GitHub repositories. Access to these repositories will be granted upon request.
Please contact Master Lock to receive a license and get access to the api, mobile frameworks, and documentation. Once a license has been created for you, it will be shared via Box. Please refer to the shared Box folder for all of this information.
Licenses are initially valid for 3 months, and they are extended once a full license agreement has been completed. If more time is needed for a license trial, please contact a Master Lock representative.
Integrated Parner vs Standalone Platform
A platform is a system that owns locks. The Master Lock system hosts multiple platforms for Connected Locks. Every SDK License works on a specific platform. Licenses provided to Standalone Platforms will only work for that platform and the associated locks. No one else will have access to their locks. Licenses provided to Integrated Partners will only work on locks within the Vault Enterprise Platform.
Locks activated within Master Lock Vault Enterprise or Master Lock Vault Home will be assigned to the Master Lock platform. Therefore, Standalone Platform licenses will not allow access to those locks.
Device Activation
Locks activated within Master Lock Vault Enterprise or Master Lock Vault Home will be assigned to the Master Lock platform. Therefore, Standalone Platform licenses will not allow access to those locks. The lock cannot be activated in Vault Enterprise or Vault Home. If your lock is in either of these platforms, delete the lock from that system and then contact your Master Lock representative.
Get Started
Before you can call any endpoint in the Connected Products Web API for a lock, you need to activate your lock.
If the Connected Products Web API returns a 404, please ensure that the lock is not activated on another Platform. If this is the case, delete the lock from that system and then contact your Master Lock representative.
With the device activated, you can generate temporary codes and access profiles to use the lock within your application.
Run the Sample App
- Ensure your lock is activated on your platform.
- Look up your device and note the firmware version.
- Get an access profile. See the access profile documentation for additional information.
When you have an access profile and firmware version, you can use the SDK.
Clone the iOS and Android sample projects. Follow the instructions in the README to launch the app and set up the configuration strings.
The iOS documentation includes a step by step tutorial for configuring a project and unlocking a lock.