Introduzione

Questa è l'API principale usata per i siti e i sistemi rivolti al pubblico. **Se sei uno sviluppatore di terze parti e vuoi usare questa API, contatta l'assistenza di Performance Hub per far inserire i tuoi IP nella whitelist; in caso contrario, verrai limitato e/o bloccato se ci sono troppe richieste dallo stesso referrer / IP.**

URL di base

https://uapi.gymsystems.co/

Autenticazione

La Universal API usa l'autenticazione con chiave API tramite intestazioni HTTP.

Includi la tua chiave API nell'intestazione X-API-Key di ogni richiesta.

Gestisci le tue chiavi API con cura: danno accesso completo al tuo account. Non esporre mai queste chiavi in repository pubblici, applicazioni lato client o in qualsiasi luogo in cui potrebbero essere compromesse.

L'API accetta solo connessioni HTTPS sicure. Le richieste HTTP non cifrate vengono rifiutate, così come qualsiasi richiesta priva di credenziali di autenticazione valide.

Richiesta di esempio

curl https://uapi.gymsystems.co/api/v1/clubs \
  -H "X-API-Key: YOUR_API_KEY"

Modulo di contatto generale

L'API usata per i messaggi di 'contatto generale' dai siti web di Example Club e da altri servizi rivolti all'esterno (come il training camp ecc.).

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione di cui vuoi ottenere i dati delle strutture: serve a garantire che vengano restituite solo strutture appartenenti alla stessa organizzazione. leadForwarding `string` (facoltativo) Indica se inoltrare le email a un sistema di gestione dei lead (gymsales, gymleads ecc.). Nota: con `onlyForwardIfConfigured` i lead vengono inoltrati a qualsiasi CRM, ma non all'email principale della struttura...

Corpo della richiesta

Corpo del contatto generale

Endpoint

POST /api/v1/support/contact-submission

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/support/contact-submission \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Prova gratuita

Genera una richiesta della pagina di destinazione 'prova gratuita' per la struttura specificata

Corpo della richiesta

Corpo della prova gratuita

Endpoint

POST /api/v1/leads/free-trial

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/leads/free-trial \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Prenota un allenamento

L'API usata per il modulo 'prenota un allenamento' dei siti web di Example Club.

Corpo della richiesta

Corpo di Prenota un allenamento

Endpoint

POST /api/v1/leads/book-a-workout

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/leads/book-a-workout \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Richieste di contatto per il Training Camp

Traccia le richieste di registrazione dell'interesse dell'utente per il Training Camp dai nostri siti web principali: queste informazioni vengono poi usate per indirizzare l'utente all'app/al sito trainingcamp.com e per consentire alle strutture di iscrivere il membro al training camp.

Corpo della richiesta

Corpo della pagina

Endpoint

POST /api/v1/leads/training-camp

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/leads/training-camp \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Ottiene i metadati di una singola struttura o di tutte le strutture

Questa API restituisce i metadati usati per visualizzare la pagina di una singola struttura, oppure tutte le strutture presenti nel database.

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione di cui vuoi ottenere i dati delle strutture: serve a garantire che vengano restituite solo strutture appartenenti alla stessa organizzazione. club `string` (facoltativo) L'ID della struttura che vuoi ottenere... *NB* Puoi ometterlo se vuoi restituire TUTTE le strutture in un unico oggetto JSON.

Endpoint

GET /api/v1/club/data

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/club/data \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Ottiene i metadati di una singola struttura o di tutte le strutture

Questa API restituisce i metadati usati per visualizzare la pagina di una singola struttura, oppure tutte le strutture presenti nel database.

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione di cui vuoi ottenere i dati delle strutture: serve a garantire che vengano restituite solo strutture appartenenti alla stessa organizzazione. club `string` (facoltativo) L'ID della struttura che vuoi ottenere... *NB* Puoi ometterlo se vuoi restituire TUTTE le strutture in un unico oggetto JSON.

Endpoint

GET /api/v2/club/data

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v2/club/data \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Cerca strutture per città e lat/lng

Esegui una ricerca delle strutture vicine in base a latitudine, longitudine e termini di ricerca (come un quartiere, un paese o una città)

Parametri

geogroup `string` (facoltativo) Restituisce un elenco 'raggruppato' di città/stati/paesi in cui si trovano le strutture search `string` (facoltativo) Il termine da cercare: in genere un paese, una città, un quartiere o un codice postale limit `string` (facoltativo) Numero massimo di risultati origin `string` (facoltativo) La latitudine e la longitudine da cui basare la ricerca: è fondamentale quando si cercano paesi/quartieri con lo stesso nome ma in paesi/città diversi in cui ci sono più strutture, ad es. `Southbank Example City` o `Southbank Example City 2` organisationId `string` (facoltativo) L'ID dell'organizzazione per cui filtrare le strutture: serve a garantire che vengano restituite solo strutture appartenenti alla stessa organizzazione.

