Quickstart - Introduction

Unloc’s Service Provider API is your best ally when you want to easily provide services to your users right to their doors by allowing you to generate digital Keys for Locks you have been granted access to by their owners.

Permanent Access

You have the ability to establish a permanent connection to a Lock, allowing you to generate keys on demand. This is specially useful when you provide services with a regular frequency to the same User.

Think of a newspaper delivery service: newspapers need to be delivered every day, so it makes sense for the delivery company to have access to their customer’s doors all week long, but only during the times the delivery is happening according to their schedule.

As you might imagine, this requires the Lock owner to trust you, the Service Provider, to have Key generation access to their Locks. That’s why we manually broker the initial association between you and a Lock owner. Feel free to contact us through the channels we’ve set up for you to assist you with this process.

Key Request

When the service you provide is not recurring and you only need to open a Lock once to fulfill it, the Key Request feature is your best option. With it you’re able to request permission from a Lock Owner to generate keys for their Locks during a specific time frame. The Lock Owner will receive a Push Notification through the Unloc app that will guide them through the process of approving your request and selecting which Locks to share Key generation access to.

This is a great feature for an online shopping delivery service, where the shop can ask for a user’s mobile phone number and use it to verify whether they use Unloc or not, if they do, then a Key Request process can be initiated and after getting the user’s approval, you can generate a single usage Key for a specific delivery time. The user is notified that their package has arrived after the delivery is completed.

Key Usage

Keys created by service providers can be made for:

  • A specific person – identified by the person's mobile phone number.
  • A specific mobile device – identified by the mobile device's secret device id.
  • Anyone who has access to the key's HMAC-signed URL.

A Key made for a specific person will instantly be available to them through the Unloc app.


What’s Next
Did this page help you?