Skip to main content

Integrating UniFi with Archie

Setting up your UniFi account

Written by Camilo

This article explains how to integrate your UniFi account with Archie and configure door access for your workspaces, users, and visitors.

Once the integration is configured, Archie can automatically manage UniFi door access based on the access settings assigned to users and bookings.

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.

  1. Log in to your UniFi portal.

  2. Under Cloud Gateways, locate the Cloud Gateway you want to use with Archie.

  3. Click Access.

  4. Click Settings.

  5. Under General Settings, click Create New.

  6. Enter a name for the connection.

  7. Make sure the required access permissions are enabled as shown in the screenshot below.

  8. 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.

  1. In Archie, go to Settings → Integrations → App Marketplace.

  2. Locate the UniFi app.

  3. Click View Integration.

  4. Click Connect UniFi Account.

  5. 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.

  6. Enter the Port used by your UniFi portal. Make sure the port is accessible from outside your network.

  7. Enter the API key you created in Step 1.

  8. Review the information and click Connect.

Your UniFi account is now connected to Archie and ready to use.

Step 3: Configure Door Access for Workspaces

In this step, we will be working with elements already created, for more information about creating an element, you can refer to this article.

Configure Door Access for a Workspace

  1. Go to Settings → Inventory → Workspaces.

  2. In the inventory list, locate the workspace you want to modify.

  3. Click the three-dot menu (⋮).

  4. Click Edit.

  5. Scroll down to Door Access Configuration.

  6. Click Add Door Access.

  7. Select the Doors that should be available for this workspace.

  8. Click Save & Continue.

  9. Click Finish.

The selected door access will now be associated with the workspace.

Step 4: Manually Assign UniFi Door Access to a User

You can manually assign UniFi door access to an individual user.

  1. From the main Archie page, go to Accounts.

  2. Select Personal.

  3. Locate the account you want to modify.

  4. Click the three-dot menu (⋮) next to the account status.

  5. Click Open.

  6. Under the General tab, open the Door Access sub-tab.

  7. Click Add Account.

  8. Select the Groups and/or Doors you want to assign to the user.

  9. Set the Start Date and Start Time for when the access should become active.

  10. Choose whether the access should be indefinite or have an end date.

  11. Click Confirm.

The selected UniFi access will now be assigned to the user according to the dates and times you configured.

Step 5: Manage an Existing UniFi Account

If a user already has a UniFi account connected to Archie, you can manage or modify that connection.

  1. Go to Accounts.

  2. Select Personal.

  3. Locate the account you want to modify.

  4. Click the three-dot menu (⋮) next to the account status.

  5. Click Open.

  6. Under the General tab, open the Door Access sub-tab.

  7. Locate the user's UniFi account number.

  8. Click the three-dot menu (⋮).

You will have the following options:

  • Temporarily Disable: Temporarily disables the UniFi account in Archie. The existing settings remain in place, but the configured door access will not work for the user while the account is disabled.

  • Disconnect from Archie: Disconnects the UniFi account from the user in Archie. Note: This does not delete the user from UniFi.

  • Delete UniFi User: Deletes the user's account from UniFi. Important: Use this option only if you want to remove the user from UniFi entirely.

Step 6: Configure Door Access for Visitors

You can configure door access for visitors by adding a door access configuration to your visitor settings.

  1. From the main Archie page, go to Settings → Visitor → General.

  2. Scroll down to the Visits Door Access Configuration section.

  3. Click Add Door Access Configuration.

  4. Enable Create a link to the door access.

  5. Set the start and end times during which the door access should be available.

  6. Click Add Door Access Configuration.

  7. Select the Group or Doors you want to assign to visitors.

  8. 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.

Did this answer your question?