Endpoint

GET /api/v1/club/geosearch

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/club/geosearch \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Elenca le recensioni fissate di una singola struttura

Questa API restituisce le recensioni fissate della struttura.

Parametri

club `string` (facoltativo) L'ID della struttura che vuoi ottenere

Endpoint

GET /api/v2/club/reviews

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v2/club/reviews \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera la configurazione di un'app impostata nella struttura indicata

Parametri

clubID `string` (facoltativo) L'ID della struttura che vuoi ottenere appID `string` (facoltativo) L'ID dell'app che vuoi ottenere

Endpoint

GET /api/v1/club/apps/config

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/club/apps/config \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Latitudine e longitudine in base all'IP dell'utente

Restituisce la latitudine e la longitudine stimate dell'IP di un utente in base al database GeoIP di Maxmind.

Endpoint

GET /api/v1/geo/ip

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/geo/ip \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Analizza una stringa di indirizzo e la restituisce come oggetto.

Converte la stringa dell'indirizzo in un oggetto composto da via, città, stato e codice postale.

Corpo della richiesta

Corpo della pagina

Endpoint

POST /api/v1/user/address-parser

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/user/address-parser \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Traccia le email inviate nel nostro database centrale.

Traccia nella nostra tabella DynamoDB centrale le email inviate alle varie parti del nostro sito web _(ad es. API interne, Mailchimp, Hubspot ecc.)_ e/o ad API di terze parti, consentendo analisi e targeting più dettagliati dei membri dell'ecosistema Example Club.

Corpo della richiesta

Corpo della pagina

Endpoint

POST /api/v1/analytics/track-email

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/track-email \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Invia dati a Graylog

Invia dati da vari servizi front-end al nostro sistema interno di gestione dei log (Graylog).

Corpo della richiesta

Corpo della pagina

Endpoint

POST /api/v1/analytics/beacon

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/analytics/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Verifica se un ID di fascia Myzone è registrato presso una struttura

Restituisce true o false a seconda che un ID di fascia Myzone sia associato all'ID della struttura indicato.

Parametri

club `string` (facoltativo) L'ID della struttura da interrogare beltid `string` (facoltativo) L'ID della fascia Myzone da cercare

Endpoint

GET /api/v1/myzone/belt-registered

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/myzone/belt-registered \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera la frequenza delle registrazioni di accesso

Recupera l'elenco delle registrazioni di accesso dei membri in un determinato periodo

Parametri

start_date `string` (facoltativo) La data di inizio del periodo usata per filtrare le visite dei membri end_date `string` (facoltativo) La data di fine del periodo usata per filtrare le visite dei membri club `string` (facoltativo) La struttura specifica a cui il membro è iscritto, per filtrare la struttura in cui il membro ha registrato l'accesso email `string` (facoltativo) L'email specifica usata per la registrazione dell'accesso

Endpoint

GET /api/v1/members/swipes/frequency

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/members/swipes/frequency \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Webhook per gli eventi di check-in di GymMaster

Endpoint

POST /api/v1/webhooks/gymmaster/checkin

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/webhooks/gymmaster/checkin \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Registra/invia l'ID del dispositivo

Salva nel database l'UUID, l'IP e lo Screen ID (ID del dispositivo) di un computer Display Screens, consentendo di associare il dispositivo tramite il Performance Hub.

Corpo della richiesta

A questo endpoint deve essere inviato un oggetto JSON contenente informazioni sul dispositivo, come l'IP e l'UUID

Endpoint

POST /api/v1/devices/dashkiosk/register

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/dashkiosk/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Imposta lo stato di un pulsante di emergenza

Imposta su `true|false` lo stato di un pulsante di emergenza associato a una struttura. Nota: puoi modificare solo lo stato di un pulsante registrato presso una struttura. Non funziona per i dispositivi non ancora configurati.

Corpo della richiesta

Oggetto JSON dello stato di allarme del pulsante di emergenza

Endpoint

POST /api/v1/devices/duress/setAlarmState

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/duress/setAlarmState \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Restituisce i pulsanti di emergenza associati alla struttura

Restituisce un array dei pulsanti di emergenza associati a una struttura di cui verificare gli aggiornamenti.

Parametri

clubID `string` (obbligatorio) ID della struttura da interrogare

Endpoint

