uberGARD iKLAS
Integration Guide
This integration connects Sine with uberGARD's iKLAS access control system, allowing visitor and access data to flow between the two platforms. Configuring this integration enables system integrators to streamline access management for visitors and staff while maintaining accurate records across both systems. This guide is intended for system integrators and IT administrators responsible for configuring and maintaining the connection between Sine and iKLAS.
Overview
This integration connects Sine with uberGARD iKLAS, allowing visitors and contractors to select the keys they need during check-in and collect them themselves from the key cabinet. Keys sync from iKLAS into Sine daily, and once a host approves a visit, Sine creates a cabinet user, activates their key access, and sends the visitor a user ID and PIN. On check-out, Sine reminds the visitor to return their keys, verifies the return against the cabinet, and removes their access, and key cabinet problems never block a check-in.
How It Works
Sine integrates with the uberGARD iKLAS key management system to synchronize key availability and manage key cabinet access as part of the visitor check-in and check-out process.
Key Cabinet Check-in
Visitors select the keys they need as part of check-in and are issued a user ID and PIN to release those keys from the iKLAS cabinet once their pass is approved.
Check-in Flow:
Ahead of any visit, Sine syncs the keys from the configured iKLAS key groups into a read-only asset type, ensuring the check-in form reflects the keys currently available for visitors to select.
A visitor or contractor arrives and checks in via SinePoint kiosk, the SinePro mobile app, or an invitation link.
The check-in form presents the synced keys, and the visitor selects the keys they need for their visit.
When the pass is created, Sine creates a user for the visitor in iKLAS and generates a unique PIN for them. The keys are reserved against the visitor, but access is not yet open.
The visitor's host approves the pass.
On approval, Sine enables the visitor's key access in iKLAS and emails them their user ID and PIN.
The visitor enters their user ID and PIN at the cabinet, and iKLAS releases the keys they selected.
If the cabinet is unreachable at any point, the visitor still checks in. The failure is recorded against their pass and sent to the integration's notification contacts.
Check-out Flow:
The visitor checks out via Sine and is reminded to return their keys to the cabinet.
The visitor keeps their cabinet access for a short grace period so they can return the keys.
The visitor returns the keys to the iKLAS cabinet, which records the return against their user.
After the grace period, Sine reads the cabinet's transaction history to confirm which keys came back, and reports any that did not.
Sine then revokes the visitor's key access and removes their user record from iKLAS.
Requirements
Sine Requirements
- Integration enablement: A Sine subscription that supports the iKLAS integration, with the integration enabled on your account. Additional fees may apply.
- Dynamic asset type: A dynamic asset type created on the Asset types page to hold the synced keys. This asset type must not already be linked to another integration. Its assets are managed entirely by the integration and are read-only in Sine.
- Key selection question: A key selection question added to the visitor type form of every visitor type that should offer keys, bound to the dynamic asset type created above. A visitor only triggers the integration if they select keys on this question.
- Host approval: Host approval enabled on those visitor types. Key access activates only when the pass is approved. Without host approval enabled, keys release as soon as the visitor checks in.
- Visitor contact details: An email address captured at check-in so the visitor can receive their user ID and PIN.
uberGARD iKLAS Requirements
- iKLAS cabinet: One or more iKLAS key cabinets installed, powered, and connected to the network at the target site, with keys loaded into their positions.
- API user account: An iKLAS user account for Sine to authenticate with. This account must be permitted to create and delete users, assign and revoke key access profiles, and read key groups, keys, and transactions.
- Key groups: The keys that should be available to visitors grouped into one or more iKLAS key groups. Sine syncs keys by key group, so a key that does not belong to a selected group is never offered at check-in.
- Audit user: An iKLAS user to which key access changes made by Sine will be attributed in the cabinet's audit records.
- Testing environment: A test cabinet or sandbox environment available for validating the integration before going live.
- Network connectivity: Determine your method for connecting Sine with your on-premise iKLAS system.
- Direct API access: Requires network firewall access to the iKLAS API from outside your network.
- Sine Secure Bridge: Requires installation of the Sine Secure Bridge agent to establish a secure, managed tunnel between your on-premise iKLAS system and Sine.
Configuration
uberGARD iKLAS Configuration
iKLAS Configuration
Complete these steps in iKLAS before configuring the integration in Sine. The Sine configuration requires values that you create during this setup.
Create the API user — Create a dedicated iKLAS user for Sine and grant it permission to manage users and key access profiles and to read key groups, keys, and transactions. Record its username and password for use in the Sine configuration.
Name the keys — Confirm that every key you intend to offer is installed in a cabinet position and clearly named in iKLAS. Key names are what visitors see when selecting keys at check-in, so name each key in terms a visitor would recognize, such as the door, room, or vehicle it corresponds to.
Create key groups — Group the keys that should be available to visitors into one or more key groups. Only keys belonging to the key groups selected in Sine are synced and offered at check-in, so key groups determine which keys visitors can request.
Identify the audit user — Identify the iKLAS user to which key access changes made by Sine should be attributed, and record its user ID for use in the Sine configuration.
Confirm network access — Confirm that the cabinet's API is reachable from Sine, either by allowing inbound access through your firewall or by preparing a Sine Secure Bridge tunnel that reaches it.
Sine Configuration
General Setup
Admin permissions — Ensure you have Team or Site Admin permissions. These permissions are required to configure integrations.
Log in — Log on to the Sine admin dashboard.
Select site — Navigate to the Locations tab and click on the site you want to configure the integration for.
Add integration — In the Site menu, click Integrations. Click Add integration and select iKLAS from the list of available integrations. If the integration does not appear in the list, contact support.
Name integration — Enter a name for the integration. You can use any name, but choose one that helps you identify its purpose.
Connection
Connection Method
There are two ways to establish network connectivity to your on-premise iKLAS system.
Select your preferred method below.
Sine Secure Bridge enables a secure, managed tunnel between Sine Cloud and your on-premise system's API.
Enable Secure Bridge — Switch Use Sine Secure Bridge on to display a dropdown list of your Secure Bridge tunnels, then select the tunnel that reaches your iKLAS server. Sine takes the server address from the tunnel, so the Base URL field is hidden while the toggle is on. If the Sine Secure Bridge toggle is not visible, contact your Sine representative.
Documentation — For more information on installing and configuring a Sine Secure Bridge tunnel, visit the Secure Bridge Documentation.
Authentication
Credentials — Enter the iKLAS username and password that Sine should authenticate with. These credentials belong to the API user created in iKLAS, not an administrator's personal login.
Test Connection — Click Test connection to confirm that your configuration is correct. Once Sine successfully verifies the connection to your iKLAS account, the Integration Settings section becomes available.
Integration Settings
These settings become available once the connection has been tested successfully.
Settings
Key groups — Select the iKLAS key access groups that should be available to visitors when this integration activates access. Keys that do not belong to any of the selected groups are never synced into Sine. Controls which keys are synced from the cabinet and offered to visitors at check-in.
Asset type — Select the dynamic asset type that the synced keys should be written to. This must be the same asset type that the key selection question on your visitor type form is bound to. The dynamic asset type the integration manages and syncs keys into. Only dynamic asset types that are not already linked to another integration can be selected. You can manage asset types from the Asset types page.
Audit user ID — Enter the ID of the iKLAS user that key access changes made by Sine will be attributed to.
Max keys per user — Set a limit between 1 and 12 for how many keys can be assigned to each visitor.
Visitor Requirements
Visitors may not receive key credentials — Key credentials are sent to the email address captured on the visitor's pass, so a pass created without an email address will never receive them. This panel appears when a visitor type at the site can check in without an email address, and it names the affected visitor types. Use Review settings to make email a required field for those visitor types, or leave the panel as-is if those visitor types are not meant to be offered keys.
Manual Update
- Sync key data — Click Run sync to reconcile the linked asset type against iKLAS immediately, rather than waiting for the next scheduled sync. New, removed, and updated keys are all reflected in the asset type. Run this after adding or renaming keys in the cabinet so they become selectable at check-in right away.
Notifications
- Send integration failure notifications — If the integration fails, enter one or more email addresses to be notified of the failure and its corresponding details.
Save
- Save the integration — Click Save. Sine verifies the connection, links the selected asset type to this integration, and runs a first sync of the keys in the selected key groups. Keys are then re-synced once a day for as long as the integration stays active.
Key Selection at Check-in
The integration only runs for a visitor when they select keys on their check-in form, so the final step is to put the key selection question in front of the right visitors.
Complete this section after saving the integration, so the synced keys are available to confirm.
Confirm the synced keys — Open the Asset types page and confirm that the keys from your selected key groups now appear under the linked asset type. These assets are read-only, as they are maintained by the integration, and keys that leave your selected key groups are dropped from the list on the next sync.
Add the key selection question — On each visitor type that should be offered keys, add the key selection question to the form and bind it to the asset type linked above. The question's options are loaded from the asset type each time the form is opened, so the key list is always current.
Confirm host approval — Confirm that Host Selection Required is ticked for those visitor types. Key access is activated when a pass is approved, so without host approval a visitor's keys are released as soon as they check in.
Testing
Create a test check-in — Check in a test visitor using a visitor type whose form includes the key selection question, and select one or more keys.
Verify the visitor record — Confirm that a user record for the test visitor is created in iKLAS with the selected keys assigned to them.
Verify credential delivery — Approve the test visitor's pass and confirm that they receive their cabinet access credentials.
Retrieve a key — Use the delivered credentials at the iKLAS cabinet and confirm the selected keys are released.
Verify key return and revocation — Check the test visitor out, return the keys to the cabinet, and confirm that their access is revoked and their iKLAS user record is removed.
Check failure notifications — Monitor the integration failure notifications to ensure they are working correctly.
Need help? Contact Sine Support at [email protected]