📄️ Introduction
This service enables the integration of OKMs and key checkout into the software of a customer (referred-to as “the implementer” on this page).
🗃️ OKM APIs
5 items
📄️ JWT Authentication
The four resources of the OKM Service — OKM, ACL, ACL-OKM, and Firmware — require a valid JWT access token.
📄️ OKM API Tokens
API tokens are used in the exchanges between the OKM Service and OKMs, to control which OKMs are authorized to query the service. The purpose of the token is to indicate that an OKM is authorized to make requests to an OKM Service instance.
📄️ Access Control List
The Access Control List (ACL) API manages access control lists. It is composed of a userId, and a list of locks the user can open, together with a few other information.
📄️ Firmware API
This resource manages the location of the firmware files for both OKMs and IR4 keys.
📄️ ACL-OKM API
The ACL-OKM API manages the relationships between ACLs and OKMs. The function of the resource is simple: it attaches an ACL to a specific OKM.
📄️ Asset Lists and Digests
This page describes asset lists, user assets lists, and digests that an OKM and an OKM Service instance use to keep the information of a store synchronized.