GET /api/v1/devices/duress/getDuressButtons/{clubID}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/devices/duress/getDuressButtons/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Aggiorna i metadati del dispositivo

Aggiorna i metadati del dispositivo per un UUID. Nota: per inviare dati a questa funzione non è richiesta l'autenticazione, quindi i dati non devono contenere informazioni sensibili.

Corpo della richiesta

A questo endpoint deve essere inviato un oggetto JSON contenente informazioni sul dispositivo, come informazioni sul sistema operativo, metriche Wi-Fi ecc.

Endpoint

POST /api/v1/devices/metadata/beacon

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/metadata/beacon \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Restituisce informazioni su un display in base all'UUID del dispositivo.

Ottiene la configurazione di un dispositivo in base al suo UUID e restituisce informazioni come il round associato al dispositivo e i contenuti da visualizzare.

Parametri

uuid `string` (obbligatorio) UUID del dispositivo per cui recuperare la configurazione

Endpoint

GET /api/v1/devices/displayconfig/{uuid}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/devices/displayconfig/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Restituisce le informazioni di configurazione di un dispositivo in base all'UUID.

Recupera la configurazione di un dispositivo da più tabelle (Display Screens, dispositivi IoT, dispositivi TVCC) usando l'UUID del dispositivo e restituisce i dettagli di configurazione pertinenti in formato JSON.

Parametri

uuid `string` (obbligatorio) UUID del dispositivo di cui recuperare la configurazione

Endpoint

GET /api/v1/devices/config/{uuid}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/devices/config/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Registra un dispositivo beacon BLE

Salva nel nostro database le informazioni del dispositivo beacon BLE

Corpo della richiesta

Dati del dispositivo beacon BLE

Endpoint

POST /api/v1/devices/blebeacon/register

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/blebeacon/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Elenca i dispositivi TVCC associati al ClubID

Elenca i dettagli generali dei dispositivi TVCC associati a un ClubID. Nota: questa API restituisce solo informazioni generiche/di alto livello, come gli indirizzi IP locali dei dispositivi e se sono online|offline. Per i dettagli avanzati dei dispositivi è necessario usare l'API di Performance Hub.

Parametri

clubID `string` (obbligatorio) ID della struttura da interrogare

Endpoint

GET /api/v1/devices/cctv/list-devices/{clubID}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/devices/cctv/list-devices/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Registra un dispositivo TVCC

Salva nel nostro database le informazioni del dispositivo TVCC

Corpo della richiesta

Dati del dispositivo TVCC

Endpoint

POST /api/v1/devices/cctv/register

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Registra un dispositivo AI Edge Processor

Salva nel nostro database le informazioni del dispositivo AI Edge Processor

Corpo della richiesta

Dati del dispositivo AI Edge Processor

Endpoint

POST /api/v1/devices/ai-edge-processor/register

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/ai-edge-processor/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Genera un URL firmato per accettare i caricamenti delle registrazioni TVCC

Genera un URL S3 firmato che consente al client di caricare direttamente su S3 una registrazione TVCC per la post-elaborazione.

Corpo della richiesta

Metadati del dispositivo

Endpoint

POST /api/v1/devices/cctv/generate-upload-token

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/generate-upload-token \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Comunica a S3 che il caricamento multiparte è stato completato

Comunica a S3 che il caricamento multiparte è stato completato dal client

Corpo della richiesta

Metadati del dispositivo

Endpoint

POST /api/v1/devices/cctv/complete-upload

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/complete-upload \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Risposta

{}

Invia un comando Sonos ai dispositivi Sonos della struttura

Parametri

clubID `string` (obbligatorio) ID della struttura da interrogare

Endpoint

POST /api/v1/devices/audio-control/command/{clubID}

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/devices/audio-control/command/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera le impostazioni di Controllo audio della struttura

Parametri

clubID `string` (obbligatorio) ID della struttura da interrogare

Endpoint

GET /api/v1/devices/audio-control/config/{clubID}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/devices/audio-control/config/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Crea un token di accesso temporaneo

Endpoint

POST /api/v1/temporary-access/token

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/temporary-access/token \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera gli elementi del livestream musicale

Endpoint

GET /api/v1/streams

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/streams \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera i dati di un elemento del livestream musicale

Parametri

id `string` (obbligatorio) ID univoco che identifica un elemento dello stream

Endpoint

GET /api/v1/streams/{id}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/streams/{id} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera le voci delle FAQ

Parametri

location `string` (facoltativo) La posizione in cui vuoi che compaia la voce delle FAQ, ad es. il sito web principale (website_main). categories `string` (facoltativo) Categorie della voce delle FAQ. status `string` (facoltativo) Lo stato della voce

