This article explains how to integrate your UniFi account with Archie and configure door access for your visitors.
Once the integration is configured, Archie can automatically manage UniFi door access based on the access settings assigned to visits.
Before You Start
Before starting the integration, make sure you have:
A UniFi account already created and configured.
Access to the UniFi Cloud Gateway you want to connect to Archie.
Your UniFi doors and groups configured, if you plan to assign access to specific doors or groups.
Step 1: Create an API Key in UniFi
The first step is to create an API key that Archie will use to connect to your UniFi account.
Log in to your UniFi portal.
Under Cloud Gateways, locate the Cloud Gateway you want to use with Archie.
Click Access.
Click Settings.
Under General Settings, click Create New.
Enter a name for the connection.
Make sure the required access permissions are enabled as shown in the screenshot below.
Create the connection.
Once the connection has been created, UniFi will provide you with an API key.
Important: Save the API key in a secure location. You will need it when connecting your UniFi account to Archie.
Step 2: Connect Your UniFi Account to Archie
Once you have your UniFi API key, you can connect your account to Archie.
In Archie, go to Settings → Integrations → App Marketplace.
Locate the UniFi app.
Click View Integration.
Click Connect UniFi Account.
Enter the IP address used to access your UniFi portal.
Important: The IP address must be a public IP address that can be accessed from outside your local network.
Enter the Port used by your UniFi portal. Make sure the port is accessible from outside your network.
Enter the API key you created in Step 1.
Review the information and click Connect.
Your UniFi account is now connected to Archie and ready to use.
Step 3: Configure Door Access for Visitors
You can configure door access for visitors by adding a door access configuration to your visitor settings.
From the main Archie page, go to Settings → Visitor → General.
Scroll down to the Visits Door Access Configuration section.
Click Add Door Access Configuration.
Enable Create a link to the door access.
Set the start and end times during which the door access should be available.
Click Add Door Access Configuration.
Select the Group or Doors you want to assign to visitors.
Click Confirm.
Once configured, visitors will receive an email containing a door access link when a visit is created. The visitor can use this link to access the configured doors during the time period you specified.
Archie Tip: You can customize the email sent to visitors by going to Settings → Notification Templates and opening the Visit Details template. Under the predefined parameters, you will find DoorAccessLink. This parameter is used to include the door access link in the email.