You can use an App Switch URL to invoke the Unloc app with a specific Key ready to open a Lock.
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.
The OAuth2 Token endpoint of the Integrator API allows you to generate a token with either:
organization.adminscope: mainly used to list your Projects.
project.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.
A Project represents the entity that owns or contains Locks, such as a building, housing cooperative, or storage facility.
Currently the Unloc API does not include an endpoint for destructive operations such as deleting a Project However, we can perform this operation for you if required.
After you onboard new Locks into a Vendor platform, you need to Refresh the Lock 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 Unloc API.
Depending on your use case, it can be a good idea to Refresh your Lock Connections at a regular basis: for instance having a cron job that runs every day at 2:00 AM.
Since the Locks are fed to Unloc via a LockConnection, 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 Lock Connection refresh to sync your Lock Connection with the latest changes. When a Lock is deleted, all keys to the Lock will be revoked.
Use the Create Keys endpoint. It will expect at minimum the ID of the Lock you want to create a Key for along with the ID of the Project that it's associated with, and the mobile phone number of the App User who will receive the Key.
The Create Keys 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.
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 Keys endpoint request body as explained in our Recurrence guide.
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 Delete Managed User endpoint to delete everything about a user, including Keys, Sharing Rights, Shared Keys. This will also remove them from Doorbells and Access Groups.
If you want to be more specific, you can do it step by step:
Updated 6 months ago