Frequently Asked Questions about the Unloc Platform
App - Unloc mobile app
Where can users download the Unloc app?
- Android: Google Play
- iOS: Apple Store
How can I redirect a User to the Unloc app from my own app?
You can use an App Switch URL to invoke the Unloc app with a specific Key ready to open a Lock.
Do I need to implement a communication strategy between my app and the Locks?
No, the Unloc app handles the communication with Locks. You just need to invoke the Unloc app at the right time using an App Switch URL.
How do I get an "access token"?
The OAuth2 Token endpoint of the Integrator API allows you to generate a token with either:
integrator.adminscope: mainly used to list your Lock Holders.
lockHolder.adminscope : used to manage Locks, Keys, Roles, Users and Webhooks.
Each request to get an
access_token includes a
expires_in property that specifies how long will this token live for. You should aim to reuse it for its duration and implement a token refresh strategy.
What is a "Lock Holder"?
A Lock Holder represents the entity that owns or contains Locks, such as a building, housing cooperative, or storage facility.
How do I delete a Lock Holder?
Currently the Integrator API does not include an endpoint for destructive operations such as deleting a Lock Holder. However, we can perform this operation for you if required.
I can't see the new Locks I onboarded
After you onboard new Locks into a Vendor platform, you need to Refresh the Vendor Connection to that Vendor; this process will query for changes on the Locks exposed by the Vendor system, showing you the new Locks on the Integrator API.
Depending on your use case, it can be a good idea to Refresh your Vendor Connections at a regular basis: for instance having a cron job that runs every day at 2:00 AM.
How do I delete a Lock?
Since the Locks are fed to Unloc via a Vendor Connection, the Lock deletion process has to be done on the Vendor platform side. After the Lock is removed on the Vendor platform, you can perform a Vendor Connection refresh to sync your Vendor Connection with the latest changes.
How do I create a Key?
Use the Create a Key for a Lock endpoint. It will expect at minimum the ID of the Lock you want to create a Key for along with the ID of the Lock Holder that it's associated with, and the mobile phone number of the User who will receive the Key.
How do I create a Key that works during a certain period only?
The Create a Key for a Lock endpoint receives optional
end parameters you can set to make the Key work during a set period of time only and schedule its creation for a later date.
How do I create a Key that works during a certain recurrent period?
You can create Keys that work during specific parts of the day over one or many days of the week. Set a recurrence object on the Create a Key for a Lock endpoint request body as explained in our Recurring Keys guide.
A user is no longer allowed to enter a building or facility, how do I remove access for them?
When a tenant moves or an employee permissions change, you should follow these steps to make sure they wont have access to the doors they had Keys for:
- Use the Revoke all Keys for a User endpoint to remove all the Keys the User had.
- Revoke all the Keys the User has shared via the Delete all shared Keys for a User endpoint.
- Make sure their
canSharerole is set to
falseusing the Create or Update Role endpoint.
Updated about 1 year ago