1. Overview
This is a CLUe Plug-In that integrates user data from Brivo onAir. For smooth configuration, it retrieves all users from Brivo and synchronizes them to Suprema devices through CLUe.
Following the flowchart below, when user information is fetched from Brivo, the system automatically issues a Card ID to each user for communication with the device.
The reason is to provide a simple and separate identifier for biometric authentication in Suprema devices, regardless of the physical cards actually used in Brivo.
Therefore, deleting this card on the Brivo side should be done with caution.
For important reference, the current integration is targeted at the Brivo EU server, and will later be expanded to support the Brivo Global server as well.
In addition, for customers concerned about storing personal information in the cloud, a feature to obtain user consent via email will be added.
2. Getting Started
Step1. Before You Begin
First, obtain the Brivo Control Panel, as well as your Brivo onAir account and API key.
The Brivo API key is required for integration, and can be issued through the Brivo Developer Portal. Please make sure to verify this in advance.
Step2. Brivo onAir Configuration
For CLUe to access Brivo, an API Token must also be issued.
In the Brivo onAir Marketplace, configure Generate API Token, and select Application Type = Password. You may freely enter the Name and Description fields. After creating, you can check the necessary key values from the detail.
Additionally, click on your profile to check your Admin ID, and copy it.
Since this integration requires using an ID value different from your login email ID, make sure to copy and paste this Admin ID for use in the setup.
Step3. CLUe Portal Basic Settings
First, access the Place Group settings and check the Service Settings.
In the Service Settings of the place group, configure the options as shown below to select the authentication methods you want to use. Be careful not to select other service modes. If you do not have an account to access the Place Group, contact your vendor or Suprema to receive an invitation.
Then, create a child place by clicking "Add Child" and set as shown below to create.
Please check the device has been properly registered with the CLUe firmware and assigned to your place group. If it's not registerred, please contact Suprema or your distributor for assigning the device to your account.
For those who are not familiar with this part, please refer to the link below.
CLUe FW Update Guide from the standard BioStar FW
Pleas assign the device to the created place and move to the place to set the door.
Create a door with necessary ports settings. Without a door, CLUe portal does not sync user data to the device.
Step4. CLUe Portal Brivo Plugin Settings
Now, go to the Users tab to configure the Brivo Plug-In. The Brivo Plug-In setup requires all the keys issued earlier. Make sure to enter each key without omission.
In particular, the Admin ID is the ID value found in your account profile, not your email, and the password corresponds to your login password. Also, make sure to enter the API key obtained separately from the Brivo Developer Portal.
After entering all the information, be sure to perform a Test Call. Synchronization can only proceed if the entered values are correct.
The Card Type setting determines the type of card to be assigned to users, as explained in the overview. A unique random value is generated according to this format and assigned to each user. It is necessary to check the Wiegand type used on the Brivo side.
We also recommend distinguishing it from the physical card type that will be used. The following card types are supported.
Step5. CLUe - Brivo User Sync
When you click Start Sync, a task begins that retrieves all users from Brivo and assigns cards to them.
If there are many users, this process may take a considerable amount of time because the Brivo API is called individually for each user to assign the card.
You can monitor the progress via the notification bar at the bottom.
The Brivo API Key has a usage limit.
If any requests fail, check whether the API key limit has been exceeded.
Once the user sync is complete, the user list will be displayed as shown below. When you click on a user, you can see that a random Card ID has been assigned, which is also reflected in Brivo.
Afterwards, if a user is deleted or their name is edited in Brivo onAir, CLUe will receive a webhook event and automatically reflect the changes.
Therefore, when a user is deleted in Brivo, all assigned authentication methods for that user are also automatically removed.
Step6. CLUe - Register Biometrics
Through CLUe, you can register facial and fingerprint biometric authentication methods. Registration can be done via the portal, mobile app, API, and from the device directly.
Using the mobile app, you can register fingerprints by scanning them directly through the device. To do this, you need to be invited as an administrator of the place.
After downloading and logging into the Suprema CLUe app, you can perform the scan through the device. The app can be downloaded from the App Store and Google Play.
Step7. CLUe - Device Setup
Finally, check whether any additional settings are required via the Wiegand settings on the device. If you want the device to display the authentication result from the controller as the final result, you can configure it on this page.
You can choose whether to display authentication success on the device or to use the input ports.