Endpoint

GET /api/v1/faqs

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/faqs \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera le voci delle FAQ

Parametri

category `string` (obbligatorio) Filtro per categorie

Endpoint

GET /api/v1/faqs/{category}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/faqs/{category} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera le voci della rassegna stampa

Parametri

location `string` (facoltativo) La posizione in cui vuoi che compaia la voce della rassegna stampa, ad es. il sito web principale (website_main). status `string` (facoltativo) Lo stato della voce

Endpoint

GET /api/v1/press

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/press \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera la mappatura delle email

Endpoint

GET /api/v1/email-mapping

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/email-mapping \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera i codici di tracciamento personalizzati

Parametri

clubID `string` (obbligatorio) L'ID o la località della struttura, ad es. Milton

Endpoint

GET /api/v1/customtracking/{clubID}

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/customtracking/{clubID} \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Recupera le voci delle pagine di destinazione

Parametri

region `string` (facoltativo) La regione a cui appartiene una struttura, ad es. AU, NZ, US club `string` (facoltativo) ID della struttura, identificatore univoco della struttura slug `string` (facoltativo) L'ultima parte dell'indirizzo URL, che funge da identificatore univoco della pagina

Endpoint

GET /api/v1/landing-pages

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/landing-pages \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Modulo di contatto del sito web di Performance Hub

Riceve gli invii dei moduli dal sito web di Performance Hub (richieste di demo, richieste commerciali, ordini di accesso anticipato) e invia email di notifica tramite SES.

Endpoint

POST /api/v1/performancehub/website-contact

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/performancehub/website-contact \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Richiedi un OTP di Door & Gate Access

Invia un codice di verifica monouso al telefono o all'email forniti. Risponde sempre 200 per impedire l'enumerazione degli identificatori. Con limite di frequenza per identificatore e per IP (finestra scorrevole Redis).

Endpoint

POST /api/v1/door-gate-access/auth/otp/request

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/request \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Verifica un OTP di Door & Gate Access ed emetti i token

Verifica l'OTP, risolve i profili delle persone collegati in tutte le strutture e restituisce un JWT di breve durata + un token di aggiornamento opaco a rotazione.

Endpoint

POST /api/v1/door-gate-access/auth/otp/verify

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/otp/verify \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Ruota un token di aggiornamento di Door & Gate Access

Endpoint

POST /api/v1/door-gate-access/auth/refresh

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/refresh \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Revoca un token di aggiornamento di Door & Gate Access

Endpoint

POST /api/v1/door-gate-access/auth/logout

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/auth/logout \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Sessione corrente di Door & Gate Access

Endpoint

GET /api/v1/door-gate-access/me

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Aggiorna i campi modificabili del profilo

Aggiorna firstName / lastName in ogni riga ph-door-access-users che corrisponde all'identificatore del JWT. Email e telefono non possono essere modificati qui.

Endpoint

PATCH /api/v1/door-gate-access/me

Richiesta di esempio

curl -X PATCH https://uapi.gymsystems.co//api/v1/door-gate-access/me \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Elenca le strutture dell'utente di Door & Gate Access

Endpoint

GET /api/v1/door-gate-access/me/facilities

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/facilities \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Imposta la struttura attualmente selezionata dall'utente

Endpoint

POST /api/v1/door-gate-access/me/facility

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/me/facility \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Elenca le porte che l'utente può aprire in una struttura

Parametri

facilityId `string` (facoltativo) Identificatore della struttura (clubID).

Endpoint

GET /api/v1/door-gate-access/me/doors

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/doors \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Tentativi di sblocco recenti dell'utente corrente

Endpoint

GET /api/v1/door-gate-access/me/access-history

Richiesta di esempio

curl -X GET https://uapi.gymsystems.co//api/v1/door-gate-access/me/access-history \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}

Sblocca una porta dall'app mobile Door & Gate Access

Controlli rigorosi lato server prima della pubblicazione su MQTT. Il server è la fonte attendibile per le regole permanenti, le Access Time Windows aggiuntive, i blocchi espliciti delle porte, la modalità di manutenzione e il geofence. Lo stato del client serve solo all'esperienza utente.

Parametri

doorId `string` (obbligatorio) balenaUUID del controller della porta.

Endpoint

POST /api/v1/door-gate-access/doors/{doorId}/unlock

Richiesta di esempio

curl -X POST https://uapi.gymsystems.co//api/v1/door-gate-access/doors/{doorId}/unlock \
  -H "x-api-key: YOUR_API_KEY"

Risposta

{}