UniFi Access

Set it up in Club Admin

Connect the console, match doors to courts, unlock doors and issue door PINs for bookings

Everything for UniFi Access lives on one page: Club Admin → Business → Integrations → UniFi Access (/admin/app/business/integrations/unifi-access). You need to be an admin of the club.

Before you start, the VPN should be connected and you should have an API token.

VPN connection

The first card creates your console's tunnel to SportyPlus: Create VPN connection downloads the file you import on the console (see Connect the VPN). Afterwards the card shows:

  • the tunnel address your console has, which is also its console address below
  • Connected or Waiting for the console, and when the console last made contact
  • Download a new file, for a lost file or a new console. It issues new keys and a new tunnel address, and the console address updates to match.
  • Remove VPN connection, which cuts the tunnel within a minute. Door PINs and unlocking stop until you create a new one.

Console

FieldWhat to enter
Activeon
Console addresshttps:// + your console's tunnel address + :12445, for example https://10.200.0.3:12445. Creating the VPN connection fills this in.
API tokenthe token you copied from UniFi Access

Press Save.

Use the tunnel address, not the console's address on your club network. It's unique to your club, so it never clashes with another club's network. The address must be https, a private network address and port 12445, and anything else is refused on save. That's deliberate: SportyPlus only ever talks to a console through your tunnel.

The token can't be read back once it's saved. The field shows Saved. Leave blank to keep it. Leave it empty to keep the stored token, or paste a new one to replace it.

Doors

Press Read doors from console. SportyPlus lists every door your console has, with its name and full location, and shows when the doors were last read.

For each door, choose the Courts it serves:

  • one or more courts, for a door that only leads to those courts
  • All courts, for a door every booking passes through, such as the building entrance. Choosing it clears any individual courts, and choosing a court clears All courts.
  • nothing, for a door SportyPlus should never give access to, such as an office or a store room

Press Save at the bottom of the list to keep the courts you chose.

Reading the doors again later keeps the courts you already set. A door that has been removed from the console disappears from the list, along with its courts.

Unlocking a door

Every door has an Unlock button. It opens the door once, immediately, for whoever is standing at it. You're asked to confirm first.

The console's own log records the unlock under your name, prefixed SportyPlus:, so you can always see who opened a door from Club Admin. A few unlocks a minute is the limit.

Door PINs

This section is where bookings turn into door access.

SettingWhat it doesDefault
Issue door PINs for bookingsturns door PINs on for your cluboff
Minutes before the bookinghow early a PIN starts working15
Minutes after the bookinghow long it keeps working once the booking ends15
PIN lengththe length of new PINs, which must match the PIN length set on your console6

Nothing happens until you turn Issue door PINs for bookings on and save. So you can connect the console and match doors first, and switch PINs on when you're ready, ideally with someone at the club to try a door.

What members get

Once PINs are on, within a minute of a booking being paid:

  • every player and every coach on the booking can get in with their own PIN. People only watching a booking don't get one.
  • the PIN works on the doors that serve the booked court, plus any All courts door
  • from the chosen minutes before the booking starts until the chosen minutes after it ends

A member's PIN is their entry code, which the app and booking reminder emails already show. It stays the same from booking to booking. A member who already has an entry code from Weblock keeps that code. Otherwise SportyPlus creates one of the PIN length you set.

A booking that is still waiting for payment gets no access until it's paid. A cancelled booking stops working within a minute.

How it looks on the console

Each member appears in UniFi Access as one visitor, named after them, carrying their PIN. SportyPlus moves that visitor from booking to booking: once one booking's time has passed, the visitor's time and doors change to the member's next booking. Two bookings back to back become one continuous stretch, so the member isn't locked out in between. When a member has nothing else booked, their visitor is removed, but they keep their PIN for next time.

Don't edit these visitors on the console. SportyPlus corrects them within a minute.

Turning Issue door PINs for bookings off stops SportyPlus from creating or changing visitors, but it doesn't remove the ones already on the console. Delete them in UniFi Access if you need access to stop immediately.

When something goes wrong

SportyPlus shows the console's answer when an action fails.

MessageWhat it means
The UniFi Access console could not be reachedthe VPN is down, or the firewall rule is missing. Check that the SportyPlus VPN client is on.
refused the request (401)the API token is wrong or has expired. Create a new one and paste it in.
refused the request (403)the token is missing a permission
The console address … is not allowedthe address isn't in the form https://10.200.0.x:12445
UniFi Access is not set up for this clubsave the console address and the token first

If a member's PIN doesn't open a door, check that the booking is paid, that its court is matched to that door, and that Issue door PINs for bookings is on. A console that was offline catches up on its own within a minute of coming back.