Quickstart - Introduction

Integrator API Quickstart

This quickstart will guide you through the basics of Unloc's Integrator API: How to authenticate and get an Access Token, how to list and create Lock Holders, get a specific Lock, get and create Keys and Roles for it.

The guide assumes you have a basic understanding of HTTP, REST and OAuth2, and that you already have an Integrator account and access to Unloc's Sandbox Environment.

Key Concepts

Before diving in, let's go over some important concepts to keep in mind in order to better understand this quickstart guide.

Entity relationship

The below diagram shows the relation between our different models:

Integrator

That's you! An integrator represents the entity or systems that manage Keys, Roles, and Locks, such as a property management system.

Lock Holder

A Lock Holder represents the entity that owns or contains Locks, such as a building, housing cooperative, or storage facility.

Keep in mind that a Lock Holder can be managed by any number of Integrators, so you can create multiple systems that will be able to access them.

A Lock Holder represents a physical location that has one or more Locks.
<a href="https://www.freepik.com/vectors/city" rel="noopener noreferrer" target="_blank">City vector created by macrovector - www.freepik.com</a>A Lock Holder represents a physical location that has one or more Locks.
<a href="https://www.freepik.com/vectors/city" rel="noopener noreferrer" target="_blank">City vector created by macrovector - www.freepik.com</a>

A Lock Holder represents a physical location that has one or more Locks.
City vector created by macrovector - www.freepik.com

In the picture above you can see three different Lock Holders:

  • Lock Holder 1 & Lock Holder 2: Contain a Lock on a common door for the apartment building.
  • Lock Holder 3: Is associated with a common door Lock and several storage and meeting rooms across the building.

Vendor Connection

A vendor connection is the connection between a Lock Holder and a vendor account (such as Danalock, Master Lock or Futurehome, for instance). A Lock Holder will get access to the all Locks available through any of the Vendor Connections it may have.

A Lock holder may have any number of Vendor Connections. On the other hand, a vendor account may only be linked to a single Lock Holder.

Lock

The Lock model is the representation of a physical Lock, Keys and Roles will be directly linked to a specific Lock.

Each Lock belongs to a Lock Holder, and may only be added via a Vendor Connection.

Key

A Key represents a user's ability to lock and unlock a Lock.

Keys may be permanent (until explicitly revoked) or be active during a certain period only, which means they may be restricted to only work during specific time frames during a day.

A Key is sent to and associated with a Mobile Phone number and does not require the user to exist at the time of creation. This makes it easier to distribute Keys as users do not need to have the Unloc app installed on their mobile devices beforehand.

Role

A role represents a user's ability to give Keys to others for a given Lock via the Unloc App.
This role does not give the ability to open a Lock, although a user may give a Key to themselves to achieve this.

A role is given to a Mobile Phone Number, and does not require the user to have created an account via the Unloc App at the time of creation.

Data removal

We're obliged to follow through the removal clients Personal Identifiable Information on their request. You should regularly make sure your integration data is in sync with Unloc's platform data.


What’s Next

The next step will be to Authenticate against the Integrator API

Did this page help you?