Sine Access Control
Integration Guide
Overview
This integration connects our platform with virtually any third-party access control system to automatically provision, activate and revoke visitor access credentials. It supports QR codes printed on visitor badges or sent via SMS, as well as physical cards such as HID proximity cards that you can manage as assets and assign to visitors during check-in.
How It Works
Sine connects directly to your access control system, allowing visitor and staff credentials to be provisioned and revoked automatically as check-in and check-out events occur on our platform.
Requirements
Sine Requirements
- Integration enablement: Suitable Sine subscription with the Access Control integration enabled (additional fees may apply)
Sine Access Control Requirements
- REST API support: Access control system with REST API support
- API License: API License for remote credential provisioning
- Data adaptor: A middleware capable of translating our credential payloads into a data format compatible with the underlying access control system
- QR Reader: Compatible QR access readers (if using QR codes for access). This should be confirmed with us or your Access Control Integration Partner, however something similar to this is suggested.
- Credential pool: Available credential pool if using physical access cards
- Testing environment: A sandbox environment or safe testing space
- Network connectivity: Determine your method to connect Sine with your on-premise Access Control system.
- Direct API access: Requires network firewall access to the Access Control API from outside your network
Configuration
Sine Access Control Configuration
Vendor Configuration
Enable API access — Enable API access or open protocol support (REST API, SOAP, OSDP, or Wiegand) on the access control system.
API credentials — Create API credentials or configure system access permissions to allow credential provisioning.
Access zones — Configure access zones and permission groups to define the level of access granted to visitors.
Credential pool — Ensure a credential pool or credential issuing capability is available on the access control system.
API documentation — Prepare the relevant API or protocol documentation for use during the Sine integration setup.
Sine Configuration
General Setup
Admin permissions — Ensure you have Team or Site Admin permissions. These 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 the Integrations menu item. Click the Add integration button and select Access Control 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 something that helps you identify what the integration is for.
Connect to Access Control
Connection Method
- Cloud to on-premise: Sine connects directly from the Sine cloud to your on-premise system's API.
Base URL — Enter the URL and port for your Access Control server, for example, https://your-access-control-server.com/api:1234.
Ignore SSL Certificate Check — Turn this setting ON if you are using a self-signed certificate, since the Access Control integration will not be able to validate the certificate otherwise.
Authentication
API Key — Enter your Access Control API Key and your External ID. The External ID can be any value.
Test Connection — Click the Test connection button to confirm that your configuration is correct. Once you have successfully verified that Sine can connect to your Access Control account, the Integration Settings section becomes available.
Integration Settings
Credential Configuration
This setting controls the type of access control credential generated when the integration runs.
Select your preferred credential type below.
Generates and attaches a QR code to a visitor's pass. The integration runs when a pass is created, when a pass expires, or when the visitor checks out.
Send QR Code by SMS — If the visitor's mobile number is available, send them a QR code credential by SMS to their phone. This can serve as a good backup to a badge printer.
Provision credential on check-in — Select one or more visitor types for which you want the integration to provision credentials in your access control system when visitors check in using Sine. Ensure that the Host Selection Required checkbox is ticked for any visitor types used in access control integrations. Without this setting, visitors would receive access credentials without requiring approval from a host. You can review which of your visitor types have Host Approval Required enabled in the General tab of your site settings.
Grace Period — A visitor may check out using Sine before physically leaving the location and may still need to use their credentials to exit. You can set a grace period to ensure their access control credentials are not deprovisioned immediately after being checked out in Sine.
Basic Configuration
Connection details — Enter the connection details specific to your access control system, such as the API endpoint, credentials, IP address, or COM port.
Test connection — Test the connection and enable auto-provisioning for visitor check-in.
Messages
- Visitor failure message — Configure the message displayed to the visitor if the access control integration fails for any reason.
Notifications
- Send integration failure notifications — If the integration fails, you can enter one or more email addresses to be notified of the failures and their corresponding details.
Testing
Create a test check-in — Create a test visitor check-in using a visitor type configured for the integration.
Verify credential provisioning — Verify that the visitor profile is created in the vendor system and that credentials are provisioned correctly.
Test credential access — Test the credential at a compatible reader to confirm that access is granted.
Verify credential revocation — Check out the test visitor and verify that access credentials are revoked after the configured grace period.
Check failure notifications — Monitor the integration failure notifications to confirm they are working correctly.
Need help? Contact Sine Support at [email protected]