The LivionKey20 is designed to program iLOQ keys on demand, allowing for the secure storage of keys without pre-assigned access rights. With Livion's iLOQ-specific APIs, you can seamlessly integrate your third-party systems to queue key handover reservations.
What Sets LivionKey API Apart from iLOQ API?
While the iLOQ API provides low-level building blocks, often requiring multiple API calls to complete a single task, LivionKey’s API is designed at a higher level. It focuses on reservation and contract management use cases, allowing you to accomplish complex tasks with a single API call and streamlining the process significantly.
Key Handover and return
You’ll need to create a Key Contract to manage key handovers and returns. There are three types of key contracts, each suited to different use cases:
Temporary Key Assignment (Default Contract):
Define a start and end date for key access.
The Key Automat reserves a locker for the key until the contract expires.
The end customer is expected to return the key to the same key automat
It is ideal for scenarios like granting temporary access to service personnel.
Ongoing Key Assignment (Fetch Contract):
No end date is set, providing continuous access.
Once collected, the locker is freed up for other uses.
Suitable for long-term access needs.
Key Return (Return Contract):
Any iLOQ S5 key belonging to the locking system, including those not assigned initially through LivionKey, can be returned to a Key Automat.
For both Default and Fetch contracts, the following details are required:
Key quantity: The number of keys required.
Contact information: The recipient's name, email, and/or phone number for notifications.
Start: Earliest time the user can retrieve the key
End: Latest time the user must return the key (applies only to default contracts).
Pick-up location: The desired Key Automat for key retrieval.
For a Return Contract, the following properties are required:
Key IDs: List of iLOQ key IDs.
Contact information: The recipient's name, email, and/or phone number for notifications.
Return location: The designated Key Automat for key return.
Start: Earliest time the user can return the key
End: The latest time to return the key.
Determining Pick-Up or Return Location
he API provides flexibility in choosing a key pick-up or return location:
Key Automat Group:
Users can select a group of Key Automats. LivionKey will automatically assign the most suitable one based on availability and proximity. You can configure Key Automat groups via the API or LivionKey UI.
Specific Key Automat:
Ideal for predetermined or user-selected locations. The API supplies a list of available Key Automats for selection.
Key ID Assignment:
Links specific keys to a particular Key Automat. Typically used in specialized scenarios and not recommended for routine API operations. Some key management systems may employ this method for specific handovers.
End-User Notifications
LivionKey can send SMS and email notifications regarding key pick-up, return, and reminders. You can activate these notifications by setting specific flags when calling the key contract API.
API Documentation
For more detailed information on using the LivionKey API, visit our online documentation at:
The LivionKey API empowers you to seamlessly integrate key management into your systems, automating processes and improving efficiency. You can create a secure and streamlined key management experience by leveraging its features.
Remember:
Our support team can help you with any questions or integration challenges.
Please take a look at our collection of articles for more detailed instructions and troubleshooting tips.
We hope this article has provided a helpful overview of third-party API integration with LivionKey20 for iLOQ S5. Happy integrating!