Integration Setup

Obtain Your Hostname

NOTE: Unifi Access API is installed on the local hardware and only accessible on your local network at the specified port number.

Forward your local IP port

The UniFi Access application can be hosted on a server within the local network and accessed via the LAN port. The hostname can either be the server's IP address or a custom domain name mapped to that IP. Connect using the specified port number (12445) and establish an HTTPS protocol for a secure connection.

You can find your IP Address on your Unifi hardware. The final hostname will look like this: https://XXX.XXX.XX.XXX:12445 (replace X with your IP Address)

Coworks is a cloud-based platfrom and not installed locally on your Unifi hardware. Therefore the integraiton requires a publically accessible url that maps to your server's IP and port number.

For suggestions on how to produce that url, check our documentaion here.

Generate a new API Key

To activate the integration to Coworks, you must first opttain your Unifi API Key. You can find that key in your Unifi Access dashboard by following these steps:

Click on your access hardware in the top left navigation menu
Click on settings gear on the bottom left to find your access setting.
Under General, scroll down to API Token
Click 'Create New'
Copy your API Token to use in the next step

Connect To Coworks

In Coworks, navigate to the community tab on the bottom left navigation menu. Click on the integrations tab to see the list of available integrations (or click here)
Choose the Unifi Access tile and click "Connect"

3. Add API Token from the previous step

4. Add your publically available hostname

Setup Unifi Door Groups

Create Door Groups by adding new location groups. This lets your group which doors to grant access to for members (e.g. front and back door). To create door groups:

Navigate to the door access dashboard tab
Click on the locations dropdown and choose "create"

3. Name your new door group and select which doors to include

4. Click 'Create'

Adding a Coworks member to Unifi

Note: If you would like us to "bulk" sync your Unifi account based on plan allocations, please reach out. This is a manual process, but we're happy to do it for you!

Once you've activated Unifi as an integration and connected your site to your campus, you're ready to start using the Unifi integration in Coworks.

The Coworks <> Unifi integration works by allowing you to automatically choose which Unifi door groups to assign to members as you add them in Coworks. This way, you don't have to manage multiple platforms and can perform all of your access needs directly within Coworks.

Add New Member / Add Member to an Existing Team

When adding a member, you can toggle on the "Add to Door Access" option and choose which door groups (zones) to add them to (make sure those groups are created in Unifi).

Once added, the member will be automatically created in both Coworks and Unifi. They should receive an email from Unifi with details about downloading the Unifi app and signing in with their Coworks login. After finishing the account setup process, they will automatically have access to the doors you assigned to them during the creation.

Unlock via Coworks app

If you wish to use the Coworks app to let your members unlock doors (instead of the Unifi app) you can update your Integration settings located on the integration card under settings

Enable the Unlcok in Coworks toggle

Your members will then see the 'unlock' icon on the home page of their Coworks app to access their permssioned doors.

Updating an existing Member

You can also set Unifi permissions to existing members by simply going to their profile page toggling on the "Add to Door Access" toggle and clicking "Save." If they've already been synced, you will see a link to take you to their profile in Unifi for edits if needed.

Once a member is linked to Unifi, you will see a link in their Coworks profile that says "Edit in Unifi" Clicking this link will take you directly to that user in the Unifi dashboard and allow you to troubleshoot/edit their access directly.

Adding Members who sign up via the public plan form

If you're using our public plans/signup feature, it allows members to sign up for Coworks all on their own. You can also indicate whether those members get auto-provisioned access to your space. You can also control different access groups for different plans.

To do this:

Go to the plan that is listed publicly.
Once the public signup toggle is enabled, you will be given a section for "Door Access Control."
From there, select "Enable automatic door access" to enable auto access permissions to people who sign up for this plan.
Finally, choose a door group to assign to the member who signs up for this plan.

Removing Coworks members from Unifi

If you deactivate a member in Coworks, they will automatically lose their Unifi access.

Please Note: Cancelling a membership will not automatically revoke that member's Unifi access. You would need to either deactivate the member in Coworks, or manually edit their access within Unifi.

Temporary Access For Visitors

Coworks also supports the ability to grant temporary access for guests and visitors who have booked your space. This is specifically useful for managing access from Day Pass purchases and External Bookings.

To learn how to set this up check out the instructions here.