Use the HybridAF integration API to send your members to HybridAF and read back what HybridAF holds for them, so door access follows your membership records.
Every request goes to one host over HTTPS. Routes start with a version prefix.
https://integration.hybridaf.com/api The facility users reference lists every route under /v1/ with its parameters, fields and examples.
| Method and route | Purpose |
|---|---|
GET/v1/facilityUsers | List the users HybridAF holds for a facility. |
GET/v1/facilityUser | Read one user by email address. |
POST/v1/facilityUser | Create or update one user. |
POST/v1/facilityUsers | Create or update many users in one request. |
Open the facility users reference
To let a member unlock a door from a phone browser without the HybridAF app, see Embedded access.
To record each door open in your own system, see Check-in events.
Each request carries three values. The subscriber access key belongs to your integration partner account, so the same key works for every facility you connect through that partner. The function key and the facility UID come from HybridAF support, and the facility UID is different for each gym.
| Value | Where it goes | What it does |
|---|---|---|
code | Query string | The function key. It opens the API to your integration. A request without a valid key is refused before it reaches your data. |
facilityUid | Query string | The facility UID, a GUID. It names the gym the request is about. |
subscriberAccessKey | Query string | The subscriber access key, a GUID. It belongs to your integration partner account, so the same key works for every facility you connect through that partner. A key that is not valid for the facility is rejected. |
Send all three on every request. Writes are accepted only for a facility whose integration is switched on.
Treat the function key and the subscriber access key like passwords. Keep them on your server, and keep them out of browser code, logs and screenshots.
curl -X GET "https://integration.hybridaf.com/api/v1/facilityUsers?code=<function-key>&facilityUid=<facility-uid>&subscriberAccessKey=<subscriber-access-key>" To get your keys and facility UIDs, or to replace keys you have lost, contact HybridAF support or call 844-927-4313.
Errors come back as JSON problem details. The body has a status that repeats the HTTP status and a detail message.
{"status":404,"detail":"Email address is required."} | Status | When it happens | Body |
|---|---|---|
401 | The function key is missing or wrong. | Empty. |
400 | The facility could not be found, the subscriber access key does not match the facility, or the request failed validation or processing. A user with no email address, an empty bulk array and a bulk array of more than 50 users are all refused this way. | Problem details with a status and a detail message. A rejected subscriber key on a list or read has an empty detail. On a write the detail is a generic message with a log ID. Quote the log ID to support. |
404 | A single-user lookup had no email address or found no user. A write answers 404 when the facility is disabled or its interface is switched off. | Problem details with a status and a detail message. |
500 | The list route answers 500 when subscriberAccessKey is left out. Send all three values on every request. | Empty. |
A successful call returns 200. If you get a response that this page does not describe, send support the time of the request and the facility UID.
Every route carries a version prefix. This documentation covers v1, the only version in service.