To connect LivionKey to the iLOQ locking system, you will need the following four pieces of data:
Service code
Service address
API user name
API user password
The following sections will help you find and create the necessary information.
Once you have gathered this data, please review this article for instructions on completing the LivionKey initial configuration.
1. Enabling API access to existing locking system
If a locking system is implemented without API access for system locks and access rights, a one-time manual operation must be performed.
Enabling API access to the locking system
Goto Administration tab
Select “Edit locking system information.”
Select “Settings” from the bottom right corner
Enable “Public API in use.”
Enabling API access to locks
To enable API access for all locks that need to be accessed via keys programmed in the by LivionKey20:
Select the lock and find "Edit Access Rights" in the right-click menu.
Select "Edit Lock Settings and Access Rights."
Enable "Allow API Access Rights."
Enabling API Access for access rights
Existing access rights cannot be modified. To enable API access, duplicate the necessary access rights in iLOQ Manager and set API access to "on" for the newly created access rights.
Assigning newly created access rights to locks
Please don't remove the old access rights. Instead, add the duplicated access rights to the locks.
Ordering and programming Locks
Now, the locks can be programmed.
2. Finding the service code and service address
Configuring API communication to LivionKey requires the locking system service code and service address, which are your ILOQ manager environment identifiers. If you have already logged in to the iLOQ manager, log out to find the needed information.
Open the iLOQ S5 manager login screen and press the settings icon.
You will find the service code and service address.
3. Creating an iLOQ API user
An API user is needed to communicate with LivionKey and the ILOQ system.
3.1 Create a new user
Go to the Administration tab and select “Add user”
3.2 Select “Add userID”
3.3 Select “Add new person with user ID”
3.4 Provide a first name and last name
The name does not matter, but you should give one that is easy to recognize, such as First name: KeyAutomat and Last name: API
3.5 Provide a User ID and a Password
Try to give a User ID that is easy to recognize, such as “api.keyautomat”.
Please create a strong enough password and don't set a password expiration; otherwise, the integration will stop working.
3.6 Select usage rights
Below are the needed usage rights. LivionKey will check that the API user has needed usage rights when connecting LivionKey to the iLOQ manager
iLOQ manager | Needed for |
Right to browse keys | View keys |
Right to browse locks | View locks |
Right to login in to system | View RealEstates |
Right to administrate locking system | View, Edit, Delete Webhook related data or Network modules |
Right to order keys | Ordering keys |
Right to edit keys | Edit keys |
Right to browse access rights | Access rights that can be given to a key |
Right to edit access rights of the keys | To modify key access |
Right to manage code-access groups | To sync pin codes to online readers |
Right to edit door calendar controls | To sync pin codes to online readers |
Right to browse person roles | To sync pin codes to online readers |
Right to edit person groups | To sync pin codes to online readers |