Overview
To evaluate and implement an integration with a lock system, Inlet needs a clear technical description of the functions your platform supports and how those functions are accessed.
This article describes the minimum information and functionality we need from a lock vendor or integration partner.
Demo hardware for our test environment
We also prefer to have our own test equipment available in our demo environment. This helps us debug faster, validate functionality internally, and reduce turnaround time during implementation and support and bugs in the future. It has also proven very useful for demonstration and showroom purposes, so customers can see and physically evaluate the hardware before purchasing. As of today we have over 50 different vendors showcasing their locks in our showroom.
What We Need From You
For each supported function, please provide:
- Api documentation
- endpoint URL, API path, SDK method, or command to use
- authentication method and credentials
- example requests
- example responses
- example error responses
- notes about timing, delays, or other limitations
Required Functions
Fetch Access Groups / Areas
We need to list access groups, areas, or the equivalent access structures in your system.
Minimum required output:
- unique ID
- name
Fetch Locks / Doors
We need to list all relevant locks / doors in your system.
Minimum required output:
- unique lock / door ID
- lock / door name
Preferred additional output:
- related access group / area
- location metadata
Retrieve Lock Status
We need to retrieve lock status.
Minimum required:
- online / offline or reachable / unreachable
Strongly preferred:
- battery level
- battery-low warning
- door state
- lock state
- last-seen timestamp
Create PIN Access
We need to create time-limited PIN access.
Preferred model:
- create or update a user
- assign access
- assign PIN code
- define validity start and end
If user-based PIN management is not supported, we need a fallback for setting a PIN directly on a specific lock or door.
Remove PIN Access
We need to revoke PIN access.
Create Mobile Access
We need to create mobile access in the lock vendor's own mobile app.
Minimum required:
- create / invite / activate mobile credential
- connect mobile credential to a user
- define validity period
- define access scope
Remove Mobile Access
We need to revoke mobile access.
Remote Unlock For A Short Period
We need to remotely unlock or open a door temporarily.
Optional: Hold Open / Return To Normal
If your system supports it, we also want:
- force open / hold open
- return to normal state
In short, for each function we need the endpoint or command to use, authentication requirements, and working request/response examples.
Minimum Functional Acceptance Criteria
To be relevant for integration with Inlet, the lock system should support:
- fetch access groups / areas
- fetch locks / doors filtered on an access group (list only lock in this group, not all locks in the system)
- retrieve lock status
- retrieve battery status
- create PIN-based access
- remove PIN-based access
- create mobile access
- remove mobile access
- remotely unlock a door temporarily
- remotely set a door unlocked for a period
- remotely set a door back to normal/locked state
- algo pin functionality description if present in the system
Preferred Vendor Response Format
Please answer using one section per function or a table with:
- Function name
- Supported: yes / no
- Endpoint / command
- Authentication
- Request example
- Response example
- Notes / limitations