Introduzione

Benvenuto nell'API di Performance Hub. Questa API gestisce i dati del club e i sistemi chiave che si integrano con il tuo club e con i suoi sistemi esterni, e non è un'API di uso pubblico. Per ulteriori informazioni sull'uso dei vari sistemi Performance Hub supportati da questa API, consulta la voce dedicata al sistema che ti interessa nella [documentazione di Performance Hub](https://docs.performancehub.co).

https://portal.hub.gymsystems.co

Autenticazione

I dettagli di autenticazione ti verranno forniti quando la tua integrazione sarà approvata.

Evento "turno dell'agente completato" segnalato dal dispositivo (attivazione web push)

Chiamato dal sidecar di un dispositivo Agente AI associato (mai dai browser) quando un'esecuzione dell'agente avviata dall'interfaccia web termina dopo aver superato la soglia di notifica del dispositivo. Autenticato con un JWT HS256 di breve durata per dispositivo (aud 'events'). Deduplicato per dispositivo+sessione+avvio e con limite di frequenza per dispositivo, poi recapitato alle sottoscrizioni push HTML5 dell'utente che ha avviato l'esecuzione, con un deep link alla conversazione.

Corpo della richiesta

POST /ai/events/agent-turn-complete

curl -X POST https://portal.hub.gymsystems.co/ai/events/agent-turn-complete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Notifica push avviata dall'agente (skill ph-notify)

Chiamato dal sidecar di un dispositivo Agente AI associato per conto dell'agente sul dispositivo (la skill ph-notify) per inviare una notifica arbitraria al browser e ai dispositivi mobili di un utente. Autenticato con un JWT HS256 di breve durata per dispositivo (aud 'events'). L'utente destinatario deve avere accesso al dispositivo (criterio di accesso per agente); se omesso, la notifica viene inviata al proprietario del dispositivo. Limite di frequenza per dispositivo, separato da quello degli eventi di turno completato.

Corpo della richiesta

POST /ai/events/agent-notify

curl -X POST https://portal.hub.gymsystems.co/ai/events/agent-notify \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Carica un'immagine di notifica (skill ph-notify)

Accetta il corpo di un'immagine non elaborata da un dispositivo associato (JWT con aud 'events') e lo archivia nel bucket pubblico notify-media con una chiave UUID non indovinabile. Gli oggetti si eliminano automaticamente dopo 7 giorni (ciclo di vita S3). Restituisce l'URL https pubblico da usare come `imageUrl` in /ai/events/agent-notify. Limite di 5 MB; solo png/jpeg/gif/webp.

Corpo della richiesta

POST /ai/media/notify-image

curl -X POST https://portal.hub.gymsystems.co/ai/media/notify-image \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Relay MCP del dispositivo per Connected Apps (strumenti SaaS esterni)

Endpoint MCP Streamable HTTP per i dispositivi Agente AI associati (server MCP "connected_apps" sul listener :8790 del sidecar del dispositivo). Autenticato con un JWT HS256 di breve durata per dispositivo (aud 'mcp', la stessa credenziale di /mcp) e subordinato al flag di abilitazione Connected Apps dell'AGENTE (le connessioni sono per dispositivo agente, non per struttura). Le richieste vengono inoltrate in streaming al server MCP della sessione della piattaforma di strumenti a monte dell'agente, con le intestazioni di sessione inserite lato server; le credenziali a monte non raggiungono mai il dispositivo. I nomi degli strumenti e il branding del fornitore vengono resi white-label in entrambe le direzioni durante il transito. Un 401/410 a monte (sessione scaduta) attiva una ricreazione della sessione + un nuovo tentativo.

POST /mcp/apps

curl -X POST https://portal.hub.gymsystems.co/mcp/apps \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca nei registri di controllo delle API (accesso al modulo IAM & Admin)

Cerca e filtra i registri di accesso alle API con funzionalità di filtro avanzate. Gli utenti possono vedere solo i registri delle organizzazioni a cui hanno accesso.

Parametri

organisationId `string` (facoltativo) ID dell'organizzazione per la verifica ACL (obbligatorio)

Corpo della richiesta

POST /api/admin/audit-logs/search

curl -X POST https://portal.hub.gymsystems.co/api/admin/audit-logs/search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni da Redis le statistiche dei registri di controllo memorizzate nella cache (accesso al modulo IAM & Admin)

Recupera le statistiche aggregate dalla cache Redis per il caricamento immediato della dashboard

Parametri

timeWindow `string` (facoltativo) Intervallo di tempo per le statistiche (predefinito 12h)

GET /api/admin/audit-logs/statistics-cached

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/statistics-cached \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le statistiche dei registri di controllo (accesso al modulo IAM & Admin)

Recupera le statistiche aggregate per la dashboard. Limitate alle organizzazioni dell'utente.

Parametri

startTime `number` (facoltativo) Ora di inizio (timestamp Unix), predefinita a 24 ore fa endTime `number` (facoltativo) Ora di fine (timestamp Unix), predefinita all'ora attuale

GET /api/admin/audit-logs/statistics

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/statistics \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni i dati delle serie temporali dei registri di controllo (accesso al modulo IAM & Admin)

Recupera i dati delle serie temporali raggruppati in intervalli per visualizzare la sequenza temporale delle richieste

Parametri

timeWindow `string` (facoltativo) Intervallo di tempo per i dati delle serie temporali: - 1h: ultima ora (blocchi di 10 minuti) - 12h: ultime 12 ore (blocchi di 10 minuti) - 24h: ultime 24 ore (blocchi di 10 minuti) - 7d: ultimi 7 giorni (blocchi di 1 ora) - 14d: ultimi 14 giorni (blocchi di 1 ora)

GET /api/admin/audit-logs/timeseries

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/timeseries \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le organizzazioni a cui l'utente ha accesso per i registri di controllo (accesso al modulo IAM & Admin)

Restituisce l'elenco delle organizzazioni di cui l'utente corrente può visualizzare i registri di controllo

GET /api/admin/audit-logs/user-organisations

curl -X GET https://portal.hub.gymsystems.co/api/admin/audit-logs/user-organisations \
  -H "x-api-key: YOUR_API_KEY"

{}

La chiamata iniziale per creare un nuovo club. Nota: viene creato solo l'oggetto club 'modello'; è poi necessaria una seconda richiesta API per aggiornare il club con i suoi dati, come orari di apertura, posizione, URL dei social e così via.

Parametri

body `string` (obbligatorio) Oggetto JSON del nuovo club da aggiungere al sistema.

POST /api/admin/clubs/addclub

curl -X POST https://portal.hub.gymsystems.co/api/admin/clubs/addclub \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiunge un nuovo utente al sistema

Parametri

body `string` (obbligatorio) Oggetto JSON con i dati dell'utente che vuoi aggiungere o aggiornare.

POST /api/users

curl -X POST https://portal.hub.gymsystems.co/api/users \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca tutti gli utenti (account Google Apps) che hanno accesso al sistema o all'API di backoffice

GET /api/admin/users/listusers

curl -X GET https://portal.hub.gymsystems.co/api/admin/users/listusers \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le chiavi MCP di un utente (oscurate). Gli utenti possono elencare le proprie chiavi.

Parametri

userId `string` (obbligatorio)

GET /api/users/{userId}/mcp-keys

curl -X GET https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea una nuova chiave API MCP per un utente. Gli utenti possono creare le proprie chiavi.

Parametri

userId `string` (obbligatorio) body `object` (facoltativo)

POST /api/users/{userId}/mcp-keys

curl -X POST https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys \
  -H "x-api-key: YOUR_API_KEY"

Revoca o rimuove una chiave API MCP. Gli utenti possono eliminare le proprie chiavi.

Parametri

userId `string` (obbligatorio) keyId `string` (obbligatorio)

DELETE /api/users/{userId}/mcp-keys/{keyId}

curl -X DELETE https://portal.hub.gymsystems.co/api/users/{userId}/mcp-keys/{keyId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Rimuove un ruolo da un utente

Parametri

userId `string` (facoltativo) L'email dell'utente da cui vuoi rimuovere il ruolo. roleId `string` (facoltativo) L'ID del ruolo che vuoi rimuovere dall'utente.

DELETE /api/users/{userId}/roles/{roleId}

curl -X DELETE https://portal.hub.gymsystems.co/api/users/{userId}/roles/{roleId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna i dettagli del profilo di un utente esistente (firstName, lastName, phoneNumber)

Parametri

userId `string` (obbligatorio) Indirizzo email dell'utente body `object` (obbligatorio) Dati del profilo utente da aggiornare

PATCH /api/users/{userId}

curl -X PATCH https://portal.hub.gymsystems.co/api/users/{userId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea o aggiorna un ruolo utente

Parametri

body `object` (facoltativo)

PUT /api/users/{userId}/roles

curl -X PUT https://portal.hub.gymsystems.co/api/users/{userId}/roles \
  -H "x-api-key: YOUR_API_KEY"

{}

Live Services in esecuzione sull'Agente AI di una struttura (selettore di pubblicazione)

Recupera tramite il tunnel i Live Services rilevati dal bridge del dispositivo per il selettore "Publish to Performance Hub" dell'applet. Richiede il modulo ph-ai-agent E l'accesso 'open' per dispositivo (lo stesso requisito della pubblicazione). Ogni servizio viene annotato con publishedAppId quando esiste già una Custom App per la sua porta.

Parametri

club `string` (obbligatorio) device `string` (obbligatorio)

GET /api/agent-apps/services/{club}/{device}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/services/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

{}

Indice dei nomi delle icone MDI incorporato nell'Agente AI di una struttura (selettore di icone)

Inoltra tramite il tunnel l'indice delle icone MDI incorporato nel bridge del dispositivo (GET /__services/icons/mdi/index.json). Il selettore di pubblicazione e modifica usa il catalogo incluso nell'applet (stessa versione fissata 7.4.47); gli SVG delle app pubblicate vengono risolti dal pacchetto locale @mdi/js di portal-server. Stesso requisito di accesso del selettore dei servizi (modulo ph-ai-agent + accesso 'open' per dispositivo).

Parametri

club `string` (obbligatorio) device `string` (obbligatorio)

GET /api/agent-apps/mdi-index/{club}/{device}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/mdi-index/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera un gruppo di SVG di icone MDI dall'Agente AI di una struttura (anteprime del selettore)

Risolve in una sola chiamata fino a 60 glifi MDI per nome dal set di icone incorporato nel dispositivo, sanificati lato server con la stessa allowlist applicata alle icone delle app salvate. Usato dal selettore di icone per mostrare i risultati della ricerca; i nomi sconosciuti restituiscono null.

Parametri

club `string` (obbligatorio) device `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/mdi-icons/{club}/{device}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/mdi-icons/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ambiti di destinatari in cui il richiedente può pubblicare da questa struttura

L'insieme di destinatari che chi pubblica può concedere, per il selettore di pubblicazione e modifica: le strutture raggiunte dai suoi ruoli ph-ai-agent (ambito multi-struttura), più l'indicazione se dispone del livello di organizzazione richiesto per destinatari a livello di intero brand o intera organizzazione nel brand o nell'organizzazione di questa struttura. Le stesse regole vengono applicate di nuovo lato server in fase di pubblicazione o aggiornamento (validatePublishAudience): questo endpoint definisce solo l'interfaccia.

Parametri

club `string` (obbligatorio)

GET /api/agent-apps/audience-options/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/audience-options/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Completamento automatico dei colleghi per i destinatari di un'app con utenti specifici

Cerca SOLO tra gli utenti che il richiedente può già vedere, ovvero le persone i cui ruoli coincidono con almeno una struttura, regione od organizzazione dell'accesso ph-ai-agent del richiedente. Una query di almeno 2 caratteri e un limite di 10 risultati rendono l'endpoint inutilizzabile per lo scraping; lo stesso insieme di utenti raggiungibili viene applicato di nuovo lato server quando i destinatari vengono salvati.

Parametri

club `string` (obbligatorio) q `string` (obbligatorio)

GET /api/agent-apps/user-search/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/user-search/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Pubblica un Live Service dell'Agente AI come Custom App di Performance Hub

Registra un'app web ospitata dall'Agente AI della struttura (un Live Service rilevato dal bridge) come voce "Custom Apps" del menu laterale per i destinatari scelti. Richiede il modulo ph-ai-agent in questa struttura E l'accesso 'open' per dispositivo; i destinatari sono limitati dagli ambiti dei ruoli di chi pubblica (non puoi mai pubblicare oltre ciò che puoi raggiungere). L'identità del servizio viene risolta IN TEMPO REALE dall'elenco /__services del dispositivo; lo schema http/https non viene mai salvato.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/publish/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/publish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Custom App pubblicate visibili in questa struttura

Restituisce le app pubblicate attive i cui destinatari includono questa struttura, nel formato mostrato dal menu laterale (appId, name, icon, description). I destinatari vengono risolti di nuovo in tempo reale a ogni chiamata, quindi le modifiche all'accesso hanno effetto immediato.

Parametri

club `string` (obbligatorio)

GET /api/agent-apps/menu/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/menu/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

App pubblicate gestite da questa struttura (vista di chi pubblica)

Righe complete delle app la cui struttura di ORIGINE è questo club, per l'elenco di gestione "Published Apps" dell'applet. Ogni riga è annotata con canManage per l'utente richiedente (chi pubblica).

Parametri

club `string` (obbligatorio)

GET /api/agent-apps/manage/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/manage/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Genera un token di visualizzazione limitato al servizio per una Custom App pubblicata

Restituisce un URL firmato di breve durata + token che il browser usa per aprire UNA app pubblicata direttamente sul gateway relay regionale del dispositivo. Il token contiene un claim svc che indica la porta del servizio, quindi il gateway limita la sessione a /__services/proxy//: la chat o il terminale dell'agente non sono mai raggiungibili con esso. Chi visualizza deve avere il modulo custom-apps in una struttura inclusa nei destinatari dell'app; NON servono il modulo ph-ai-agent né l'accesso all'agente per dispositivo.

Parametri

club `string` (obbligatorio) appId `string` (obbligatorio)

POST /api/agent-apps/access/{club}/{appId}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/access/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Riferimento di assistenza per una Custom App pubblicata (contatto del proprietario)

Chi fornisce assistenza per questa app pubblicata da un utente: l'email di chi l'ha pubblicata (in alternativa, il proprietario dell'agente che la ospita). Viene mostrato nei pannelli offline o di errore di chi visualizza, così le richieste di assistenza vanno al proprietario dell'app anziché a Performance Hub: le app pubblicate non rientrano nell'assistenza principale di PH. Prima vengono ricontrollati i destinatari dell'app; chi non ha mai ricevuto l'app in condivisione non ottiene alcuna informazione. Le app in pausa vengono comunque risolte (i proprietari rispondono anche alle domande "perché è in pausa?").

Parametri

club `string` (obbligatorio) appId `string` (obbligatorio)

GET /api/agent-apps/support-info/{club}/{appId}

curl -X GET https://portal.hub.gymsystems.co/api/agent-apps/support-info/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia via email una richiesta di assistenza al proprietario di una Custom App pubblicata

Invia il messaggio di chi visualizza al contatto di assistenza dell'app (chi l'ha pubblicata o, in alternativa, il proprietario dell'agente) come email con il marchio: A il proprietario, CC chi visualizza (come copia della richiesta), Rispondi a chi visualizza, così il proprietario gli risponde direttamente. Le app pubblicate sono gestite dagli utenti, quindi la loro assistenza resta fuori dalla coda di Performance Hub. I destinatari vengono ricontrollati; una richiesta per utente per app ogni 15 minuti (cooldown Redis, fail-open).

Parametri

club `string` (obbligatorio) appId `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/support-request/{club}/{appId}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/support-request/{club}/{appId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Aggiorna una Custom App pubblicata (nome, icona, descrizione, stato, destinatari)

Solo per chi pubblica. Le modifiche ai destinatari vengono riconvalidate rispetto agli ambiti dei ruoli di CHI MODIFICA, con le stesse regole di limitazione della pubblicazione. Lo stato alterna tra attivo e in pausa (le app in pausa spariscono dai menu e rifiutano la generazione di token).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/update/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Annulla la pubblicazione di una Custom App (eliminazione logica)

Solo per chi pubblica. Elimina logicamente la riga del registro: l'app sparisce subito dai menu e la generazione di token di visualizzazione viene rifiutata; le sessioni del gateway già emesse scadono alla scadenza del token.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/unpublish/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/unpublish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Trasferisci la proprietà di una Custom App pubblicata

Rispecchia il flusso di riassegnazione del proprietario dell'Agente AI: chi ha pubblicato l'app o un proprietario dell'account (modulo di fatturazione) può cederla a un altro utente, che poi la gestisce. Il nuovo proprietario deve avere accesso alla struttura nel club di origine dell'app.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-apps/transfer-owner/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/transfer-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Esportazioni di skill preparate sull'Agente AI di una struttura (selettore di condivisione)

Inoltra tramite il tunnel l'elenco delle esportazioni preparate dal bridge del dispositivo (GET /__skills/exports) per il selettore "Share a skill" dell'applet. Le esportazioni vengono preparate dal controllo di sicurezza e portabilità ph-skill-sharing sul dispositivo; ogni voce riporta l'esito della scansione lato dispositivo. Richiede il modulo ph-ai-agent E l'accesso 'open' per dispositivo (lo stesso requisito della pubblicazione).

Parametri

club `string` (obbligatorio) device `string` (obbligatorio)

GET /api/agent-skills/exports/{club}/{device}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/exports/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

{}

Pubblica un'esportazione di skill preparata come NUOVA skill condivisa (versione bozza)

Scarica tramite il tunnel il tarball dell'esportazione preparata indicata dal bridge del dispositivo, lo estrae in memoria (path traversal, link simbolici e dimensioni eccessive vengono rifiutati), esegue la scansione di sicurezza deterministica lato cloud, crea il manifest dal frontmatter di SKILL.md, archivia il tarball indirizzato per contenuto nel bucket privato delle skill e crea l'intestazione della skill + una versione BOZZA. Se la scansione blocca, non viene salvato NULLA e vengono restituiti i risultati. I destinatari sono limitati dagli ambiti dei ruoli di chi pubblica. Invia la bozza (POST submit) per pubblicarla.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/publish/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/publish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Pubblica un'esportazione preparata come NUOVA VERSIONE di una skill condivisa esistente

Stessa pipeline della pubblicazione, applicata a una skill esistente: il nome in SKILL.md dell'esportazione deve corrispondere alla skill, la versione deve essere nuova (le versioni sono immutabili) ed è obbligatorio un changelog. Solo chi ha pubblicato la skill può aggiungere versioni. Se la scansione blocca, viene salvata una riga di versione con stato 'rejected' (solo il report, nessun artefatto), così i risultati compaiono nella cronologia di chi pubblica.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/new-version/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/new-version/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Report di scansione completo (+ revisione LLM) per una versione della skill

L'elenco completo dei risultati per una versione, solo per chi pubblica e per gli amministratori dell'organizzazione (revisioni per l'approvazione); chi installa vede invece i conteggi riepilogativi nel dettaglio della skill.

Parametri

club `string` (obbligatorio) skillId `string` (obbligatorio) version `string` (obbligatorio)

GET /api/agent-skills/scan-report/{club}/{skillId}/{version}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/scan-report/{club}/{skillId}/{version} \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia una versione bozza della skill (pubblicazione o messa in coda per l'approvazione)

Fa avanzare una versione bozza secondo la governance dell'organizzazione. Se l'organizzazione ha attivato la revisione LLM, viene eseguita prima la revisione delle istruzioni (best-effort; un verdetto 'fail' rifiuta, un verdetto 'flag' impone la coda di approvazione). Le condivisioni a livello di struttura vengono pubblicate subito, a meno che la governance non richieda l'approvazione; le condivisioni nella libreria dell'organizzazione (destinatari a livello di brand o organizzazione) richiedono l'approvazione per impostazione predefinita. La pubblicazione imposta il latestVersion della skill: le installazioni con criterio 'auto' la recepiscono al successivo ciclo di riconciliazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/submit/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/submit/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ritira una skill condivisa (la rimuove dalla libreria)

Solo per chi pubblica. La skill sparisce subito dalla libreria e rifiuta nuove installazioni; le installazioni ESISTENTI continuano a funzionare: il ritiro riguarda solo l'elenco, non è un interruttore di disattivazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/delist/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/delist/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Modifica la scheda di una skill condivisa (nome visualizzato, descrizione, icona)

Solo per chi pubblica. Campi solo di presentazione: il nome canonico della skill ne costituisce l'identità (manifest, directory di installazione, corrispondenza delle versioni) e non cambia mai. Una stringa vuota riporta un campo a null (si torna al nome canonico o a nessuna icona). Le icone usano il catalogo MDI (mdi:icon-name), lo stesso formato delle app dell'agente pubblicate.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/update-listing/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/update-listing/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Trasferisci la proprietà di una skill condivisa

Rispecchia il flusso di trasferimento delle app pubblicate: chi ha pubblicato la skill o un proprietario dell'account (modulo di fatturazione) può cederla a un altro utente, che poi ne gestisce le versioni e la scheda. Il nuovo proprietario deve avere accesso alla struttura nel club di origine della skill.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/transfer-owner/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/transfer-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Libreria delle skill visibile in questa struttura (filtrata per destinatari)

Skill attive con almeno una versione pubblicata i cui destinatari includono questa struttura (o indicano chi visualizza), annotate con il riepilogo dell'ultima versione pubblicata e la diffusione nell'organizzazione (strutture distinte, mai il numero grezzo di installazioni). I destinatari vengono risolti di nuovo in tempo reale a ogni chiamata.

Parametri

club `string` (obbligatorio)

GET /api/agent-skills/library/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/library/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Dettaglio della skill (versioni, requisiti, riepilogo della scansione, diffusione)

Dettaglio completo di una skill della libreria: cronologia delle versioni con changelog e riepiloghi delle scansioni (gli elenchi di endpoint per versione alimentano il confronto delle scansioni negli aggiornamenti), requisiti dichiarati nel manifest, provenienza di chi pubblica e indicatore di diffusione basato sul numero di strutture. I destinatari vengono ricontrollati: chi non ha mai ricevuto la skill in condivisione non ottiene alcuna informazione (chi pubblica e gli amministratori dell'organizzazione la vedono sempre).

Parametri

club `string` (obbligatorio) skillId `string` (obbligatorio)

GET /api/agent-skills/skill/{club}/{skillId}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/skill/{club}/{skillId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Skill pubblicate da questa struttura (elenco di gestione di chi pubblica)

Righe complete delle skill la cui struttura di ORIGINE è questo club, ciascuna annotata con canManage per l'utente richiedente e con il riepilogo dell'ultima versione (incluse bozze e approvazioni in sospeso: è la vista di lavoro di chi pubblica).

Parametri

club `string` (obbligatorio)

GET /api/agent-skills/manage/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/manage/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Installa una skill della libreria sull'Agente AI di una struttura

Soggetto a governance: gli installSources dell'organizzazione devono consentirlo, i destinatari della skill devono includere questa struttura (o indicare il richiedente), la versione deve essere pubblicata e il richiedente deve soddisfare il livello whoCanInstall per il dispositivo di destinazione (proprietario / utente autorizzato / amministratore della struttura / amministratore dell'organizzazione; vedi governance). Scrive la riga del ciclo di vita dell'installazione (la fonte attendibile) ed esegue subito un invio best-effort; il cron di riconciliazione garantisce la consegna non appena il dispositivo è raggiungibile.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/install/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/install/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Approva un aggiornamento della skill in sospeso per un'installazione

Porta il desiredVersion dell'installazione all'ultima versione pubblicata (il passaggio manuale dei criteri 'notify' e 'pinned', e il percorso previsto quando la governance imposta updatePosture su 'approvalRequired'). Mantiene la versione corrente come destinazione del ripristino in un passaggio e rimuove l'eventuale blocco degli aggiornamenti successivo a un ripristino (skipVersion). Stesso livello di autorizzazione whoCanInstall dell'installazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/update-approve/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/update-approve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Riporta una skill installata alla versione precedente

Imposta desiredVersion sul previousVersion della riga di installazione (conservato a ogni cambio di versione) e lascia che il normale percorso di consegna la reinstalli. In un solo passaggio: le versioni si scambiano, quindi ripristinando due volte torni al punto di partenza. Blocca anche gli aggiornamenti (skipVersion = la versione da cui si è tornati indietro), così i criteri auto/notify mantengono il ripristino; il blocco si rimuove quando viene pubblicata una versione strettamente più recente, con update-approve o con set-policy.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/rollback/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/rollback/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Disinstalla una skill dall'Agente AI di una struttura

Contrassegna la riga di installazione come pending-uninstall e invia lo stato desiderato; la riga viene eliminata quando il dispositivo conferma la rimozione (verifica di riconciliazione). Stesso livello di autorizzazione whoCanInstall dell'installazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/uninstall/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/uninstall/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Imposta il criterio di aggiornamento per installazione di una skill su un dispositivo

auto (la riconciliazione applica automaticamente le nuove versioni pubblicate, a meno che l'updatePosture dell'organizzazione non richieda l'approvazione), notify (il proprietario riceve una notifica per ogni nuova versione e la applica manualmente) o pinned (non cambia mai senza un update-approve esplicito). La modifica del criterio rimuove l'eventuale blocco degli aggiornamenti successivo a un ripristino (skipVersion). Stesso livello di autorizzazione whoCanInstall dell'installazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/set-policy/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/set-policy/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Installazioni di skill sull'Agente AI di una struttura (scheda Skills)

Le righe del ciclo di vita delle installazioni per un dispositivo, ciascuna annotata con i campi della scheda della skill e con l'indicazione se esiste una versione pubblicata più recente. Richiede l'accesso 'open' per dispositivo (la scheda Skills si trova nel pannello dell'agente).

Parametri

club `string` (obbligatorio) device `string` (obbligatorio)

GET /api/agent-skills/installs/{club}/{device}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/installs/{club}/{device} \
  -H "x-api-key: YOUR_API_KEY"

{}

Versioni di skill in attesa di approvazione nell'organizzazione di questa struttura

La coda di approvazione degli amministratori dell'organizzazione: ogni versione in attesa di approvazione tra le skill dell'organizzazione, con la scheda della skill e i riepiloghi della scansione e della revisione LLM. Solo per gli amministratori dell'organizzazione.

Parametri

club `string` (obbligatorio)

GET /api/agent-skills/approvals/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/approvals/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Approva una versione di skill in sospeso (la pubblica)

Solo per gli amministratori dell'organizzazione. La versione viene pubblicata, il latestVersion della skill si aggiorna e chi l'ha pubblicata riceve una notifica. Le installazioni con criterio 'auto' recepiscono la versione al successivo ciclo di riconciliazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/approve/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/approve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Rifiuta una versione di skill in sospeso

Solo per gli amministratori dell'organizzazione. La versione viene rifiutata con la motivazione del revisore e chi l'ha pubblicata riceve una notifica: può correggere i problemi rilevati e inviare una nuova versione (le versioni sono immutabili).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/reject/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/reject/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Governance effettiva delle skill dell'agente per l'organizzazione di questa struttura

Il criterio salvato per l'organizzazione, unito alle impostazioni predefinite della piattaforma (un'organizzazione senza riga salvata vede solo le impostazioni predefinite). Solo per gli amministratori dell'organizzazione.

Parametri

club `string` (obbligatorio)

GET /api/agent-skills/governance/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agent-skills/governance/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la governance delle skill dell'agente per l'organizzazione di questa struttura

Aggiornamento parziale: cambiano solo i campi forniti; tutto il resto mantiene il valore salvato o predefinito. Solo per gli amministratori dell'organizzazione. Le sostituzioni per dispositivo si trovano nella riga di registrazione e si gestiscono tramite le route di configurazione del dispositivo esistenti.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/agent-skills/governance/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/governance/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni i dati ambientali di una struttura

Restituisce le condizioni meteo attuali, inclusi alba e tramonto (tramite Open-Meteo), e la temperatura interna della struttura (dai sensori Duress) per il club specificato. Memorizzato nella cache Redis per 30 minuti.

Parametri

clubId `string` (obbligatorio) ID interno del club o della struttura

GET /api/clubs/{clubId}/environment

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/environment \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiunge o associa un dispositivo IoT generico a un club.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo. body `string` (obbligatorio) Oggetto JSON del nuovo schermo da associare.

POST /api/devices/addGenericDevice/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/addGenericDevice/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Rimuovi un display screen e ripristinane le impostazioni di fabbrica

Rimuove l'associazione attiva dello schermo con la struttura e predispone un ripristino delle impostazioni di fabbrica persistente. Uno schermo spento applica il ripristino alla successiva accensione e riconnessione, poi torna alla pagina di associazione HDMI. I record storici di fatturazione vengono conservati.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/display-screens/reset/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/display-screens/reset/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Associa un controller per porte a una struttura.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/door-controllers/associate/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/associate/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Aggiorna le impostazioni del controller per porte di una struttura.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/door-controllers/update/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Dismette un controller per porte da una struttura.

Parametri

club `string` (obbligatorio)

POST /api/devices/door-controllers/decommission/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/door-controllers/decommission/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce la configurazione dei relè di un controller per porte.

Parametri

uuid `string` (obbligatorio)

GET /api/devices/door-controllers/config/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/door-controllers/config/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i metadati del dispositivo

Parametri

uuid `string` (obbligatorio) ID univoco del dispositivo

GET /api/devices/metadata/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/metadata/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i metadati del dispositivo. La risposta è la riga dei metadati al livello principale (formato legacy) più `detectedType` (camera | ai-edge-processor | door-controller | ph-ai-agent | null) e `online` (true se aggiornato negli ultimi 5 minuti).

Parametri

deviceSerialNumber `string` (obbligatorio) Numero di serie del dispositivo

GET /api/devices/metadata/serial/{serialNo}

curl -X GET https://portal.hub.gymsystems.co/api/devices/metadata/serial/{serialNo} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dati Smart Club del club.

Parametri

club_id `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo.

GET /api/clubs/{club_id}/smart-club-data

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club-data \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutti i dispositivi associati a un singolo club.

Parametri

club `string` (obbligatorio) ID interno del club di cui vuoi elencare i dispositivi.

GET /api/devices/list/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutte le release (versioni) delle applicazioni per i nostri dispositivi balena.

GET /api/devices/listReleases

curl -X GET https://portal.hub.gymsystems.co/api/devices/listReleases \
  -H "x-api-key: YOUR_API_KEY"

{}

Sposta un dispositivo in una nuova struttura (club) e aggiorna i sistemi correlati.

Parametri

club `string` (obbligatorio) ID della struttura di origine (il club in cui si trova attualmente il dispositivo) body `object` (obbligatorio) Parametri dello spostamento

POST /api/devices/move/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/move/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Tenta di stabilire una connessione con il router di una struttura selezionando il dispositivo più adatto all'interno del club e inviando un comando MQTT per creare un tunnel.

Parametri

facilityID `string` (obbligatorio) ID interno della struttura per cui si tenta la connessione al router.

GET /api/devices/openRouterWebpage/{facilityID}

curl -X GET https://portal.hub.gymsystems.co/api/devices/openRouterWebpage/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

{}

Catalogo dei Cloud Agent (zone, dimensioni, prezzi di vendita aggiornati)

Parametri

club `string` (obbligatorio)

GET /api/devices/ph-ai-agent/cloud/catalog/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/catalog/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Preventivo per un Cloud Agent (software + hosting)

POST /api/devices/ph-ai-agent/cloud/quote/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/quote/{club} \
  -H "x-api-key: YOUR_API_KEY"

Avvia un Cloud Agent (mette in coda il provisioning + associazione automatica)

POST /api/devices/ph-ai-agent/cloud/launch/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/launch/{club} \
  -H "x-api-key: YOUR_API_KEY"

Stato del processo del Cloud Agent

GET /api/devices/ph-ai-agent/cloud/jobs/{club}/{jobId}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/jobs/{club}/{jobId} \
  -H "x-api-key: YOUR_API_KEY"

Elimina definitivamente un Cloud Agent (VM + balena + registrazione)

POST /api/devices/ph-ai-agent/cloud/delete/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/delete/{club} \
  -H "x-api-key: YOUR_API_KEY"

Risolvi una rimozione di un Cloud Agent in sospeso (riprova il backup, elimina senza backup o annulla)

POST /api/devices/ph-ai-agent/cloud/delete-decision/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/cloud/delete-decision/{club} \
  -H "x-api-key: YOUR_API_KEY"

Elenca le Connected Apps di un agente (suite + app con account collegati)

Restituisce lo stato delle Connected Apps dell'agente: il flag di attivazione, i riepiloghi per suite (Google Workspace, Microsoft 365) e il catalogo selezionato di app con gli account collegati di ciascuna (multi-account: un agente può avere più account per app, ciascuno con un alias facoltativo), risolti dalla sessione upstream dell'agente.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Catalogo completo del marketplace delle Connected Apps per un agente

Restituisce ogni app collegabile (il catalogo completo dei toolkit con autenticazione gestita, memorizzato nella cache lato server per circa 12 ore) con i livelli in evidenza e suite e gli account collegati dell'agente per ogni app, più i riepiloghi per suite e le richieste di collegamento in sospeso dell'agente: un unico payload per il marketplace delle app con ricerca lato client.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/catalog

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/catalog \
  -H "x-api-key: YOUR_API_KEY"

{}

Ignora una richiesta di collegamento dell'agente in sospeso

Contrassegna come ignorata la richiesta di collegamento in sospeso dell'agente per un toolkit (scompare dalla sezione "Requested by your agent" del marketplace). Idempotente: ignorare una richiesta non in sospeso non ha alcun effetto.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/requests/dismiss

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/requests/dismiss \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Attiva o disattiva le Connected Apps per un agente

Salva l'interruttore delle Connected Apps dell'agente e invia la variabile di dispositivo Balena PH_APPS_MCP_ENABLED solo a quel dispositivo (best-effort: il vero blocco sul relay MCP è il flag lato PH).

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/enable

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/enable \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Avvia il collegamento di una singola app a un agente (flusso OAuth Connect Link)

Avvia un flusso Connect Link ospitato per un toolkit e restituisce l'URL a cui indirizzare l'utente. Un alias facoltativo identifica il nuovo account (multi-account: collegare un'app già collegata aggiunge UN ALTRO account, fino a 10 per app). Usa lo stesso callback a catena dei collegamenti di suite (una suite con un solo toolkit), quindi al termine si torna alla pagina dell'applet ph-ai-agent.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Payload di preparazione al collegamento per un'app (modalità, campi delle credenziali, guida alla configurazione)

Tutto ciò che serve alla finestra di collegamento prima di avviare una connessione: come si collega l'app (oauth = flusso di consenso ospitato, credentials = modulo nel prodotto), i campi delle credenziali da raccogliere in modalità credentials e la guida alla configurazione nel prodotto (scritta per le app prioritarie, altrimenti generata dai metadati dei campi dell'app, mai un link a documentazione esterna). Le app OAuth bring-your-own indicano anche se l'app OAuth del cliente è già registrata per QUESTO agente (byoConfigured) e l'URL di reindirizzamento da registrare presso il provider.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente. toolkit `string` (obbligatorio)

GET /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-info/{toolkit}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-info/{toolkit} \
  -H "x-api-key: YOUR_API_KEY"

{}

Collega un'app con credenziali fornite dall'utente (chiave API e così via, senza OAuth)

Crea un account collegato per un'app in modalità credentials direttamente dal modulo nel prodotto, senza flusso di consenso ospitato. I campi delle credenziali provengono dal payload connect-info dell'app; tutti i campi obbligatori devono essere forniti. Le credenziali vengono convalidate con il provider, se supportato (best-effort: alcune app rifiutano una chiave errata solo alla prima chiamata a uno strumento da parte dell'agente). Un alias facoltativo identifica il nuovo account (multi-account: collegare un'app già collegata aggiunge UN ALTRO account).

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-credentials

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-credentials \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Registra l'app OAuth del cliente per un'app BYO e avvia il relativo flusso di collegamento

Per le app OAuth bring-your-own (Xero, Shopify, ...): prende il client ID e il client secret dell'app OAuth che il cliente ha creato presso il provider (seguendo la guida alla configurazione dell'app), la registra per QUESTO agente (il secret viene salvato solo presso la piattaforma di integrazione upstream, mai in Performance Hub) e avvia subito il flusso di accesso ospitato con quell'app. Restituisce l'URL di consenso a cui indirizzare l'utente, con lo stesso contratto dell'endpoint di collegamento. Un nuovo invio sostituisce l'app registrata dell'agente (ad es. dopo la rotazione del secret): gli account collegati esistenti continuano a funzionare.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-oauth-app

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-oauth-app \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Avvia il collegamento con un clic di una suite per un agente (flussi Connect Link a catena)

Avvia il flusso di collegamento a catena per un'intera suite (ad es. google-workspace). L'URL restituito apre la schermata di consenso del primo toolkit; ogni completamento reindirizza con un 302 direttamente al flusso del toolkit successivo, terminando sulla pagina dell'applet ph-ai-agent. I membri che hanno già un account collegato vengono SALTATI, quindi riprovando dopo un errore a metà catena si riprende dalle app mancanti invece di creare account duplicati. Quando tutti i membri sono già collegati, l'intera catena viene eseguita di nuovo: è il flusso esplicito "aggiungi un altro account".

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-suite

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/connect-suite \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Scollega un account collegato da un agente

Elimina un singolo account collegato (multi-account: gli altri account della stessa app restano collegati). Prima dell'eliminazione si verifica che l'account appartenga a questo agente; se era l'ULTIMO account dell'app, il toolkit viene rimosso dall'insieme collegato dell'agente (la sessione viene ricreata in modo differito, così l'elenco degli strumenti dell'agente si aggiorna).

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/disconnect

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/disconnect \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Rinomina (cambia l'alias di) uno degli account collegati di un agente

Imposta l'alias visualizzato di un singolo account collegato. Gli alias vengono normalmente impostati in automatico dopo OAuth (in base all'identità che ha effettuato l'accesso); questo endpoint supporta la ridenominazione manuale nella finestra dei dettagli dell'app. Un alias vuoto cancella l'etichetta. Prima dell'aggiornamento upstream si verifica che l'account appartenga a questo agente.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente.

Corpo della richiesta

POST /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/rename-account

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/rename-account \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Attiva o disattiva un servizio integrato di Performance Hub per un agente

Attiva o disattiva per questo agente un servizio integrato sempre attivo (Smart Search, Weather, ...). I servizi integrati non richiedono collegamento né OAuth: sono inclusi in ogni agente e attivi per impostazione predefinita; questo interruttore salva l'impostazione specifica per l'agente e ricrea subito la sessione upstream dell'agente, così l'insieme degli strumenti si aggiorna. Nota che l'interruttore separato "External apps" (la route /enable) disattiva completamente l'intero server MCP delle app: quando è disattivato, anche i servizi integrati non sono disponibili, indipendentemente dai singoli interruttori.

Parametri

facilityId `string` (obbligatorio) deviceId `string` (obbligatorio) Il balena UUID del dispositivo dell'agente. slug `string` (obbligatorio) Slug del servizio integrato.

Corpo della richiesta

PATCH /api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/built-in/{slug}

curl -X PATCH https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/connected-apps/{facilityId}/{deviceId}/built-in/{slug} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Associa un dispositivo Agente AI a una struttura

Associazione basata prima sui metadati. Cerca il dispositivo per numero di serie nei metadati in tempo reale dei dispositivi, richiede che sia online, poi crea la riga di registrazione se necessario, assegna una regione di relay Chisel + porta del tunnel + secret, registra quello slot sul relay e invia al dispositivo la configurazione della struttura e del tunnel tramite Balena. Ai nuovi dispositivi viene inoltre assegnato un account di servizio MCP predefinito (attivo, limitato a questa struttura, con tutte le funzionalità); una nuova associazione mantiene qualsiasi autorizzazione MCP esistente. Le impostazioni avanzate facoltative sostituiscono i valori predefiniti applicati al momento dell'associazione (configurazione del backup, MCP attivo/disattivo, restrizione di accesso) e `restoreFrom` inizializza il nuovo dispositivo dal backup cloud di un altro dispositivo della struttura (origine attiva o dismessa; mette in coda un ripristino tra repository, restituito come `restoreRequest` per monitorarne l'avanzamento).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/associate/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/associate/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenca i dispositivi Agente AI di una struttura

Restituisce i dispositivi Agente AI della struttura con lo stato online e del tunnel in tempo reale (usato dal selettore di dispositivi dell'applet).

Parametri

club `string` (obbligatorio)

GET /api/devices/ph-ai-agent/list/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiornamento + stato online dell'Agente AI

Indica se il dispositivo è online, se è disponibile o in sospeso un aggiornamento e la release proposta (la versione fissata per la flotta, se la flotta è fissata; la più recente installata correttamente, se la flotta segue l'ultima versione).

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/update-status/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-status/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Stato in tempo reale + metriche del dispositivo Agente AI

Restituisce un'istantanea selezionata per la barra delle metriche e il pannello di gestione dell'applet: campi di identità + registrazione, attività + connessione, versioni software e le ultime metriche dell'heartbeat (CPU, temperatura, memoria, archiviazione per punto di montaggio, tempo di attività, rete). Unisce il beacon dei metadati del dispositivo + lo stato di aggiornamento Balena; una delle due parti può mancare in caso di interruzione temporanea.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/device-status/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/device-status/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Descrizione generata dall'AI per il report sullo stato del dispositivo

Restituisce una breve spiegazione, destinata all'operatore, dei problemi di stato attualmente rilevati. I fatti e i passaggi della procedura sono sempre in device-status; questo paragrafo aggiuntivo è best-effort e può essere null.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

POST /api/devices/ph-ai-agent/health/{club}/{uuid}/explain

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/health/{club}/{uuid}/explain \
  -H "x-api-key: YOUR_API_KEY"

{}

Genera un token di accesso diretto al relay per un Agente AI

Restituisce un URL firmato di breve durata che il browser usa per connettersi DIRETTAMENTE al gateway relay regionale del dispositivo (evitando il passaggio globale da PH/Sydney), più il token HS256. PH resta l'autorità (Google SSO + controlli di modulo e struttura qui); il relay-gateway verifica il token. Il proxy /ai-agent-ui resta l'alternativa.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/access/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Invia un messaggio di chat in una sessione dell'Agente AI (risposta diretta dalla notifica)

Relay lato server usato dall'azione di risposta diretta della notifica web push: il service worker invia qui un POST (stessa origine, cookie SSO), così la risposta funziona anche senza schede di Performance Hub aperte. PH risolve la destinazione relay del dispositivo (stessa ricerca del proxy /ai-agent-ui), imposta x-ph-user per l'attribuzione del turno (la notifica push di completamento torna a questo utente) e inoltra a /api/chat/start del dispositivo con l'ID della sessione.

Corpo della richiesta

POST /api/devices/ph-ai-agent/reply

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reply \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Leggi le impostazioni di controllo degli accessi di un Agente AI (proprietario)

Restituisce il blocco di accesso del dispositivo (modalità, allowlist, visibilità, interruttore dell'assistenza PH) più le eventuali richieste di accesso in sospeso. Leggibile dal proprietario del dispositivo; gli altri utenti ricevono 403.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/access-settings/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-settings/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le impostazioni di controllo degli accessi di un Agente AI (proprietario)

Scrittura della modalità (org/restricted), dell'allowlist con restrizioni, della visibilità dell'elenco (all/admins) e dell'interruttore "Permit access from Performance Hub Support". Consentita al proprietario del dispositivo. Il proprietario stesso si può cambiare solo tramite reallocate-owner. Le richieste di accesso approvate sono persistenti: i richiedenti ancora approvati vengono aggiunti di nuovo all'allowlist salvata; rimuoverne uno dall'elenco inviato ne revoca l'approvazione (la richiesta passa a rifiutata; potrà richiedere di nuovo).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/access-settings/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-settings/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Riassegna il proprietario di un Agente AI

Riassegna la proprietà del dispositivo a un altro utente di Performance Hub. Riservato ai proprietari dell'account (accesso al modulo di fatturazione SaaS): la soluzione di emergenza quando il proprietario di un agente con restrizioni lascia l'organizzazione. Ricevono una notifica sia il proprietario precedente sia quello nuovo (in-app + push + email).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/reallocate-owner/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reallocate-owner/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenco degli utenti della struttura per i selettori dell'allowlist e del proprietario dell'Agente AI

Restituisce email + nome (+ flag isOrgAdmin) di ogni utente il cui ruolo dà accesso a QUESTA struttura. Riservato al proprietario del dispositivo e a chi può riassegnarlo (proprietario dell'account), così gli utenti normali non possono elencare la base utenti.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/org-users/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/org-users/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Richiedi l'accesso a un Agente AI con restrizioni

Crea (o riapre) la richiesta di accesso del richiedente per un dispositivo con restrizioni; idempotente per utente+dispositivo. Il proprietario riceve una notifica in-app, web push ed email con un deep link al modulo dell'agente.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/access-request/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-request/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Approva o rifiuta una richiesta di accesso a un Agente AI (proprietario)

Gestione di una richiesta in sospeso da parte del proprietario del dispositivo. L'approvazione aggiunge il richiedente all'allowlist del dispositivo; in entrambi i casi il richiedente riceve una notifica (in-app + push + email).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/access-request-resolve/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/access-request-resolve/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Consenti + applica un aggiornamento dell'Agente AI

Fissa il dispositivo sulla release proposta (la versione fissata per la flotta o, se la flotta segue l'ultima versione, la più recente installata correttamente) e rilascia il blocco degli aggiornamenti, così il supervisor balena la applica. Lo stato sul volume dati del dispositivo viene mantenuto dopo l'aggiornamento.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/update/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Pianifica un aggiornamento dell'Agente AI per più tardi

Salva un orario di installazione pianificato nella registrazione del dispositivo. Un processo di backend ricorrente (ogni 5 minuti) applica l'aggiornamento (fissaggio + sblocco) una volta superato l'orario pianificato. La pianificazione sostituisce qualsiasi pianificazione esistente per il dispositivo.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/update-schedule/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-schedule/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Annulla un aggiornamento pianificato dell'Agente AI

Cancella l'installazione pianificata in sospeso per il dispositivo (nessun effetto se non c'è nulla di pianificato).

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

DELETE /api/devices/ph-ai-agent/update-schedule/{club}/{uuid}

curl -X DELETE https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/update-schedule/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Esegui un comando remoto su un dispositivo Agente AI

Pubblica un comando MQTT consentito (riavvio, riavvio di un container, blocco/sblocco degli aggiornamenti, gestione del Wi-Fi) al device-controller in esecuzione sull'Agente AI. Il dispositivo deve essere associato alla struttura.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/command/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/command/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Aggiorna la configurazione di un Agente AI relativa alla struttura

Salva le impostazioni modificabili dall'operatore per un Agente AI associato: il nome del dispositivo, la posizione fisica del dispositivo e la cadenza del riavvio programmato. La pianificazione del riavvio viene inviata anche al dispositivo come variabile d'ambiente Balena REBOOT_DEVICE (alle 2 ora locale), in linea con il comportamento di Display Screens.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/config/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/config/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Strutture in cui è possibile spostare un Agente AI di questa struttura

Restituisce le strutture della stessa organizzazione a cui l'utente connesso può accedere (esclusa la struttura corrente), per il selettore "Sposta in un'altra struttura". Lo spostamento vero e proprio viene eseguito da POST /api/devices/move/:club, che applica lato server le stesse regole su stessa organizzazione e accesso alla destinazione.

Parametri

club `string` (obbligatorio)

GET /api/devices/ph-ai-agent/move-targets/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/move-targets/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

L'insieme di accessi MCP che il richiedente può concedere agli Agenti AI di una struttura

Restituisce ciò che l'utente connesso può concedere a un account di servizio MCP di un Agente AI nell'organizzazione di questa struttura: le strutture/regioni rientranti nel proprio accesso, se può concedere un ambito a livello di organizzazione, l'insieme dei moduli di cui dispone e il catalogo completo degli strumenti MCP (per la maschera avanzata per singolo strumento). L'interfaccia lo usa affinché gli utenti vedano solo opzioni comprese nelle proprie autorizzazioni; l'endpoint POST mcp-access applica la stessa attenuazione lato server.

Parametri

club `string` (obbligatorio)

GET /api/devices/ph-ai-agent/mcp-grantable/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-grantable/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni la configurazione dell'account di servizio MCP di un Agente AI

Restituisce la configurazione di accesso MCP del dispositivo (ambito, moduli, maschera degli strumenti, campi di audit).

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/mcp-access/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-access/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Configura l'account di servizio MCP di un Agente AI

Salva la configurazione di accesso MCP del dispositivo con attenuazione al momento della concessione. I richiedenti possono concedere solo strutture/regioni rientranti nel proprio accesso, l'ambito di organizzazione solo se hanno un ruolo a livello di organizzazione e solo i moduli di cui dispongono nell'organizzazione della struttura. Il flag enabled viene inviato anche al dispositivo come variabile d'ambiente Balena PH_MCP_ENABLED.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/mcp-access/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/mcp-access/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni la configurazione VPN di un Agente AI (oscurata)

Restituisce il flag di supporto VPN del dispositivo e l'elenco delle connessioni. Il contenuto dei profili e i valori delle credenziali non vengono mai restituiti: solo i metadati dell'importazione (remote, route, DNS) e i flag che indicano la presenza di credenziali. Lo stato in tempo reale di ogni connessione proviene dall'endpoint device-status (beacon metadata.vpn).

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/vpn-config/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Attiva o disattiva il supporto VPN di un Agente AI

Attiva/disattiva la funzionalità VPN del dispositivo. Invia la variabile di dispositivo balena PH_VPN_ENABLED e sollecita il dispositivo (MQTT vpnConfigChanged); quando la funzionalità viene disattivata le connessioni vengono mantenute (i tunnel si arrestano; la configurazione resta per la riattivazione).

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/vpn-config/{club}/{uuid}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Importa uno o più profili OpenVPN su un Agente AI

Accetta caricamenti codificati in base64: singoli file .ovpn/.conf, pacchetti a file separati (configurazione + certificati/chiavi) e archivi (.zip, esportazioni Pritunl .tar/.tgz, Tunnelblick .tblk, Viscosity .visc/.visz). I profili vengono normalizzati in una forma inline canonica; ogni profilo diventa una connessione (importata disconnessa: inserisci le credenziali, poi connetti). Restituisce errori 400 utili per i caricamenti non utilizzabili.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/vpn-import/{club}/{uuid}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-import/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Aggiorna una connessione VPN di un Agente AI (nome / credenziali / split DNS)

Aggiorna la connessione salvata. I campi delle credenziali sono di sola scrittura (omesso = mantieni il valore salvato; stringa vuota = cancella). Le modifiche a credenziali/split DNS incrementano la revisione della connessione, in modo che un tunnel attivo si riavvii con i nuovi valori.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-connection/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elimina una connessione VPN di un Agente AI

Rimuove la connessione dalla registrazione e sollecita il dispositivo, che chiude il tunnel ed elimina il profilo e le credenziali in cache.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) connectionId `string` (obbligatorio)

DELETE /api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}/{connectionId}

curl -X DELETE https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-connection/{club}/{uuid}/{connectionId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Connetti / disconnetti una connessione VPN di un Agente AI

Modello a stato desiderato: imposta il flag enabled della connessione nella registrazione e sollecita il dispositivo (MQTT vpnConfigChanged senza payload); il dispositivo recupera lo stato autorevole tramite la sua chiamata universal-api autenticata con JWT e riallinea i propri tunnel. Una sollecitazione persa viene recuperata con la sincronizzazione periodica.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/vpn-command/{club}/{uuid}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/vpn-command/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni la configurazione e lo stato del backup cloud di un Agente AI

Restituisce le impostazioni di backup del dispositivo (abilitazione, conservazione, regione di archiviazione), lo stato del backup continuo (ultimo backup, dimensione, errori), la regione automatica risolta e le regioni di archiviazione disponibili per il selettore. La password del repository restic non viene mai restituita.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-config/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-config/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione del backup cloud di un Agente AI

Salva abilitazione/conservazione/regione. Ha effetto al successivo ciclo di backup orario del dispositivo (il dispositivo chiede a PH il contesto di esecuzione prima di ogni esecuzione), quindi non è necessario riavviare il dispositivo.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/backup-config/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-config/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenca le origini di ripristino dei backup per l'associazione di un nuovo Agente AI

Vista a livello di struttura per l'opzione "ripristina da un backup" della finestra di aggiunta dell'agente: ogni registrazione della struttura, attiva E dismessa/sostituita, che ha ancora un repository di backup decifrabile e almeno un punto di ripristino utilizzabile, con i suoi snapshot più recenti. Restituisce anche gli elenchi di opzioni della configurazione di backup (allowedRetentionDays, availableRegions), così la finestra non ha bisogno dell'UUID di un dispositivo per popolare i suoi selettori.

Parametri

club `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-sources/{club}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-sources/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca i punti di ripristino dei backup di un Agente AI

Restituisce l'indice degli snapshot del dispositivo (dal più recente) da DynamoDB, senza passaggi sul dispositivo o sul repository, più lo stato corrente delle richieste di backup manuale / ripristino per il polling del pannello. Le richieste obsolete (mai prese in carico o senza heartbeat di avanzamento) vengono presentate come non riuscite, così l'interfaccia può sempre inviarne una nuova.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-snapshots/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-snapshots/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Richiedi subito un backup manuale di un Agente AI

Scrive una richiesta di esecuzione manuale (con la nota dell'utente) nella riga della registrazione e sollecita il dispositivo tramite MQTT. Il dispositivo recupera la richiesta verificata tramite la sua chiamata run-context universal-api autenticata con JWT: anche senza MQTT, la richiesta viene presa in carico al successivo ciclo dello scheduler. Viene rifiutata mentre è in corso un altro backup o ripristino.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/backup-run/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-run/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Fissa o sblocca un punto di ripristino di un Agente AI

I punti di ripristino fissati sono protetti dall'eliminazione per conservazione: la manutenzione notturna del dispositivo riceve gli ID degli snapshot fissati tramite la chiamata run-context e li esclude da restic forget, e le relative righe di indice non scadono mai per TTL. Rimuovendo il fissaggio si ripristina il normale comportamento di conservazione.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/backup-pin/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-pin/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ripristina un Agente AI da un punto di ripristino del backup

Scrive una richiesta di ripristino nella riga della registrazione e sollecita il dispositivo. I ripristini completi sovrascrivono /data e /home/hermeswebui (il dispositivo crea prima uno snapshot di sicurezza automatico pre-ripristino e arresta l'agente durante il ripristino) e richiedono di digitare il nome del dispositivo come conferma. Passando `paths` viene invece eseguito un ripristino non invasivo a livello di file solo di quei percorsi. Facoltativamente, al termine del ripristino dei dati, fissa il dispositivo alla release software dello snapshot (vedi backup-restore-release).

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/backup-restore/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-restore/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Applica la release software registrata in un ripristino completato

Passaggio finale di un ripristino che ha richiesto la versione software dello snapshot: quando il dispositivo segnala il completamento del ripristino dei dati, fissa il dispositivo alla release salvata e sblocca gli aggiornamenti (stesso meccanismo dell'endpoint di aggiornamento). Viene attivato dal polling del pannello; è idempotente: il fissaggio salvato viene cancellato una volta applicato.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/backup-restore-release/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-restore-release/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Sfoglia i file all'interno di un punto di ripristino del backup

Elenca un livello di directory di uno snapshot restic, servito interamente lato server dal repository Wasabi (funziona con il dispositivo offline). Vengono letti solo i metadati dell'albero: per gli elenchi non viene scaricato alcun dato dei file.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) takenAt `number` (obbligatorio) path `string` (facoltativo)

GET /api/devices/ph-ai-agent/backup-files/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-files/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca nomi di file all'interno di un punto di ripristino del backup

Ricerca di nomi di file senza distinzione tra maiuscole e minuscole a partire da una directory, servita lato server dai metadati dell'albero restic (non viene letto alcun dato dei file; funziona con il dispositivo offline). Trasmette l'elenco in streaming e si ferma alle prime 200 corrispondenze.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) takenAt `number` (obbligatorio) q `string` (obbligatorio) path `string` (facoltativo)

GET /api/devices/ph-ai-agent/backup-search/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-search/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Cosa è cambiato tra due punti di ripristino del backup

Esegue lato server un restic diff tra due snapshot del dispositivo (solo metadati dell'albero) e restituisce l'elenco dei file aggiunti/rimossi/modificati (fino a un massimo di 500 modifiche) più statistiche di riepilogo. I risultati vengono memorizzati nella cache: gli snapshot sono immutabili.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) fromTakenAt `number` (obbligatorio) toTakenAt `number` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-diff/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-diff/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Cronologia delle versioni di un file in tutti i punti di ripristino

Un unico restic find lato server su tutti gli snapshot del repository del dispositivo, ridotto alle versioni DISTINTE (i risultati consecutivi con dimensione+mtime identici vengono uniti) e collegato alle righe dell'indice degli snapshot per date/tipi/note.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) path `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-file-versions/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-file-versions/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca per nome di file in tutti i punti di ripristino dei backup di un dispositivo

Il percorso di recupero dei file eliminati: un unico restic find lato server su TUTTI gli snapshot del repository (senza distinzione tra maiuscole e minuscole, per sottostringa o glob), raggruppato per percorso con i punti di ripristino in cui compare ciascun file. Un file eliminato dal dispositivo è ancora reperibile qui finché un punto di ripristino lo contiene.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) q `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-find/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-find/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Scarica un singolo file da un punto di ripristino del backup

Trasmette un file direttamente dal repository restic al browser (come allegato). Le directory vengono trasmesse come archivio tar. Con limite di dimensione; servito lato server, quindi funziona con il dispositivo offline.

Parametri

club `string` (obbligatorio) uuid `string` (obbligatorio) takenAt `number` (obbligatorio) path `string` (obbligatorio)

GET /api/devices/ph-ai-agent/backup-file-download/{club}/{uuid}

curl -X GET https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/backup-file-download/{club}/{uuid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Dismetti un Agente AI da una struttura

Parametri

club `string` (obbligatorio)

POST /api/devices/ph-ai-agent/decommission/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/decommission/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Rimuovi un Agente AI da una struttura e ripristina le impostazioni di fabbrica dell'hardware

Dissocia completamente il dispositivo, in modo che possa essere associato a QUALSIASI struttura, e cancella tutti i dati sul NUC. La cancellazione viene predisposta tramite la variabile di dispositivo balena PH_FACTORY_RESET (un nonce monouso) PRIMA della rimozione nel cloud, quindi funziona anche se il dispositivo è offline al momento della rimozione: la cancellazione viene eseguita alla successiva connessione. Una sollecitazione MQTT factoryReset rende immediato il caso online. La rimozione nel cloud revoca poi ogni credenziale e concessione, cancella il collegamento della struttura in Balena (variabili del dispositivo + tag club) e il clubID dei metadati, elimina le richieste di accesso e il record DNS della LAN. I backup cloud vengono CONSERVATI: l'indice degli snapshot e la password del repository restano nella registrazione eliminata in modo reversibile, utilizzabili come origine di ripristino quando si aggiunge un sostituto. Richiede di digitare il nome del dispositivo come conferma.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/reset/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/reset/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Sostituisci un Agente AI guasto con un nuovo NUC (ripristino di emergenza)

Sostituzione del dispositivo in un unico passaggio: associa il NUC sostitutivo (slot del tunnel, segreti, variabili balena, seed del backup), trasferisce nome, posizione, pianificazione del riavvio, impostazioni di backup, blocco degli accessi e concessione MCP del vecchio dispositivo, ricollega l'indice degli snapshot precedente al nuovo dispositivo (così l'intera cronologia dei backup resta consultabile), dismette la vecchia registrazione (contrassegnata con replacedBy / replacedFrom) e, a meno che `restore` sia false, accoda un ripristino completo del punto di ripristino scelto dal repository di backup del VECCHIO dispositivo sul nuovo hardware. Funziona con il vecchio dispositivo guasto/offline; richiede di digitare il nome del vecchio dispositivo come conferma. Solo all'interno della stessa struttura.

Parametri

club `string` (obbligatorio)

Corpo della richiesta

POST /api/devices/ph-ai-agent/replace/{club}

curl -X POST https://portal.hub.gymsystems.co/api/devices/ph-ai-agent/replace/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Risolve un link breve del codice QR di un dispositivo Performance Hub nel deep link a cui punta, così lo scanner di Aggiungi dispositivo può rilevare il tipo di dispositivo. Vengono seguiti solo gli host performancehub.co.

Parametri

url `string` (obbligatorio) Il link breve scansionato

GET /api/devices/resolve-qr

curl -X GET https://portal.hub.gymsystems.co/api/devices/resolve-qr \
  -H "x-api-key: YOUR_API_KEY"

{}

Verifica la connettività con l'Unifi Controller di una struttura e la correttezza delle credenziali.

Parametri

facilityID `string` (obbligatorio) ID interno della struttura con cui vuoi verificare la connettività Unifi

GET /api/devices/testUnifiController/{facilityID}

curl -X GET https://portal.hub.gymsystems.co/api/devices/testUnifiController/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna un dispositivo IoT generico con una struttura.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

PUT /api/devices/updateGenericDevice/{club}

curl -X PUT https://portal.hub.gymsystems.co/api/devices/updateGenericDevice/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca il numero di accordi in sospeso che richiedono un'azione, in base a un utente e ai club a esso associati

GET /api/agreements/agreements-outstanding

curl -X GET https://portal.hub.gymsystems.co/api/agreements/agreements-outstanding \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca tutti gli accordi disponibili per un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. contracts-sort `string` (facoltativo) Ordina gli accordi per date-effective o alphabetical. Il valore predefinito è date-effective. contracts-acknowledgement `string` (facoltativo) Filtra gli accordi per all, acknowledged o unacknowledged. Il valore predefinito è all. contracts-requirement `string` (facoltativo) Filtra gli accordi per all, signature, checkbox, popup o none. Il valore predefinito è all. contracts-status `string` (facoltativo) Filtra gli accordi per all, active o archived. Il valore predefinito è all.

GET /api/agreements/list-agreements/{club}

curl -X GET https://portal.hub.gymsystems.co/api/agreements/list-agreements/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Firma un accordo in base al suo ID.

Parametri

club `string` (obbligatorio) ID interno del club che firma l'accordo. agreementid `string` (obbligatorio) ID dell'accordo da firmare. body `string` (obbligatorio) Oggetto JSON contenente l'accordo e i parametri da aggiungere o caricare nel sistema...

POST /api/agreements/sign/{club}/{agreementid}

curl -X POST https://portal.hub.gymsystems.co/api/agreements/sign/{club}/{agreementid} \
  -H "x-api-key: YOUR_API_KEY"

{}

Riepilogo del Model Router della struttura (configurazione, saldo, spesa).

Parametri

clubID `string` (obbligatorio) tz `string` (facoltativo) Fuso orario IANA di chi visualizza: usato in alternativa per gli intervalli di spesa giornalieri e mensili quando la struttura non ha dati sul fuso orario.

GET /api/clubs/{clubID}/ai-credits/overview

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/overview \
  -H "x-api-key: YOUR_API_KEY"

{}

Catalogo dei modelli disponibili con lo stato di attivazione per struttura (per impostazione predefinita tutti attivi).

Parametri

clubID `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/models

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/models \
  -H "x-api-key: YOUR_API_KEY"

{}

Guardrail disponibili e modelli predefiniti di PH.

Parametri

clubID `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/guardrails

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/guardrails \
  -H "x-api-key: YOUR_API_KEY"

{}

Servizi del Model Router connessi. Include i dispositivi Agente AI associati, gli agenti esterni con tipo esplicito e il servizio Workflow della struttura. La configurazione si modifica tramite PATCH /keys/{keyHash}.

Parametri

clubID `string` (obbligatorio) tz `string` (facoltativo) Fuso orario IANA di chi visualizza: usato in alternativa per gli intervalli di spesa giornalieri e mensili quando la struttura non ha dati sul fuso orario.

GET /api/clubs/{clubID}/ai-credits/agents

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/agents \
  -H "x-api-key: YOUR_API_KEY"

{}

Attiva il Model Router per una struttura e predisponi il suo accesso all'inferenza.

Parametri

clubID `string` (obbligatorio)

POST /api/clubs/{clubID}/ai-credits/enable

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/enable \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna piano, allowlist dei modelli, guardrail, filtri dei contenuti (oscuramento o blocco tramite regex lato PH), limite di spesa e configurazione della ricarica automatica.

Parametri

clubID `string` (obbligatorio)

PATCH /api/clubs/{clubID}/ai-credits/config

curl -X PATCH https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/config \
  -H "x-api-key: YOUR_API_KEY"

{}

Azzera il contatore del limite massimo complessivo (riallineandolo alla spesa attuale) e registra il periodo chiuso nella cronologia.

Parametri

clubID `string` (obbligatorio)

POST /api/clubs/{clubID}/ai-credits/spend-limit/reset-total

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/spend-limit/reset-total \
  -H "x-api-key: YOUR_API_KEY"

{}

Cronologia degli azzeramenti del limite massimo (dal più recente): limite, spesa e timestamp per ogni periodo chiuso.

Parametri

clubID `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/spend-limit/history

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/spend-limit/history \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea una nuova chiave API phk_ per la struttura (il testo in chiaro viene restituito una sola volta). Accetta, facoltativamente, limiti di spesa, allowlist dei modelli, guardrail, filtri dei contenuti e limiti di frequenza rpmLimit/tpmLimit.

Parametri

clubID `string` (obbligatorio)

POST /api/clubs/{clubID}/ai-credits/keys

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/keys \
  -H "x-api-key: YOUR_API_KEY"

Aggiorna i campi modificabili della chiave: etichetta, limiti di spesa per chiave, allowlist dei modelli, guardrail, filtri dei contenuti e limiti di frequenza rpmLimit/tpmLimit (sincronizzati con la chiave).

Parametri

clubID `string` (obbligatorio) keyHash `string` (obbligatorio)

PATCH /api/clubs/{clubID}/ai-credits/keys/{keyHash}

curl -X PATCH https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/keys/{keyHash} \
  -H "x-api-key: YOUR_API_KEY"

{}

Registri di inferenza per richiesta della struttura (in tempo reale, solo metadati).

Parametri

clubID `string` (obbligatorio) page `string` (facoltativo) pageSize `string` (facoltativo) status `string` (facoltativo) model `string` (facoltativo) provider `string` (facoltativo) source `string` (facoltativo) `key` o `agent` keyHash `string` (facoltativo) Filtra un singolo agente o chiave in base al suo keyHash PH. q `string` (facoltativo) Ricerca a testo libero su ID richiesta, etichetta della chiave o dell'agente, modello, provider, utente finale. minutes `string` (facoltativo) Intervallo inferiore a un giorno (ad es. Live=1440); sostituisce startDate/endDate. startTs `string` (facoltativo) Inizio dell'intervallo in secondi epoch (clic per ingrandire); sostituisce minuti e date. endTs `string` (facoltativo) Fine dell'intervallo in secondi epoch (clic per ingrandire); sostituisce minuti e date.

GET /api/clubs/{clubID}/ai-credits/logs

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/logs \
  -H "x-api-key: YOUR_API_KEY"

{}

Istogramma delle richieste nel tempo per la vista Logs. Stessi filtri della route di elenco, ma aggregati lato server in intervalli di tempo (conteggi di successi e errori), così la risposta resta minima indipendentemente dal volume dei registri. La dimensione degli intervalli viene scelta automaticamente in base al periodo.

Parametri

clubID `string` (obbligatorio) status `string` (facoltativo) model `string` (facoltativo) provider `string` (facoltativo) source `string` (facoltativo) keyHash `string` (facoltativo) q `string` (facoltativo) minutes `string` (facoltativo) startDate `string` (facoltativo) endDate `string` (facoltativo) startTs `string` (facoltativo) endTs `string` (facoltativo)

GET /api/clubs/{clubID}/ai-credits/logs/histogram

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/logs/histogram \
  -H "x-api-key: YOUR_API_KEY"

{}

Intervalli di analisi dell'utilizzo + totali per modello in un periodo (in tempo reale).

Parametri

clubID `string` (obbligatorio) range `string` (facoltativo) 24h | 7 | 30 | 90 | year | all (ignorato se vengono forniti startDate/endDate) startDate `string` (facoltativo) endDate `string` (facoltativo) groupBy `string` (facoltativo) model (predefinito) | key | source | provider | status: dimensione per intervalli + gruppi subgroupBy `string` (facoltativo) seconda dimensione facoltativa annidata in ogni gruppo (Explore) keyHash `string` (facoltativo) filtro di approfondimento: limita a una singola chiave o agente model `string` (facoltativo) filtro di approfondimento: limita a un singolo modello provider `string` (facoltativo) source `string` (facoltativo) compare `string` (facoltativo) imposta su "prev" per restituire anche groupsPrev (il periodo di uguale durata immediatamente precedente)

GET /api/clubs/{clubID}/ai-credits/stats

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/stats \
  -H "x-api-key: YOUR_API_KEY"

{}

Calendario dell'attività giornaliera nell'ultimo anno mobile (circa 53 settimane, in stile GitHub).

Parametri

clubID `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/activity

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/activity \
  -H "x-api-key: YOUR_API_KEY"

{}

Addebita la carta salvata per la fatturazione SaaS per aggiungere credito prepagato del Model Router.

Parametri

clubID `string` (obbligatorio) body `object` (facoltativo)

POST /api/clubs/{clubID}/ai-credits/topup

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/topup \
  -H "x-api-key: YOUR_API_KEY"

{}

Completa una ricarica dopo che l'applet ha completato l'autenticazione 3DS.

Parametri

clubID `string` (obbligatorio)

POST /api/clubs/{clubID}/ai-credits/topup/confirm

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/topup/confirm \
  -H "x-api-key: YOUR_API_KEY"

{}

Riepilogo della carta salvata per la fatturazione SaaS su cui verranno addebitate le ricariche manuali e automatiche.

Parametri

clubID `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/payment-method

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/payment-method \
  -H "x-api-key: YOUR_API_KEY"

{}

Transazioni contabili della struttura, dalla più recente. Facoltativamente filtrate per tipo (ad es. `types=topup,adjustment` per la cronologia dei movimenti di denaro, oppure `types=charge-reconcile` con `from`/`to` per le detrazioni di utilizzo di un mese).

Parametri

clubID `string` (obbligatorio) limit `integer` (facoltativo) Numero massimo di righe (predefinito 50, massimo 200) types `string` (facoltativo) Tipi di transazione separati da virgole (topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (facoltativo) Solo le transazioni con createdAt >= from (secondi unix) to `integer` (facoltativo) Solo le transazioni con createdAt <= to (secondi unix)

GET /api/clubs/{clubID}/ai-credits/transactions

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions \
  -H "x-api-key: YOUR_API_KEY"

{}

Mesi `YYYY-MM` distinti (UTC, dal più recente) che contengono almeno una transazione dei tipi richiesti. Alimenta i menu a discesa dei filtri per anno e mese, così l'interfaccia propone solo i periodi che contengono effettivamente dati.

Parametri

clubID `string` (obbligatorio) types `string` (facoltativo) Tipi di transazione separati da virgole (topup, charge-reconcile, refund, adjustment, trueup-shortfall)

GET /api/clubs/{clubID}/ai-credits/transactions/available-periods

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/available-periods \
  -H "x-api-key: YOUR_API_KEY"

{}

Ricevuta di pagamento in PDF con il marchio per una singola transazione del Model Router.

Parametri

clubID `string` (obbligatorio) txId `string` (obbligatorio)

GET /api/clubs/{clubID}/ai-credits/transactions/{txId}/receipt.pdf

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/{txId}/receipt.pdf \
  -H "x-api-key: YOUR_API_KEY"

{}

Pacchetto ZIP di ricevute di pagamento in PDF con il marchio per le transazioni di ricarica selezionate. Ogni ID deve essere una ricarica della struttura: le detrazioni di utilizzo e le rettifiche amministrative non hanno ricevute e vengono rifiutate.

Parametri

clubID `string` (obbligatorio) ids `string` (obbligatorio) ID delle transazioni separati da virgole (massimo 50)

GET /api/clubs/{clubID}/ai-credits/transactions/receipts.zip

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/transactions/receipts.zip \
  -H "x-api-key: YOUR_API_KEY"

{}

Riepiloghi per mese di calendario (UTC) delle detrazioni di utilizzo della struttura, dal più recente. Il mese corrente è sempre incluso e contrassegnato con `isCurrentMonth` (dall'inizio del mese).

Parametri

clubID `string` (obbligatorio) months `integer` (facoltativo) Periodo di riferimento in mesi (predefinito 12, massimo 24; ignorato se è impostato `year`) year `integer` (facoltativo) Limita i riepiloghi a un anno di calendario UTC (ad es. 2026)

GET /api/clubs/{clubID}/ai-credits/usage-statements

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements \
  -H "x-api-key: YOUR_API_KEY"

{}

Rendiconto mensile di utilizzo in PDF con il marchio: un riepilogo delle detrazioni di utilizzo del mese (subtotali giornalieri + totale). Non è in alcun modo una fattura o una ricevuta; le detrazioni di utilizzo non comportano alcun incasso.

Parametri

clubID `string` (obbligatorio) month `string` (obbligatorio) Mese di calendario UTC, `YYYY-MM`

GET /api/clubs/{clubID}/ai-credits/usage-statements/{month}/statement.pdf

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements/{month}/statement.pdf \
  -H "x-api-key: YOUR_API_KEY"

{}

Voci non elaborate delle detrazioni di utilizzo di un mese in formato CSV (ID transazione, timestamp UTC, importo, saldo successivo, istantanea della spesa complessiva): l'esportazione dettagliata che quadra con il totale del rendiconto del mese.

Parametri

clubID `string` (obbligatorio) month `string` (obbligatorio) Mese di calendario UTC, `YYYY-MM`

GET /api/clubs/{clubID}/ai-credits/usage-statements/{month}/detail.csv

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage-statements/{month}/detail.csv \
  -H "x-api-key: YOUR_API_KEY"

{}

Riepilogo di utilizzo e spesa della struttura (dati in tempo reale più il registro contabile riconciliato).

Parametri

clubID `string` (obbligatorio) tz `string` (facoltativo) Fuso orario IANA di chi visualizza: usato in alternativa per gli intervalli di spesa giornalieri e mensili quando la struttura non ha dati sul fuso orario.

GET /api/clubs/{clubID}/ai-credits/usage

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/ai-credits/usage \
  -H "x-api-key: YOUR_API_KEY"

{}

Associa o aggiorna un dispositivo AI Edge Processor per un club

Parametri

body `string` (obbligatorio) Oggetto JSON per aggiornare la registrazione del dispositivo AI Edge Processor.

POST /api/ai-edge-processor/devices

curl -X POST https://portal.hub.gymsystems.co/api/ai-edge-processor/devices \
  -H "x-api-key: YOUR_API_KEY"

{}

Associa un dispositivo AI Edge Processor a un club. Risolve il dispositivo partendo dai metadati (prevale l'heartbeat in tempo reale), completa la riga di registrazione se il dispositivo non si è mai registrato da solo e rimuove le righe di registrazione obsolete lasciate da hardware riconfigurato.

Parametri

body `string` (obbligatorio) Oggetto JSON per aggiornare la registrazione del dispositivo AI Edge Processor.

POST /api/ai-edge-processor/devices/associate

curl -X POST https://portal.hub.gymsystems.co/api/ai-edge-processor/devices/associate \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei record di caricamento bbox di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/bbox-timeline/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/bbox-timeline/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Indice di ricerca del database delle telecamere

Inoltra l'indice di ricerca camera-db della documentazione pubblica (produttori, serie, modelli, alias) usato dalla finestra Find my camera quando si aggiungono telecamere di rete. Memorizzato nella cache lato server per 12 ore.

GET /api/cctv/camera-db/search-index

curl -X GET https://portal.hub.gymsystems.co/api/cctv/camera-db/search-index \
  -H "x-api-key: YOUR_API_KEY"

{}

Modelli dei produttori del database delle telecamere

Inoltra i modelli di URL RTSP e le impostazioni predefinite di un singolo produttore dal database delle telecamere della documentazione pubblica. Lo slug viene convalidato per impedire il path traversal. Memorizzato nella cache lato server per 12 ore.

Parametri

slug `string` (obbligatorio) Slug del produttore (ad es. hikvision)

GET /api/cctv/camera-db/manufacturers/{slug}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/camera-db/manufacturers/{slug} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati di check-in di una struttura

Parametri

club `string` (obbligatorio) ID interno del club o della struttura a cui vuoi accedere. startDate `string` (facoltativo) Data di inizio nel formato YYYY-MM-DD endDate `string` (facoltativo) Data di fine nel formato YYYY-MM-DD timezone `string` (facoltativo) Fuso orario per l'interpretazione delle date (predefinito Australia/Brisbane) nextToken `string` (facoltativo) Token di paginazione per recuperare la pagina successiva

GET /api/cctv/check-ins/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/check-ins/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera la configurazione del front-end o dell'interfaccia TVCC

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/config/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/config/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni la configurazione di distribuzione dei contenuti TVCC

Restituisce il dominio dei contenuti usato dai client TVCC per risolvere le risorse multimediali. Il dominio è determinato dalla variabile d'ambiente CONTENT_DOMAIN, con un valore predefinito che dipende dall'ambiente (la produzione serve /cctv, gli altri ambienti servono /cctv-stg).

GET /api/cctv/content-config

curl -X GET https://portal.hub.gymsystems.co/api/cctv/content-config \
  -H "x-api-key: YOUR_API_KEY"

{}

Modifica la configurazione del front-end o dell'interfaccia TVCC

Parametri

body `object` (obbligatorio) Oggetto JSON del nuovo blocco di configurazione da aggiungere al sistema.

PUT /api/cctv/config/:club/:section

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/config/:club/:section \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco della disponibilità delle regioni dei bucket per la configurazione del provider di archiviazione TVCC

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/bucket-region/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/bucket-region/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Reimposta la raccolta dei volti non identificati

Reimposta la raccolta CompreFace dei volti non identificati della struttura eliminando tutti i soggetti. I record delle persone in DynamoDB, i rilevamenti dei volti e i blocchi della sequenza temporale in OpenSearch NON vengono modificati. Vengono cancellati solo i dati di riconoscimento facciale sottostanti. Nuovi profili ombra verranno creati automaticamente man mano che il sistema elabora nuovi rilevamenti delle telecamere.

Parametri

facilityId `string` (obbligatorio)

DELETE /api/cctv/config/{facilityId}/unidentified-collection

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/config/{facilityId}/unidentified-collection \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le informazioni sulla raccolta dei volti non identificati

Restituisce il numero attuale di soggetti nella raccolta CompreFace dei volti non identificati della struttura.

Parametri

facilityId `string` (obbligatorio)

GET /api/cctv/config/{facilityId}/unidentified-collection-info

curl -X GET https://portal.hub.gymsystems.co/api/cctv/config/{facilityId}/unidentified-collection-info \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiunge una telecamera di rete (telecamera OEM/IP) tramite URL di streaming (RTSP, HTTP, HTTPS)

Parametri

body `string` (obbligatorio) Oggetto JSON per aggiungere una telecamera di rete.

POST /api/cctv/devices/add-network-camera

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/add-network-camera \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiungi in blocco telecamere di rete a un Edge Processor

Registra più telecamere di rete RTSP/HTTP su un Edge Processor, poi invia FEED_CONFIG una sola volta, così il dispositivo ricarica la configurazione un'unica volta.

Parametri

body `object` (obbligatorio)

POST /api/cctv/devices/add-network-cameras

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/add-network-cameras \
  -H "x-api-key: YOUR_API_KEY"

{}

Associa o aggiorna un dispositivo per un club

Parametri

body `string` (obbligatorio) Oggetto JSON per aggiornare la registrazione del dispositivo TVCC.

POST /api/cctv/devices

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices \
  -H "x-api-key: YOUR_API_KEY"

{}

Associa un dispositivo a un club

Parametri

body `string` (obbligatorio) Oggetto JSON per aggiornare la registrazione del dispositivo TVCC.

POST /api/cctv/devices/associate

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/associate \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia una richiesta MQTT a uno specifico UUID di dispositivo e attende una risposta (tramite websocket) con le funzionalità disponibili della telecamera.

Parametri

club `string` (obbligatorio) ID interno del club proprietario del dispositivo che stai interrogando. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/cctv/devices/list-camera-capabilities/{club}

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/list-camera-capabilities/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le registrazioni dei dispositivi

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/devices/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/devices/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Rimuove una telecamera di rete contrassegnandola come eliminata e togliendola dal FEED_CONFIG dell'Edge Processor

Parametri

club `string` (obbligatorio) ID interno del club proprietario del dispositivo. balenaUUID `string` (obbligatorio) UUID della telecamera di rete da rimuovere.

DELETE /api/cctv/devices/remove-network-camera/{club}/{balenaUUID}

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/devices/remove-network-camera/{club}/{balenaUUID} \
  -H "x-api-key: YOUR_API_KEY"

{}

Salva tutte le funzionalità configurate della telecamera e le applica al dispositivo come variabile d'ambiente (tramite balena)

Parametri

club `string` (obbligatorio) ID interno del club proprietario del dispositivo che stai interrogando. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/cctv/devices/save-camera-capabilities/{club}

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/save-camera-capabilities/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Salva una maschera di movimento (se configurata) per la telecamera e la applica al dispositivo come variabile d'ambiente (tramite balena)

Parametri

club `string` (obbligatorio) ID interno del club proprietario del dispositivo che stai interrogando. body `string` (obbligatorio) Oggetto JSON della maschera della telecamera.

POST /api/cctv/devices/save-camera-mask/{club}

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/save-camera-mask/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia un comando v4l2 specifico (ad esempio luminosità o contrasto) al dispositivo fisico

Parametri

club `string` (obbligatorio) ID interno del club proprietario del dispositivo che stai interrogando. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/cctv/devices/set-camera-capability/{club}

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/set-camera-capability/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Verifica l'URL di streaming di una telecamera di rete

Invia un comando di prova a un Edge Processor per convalidare l'URL di streaming di una telecamera con ffprobe

Corpo della richiesta

POST /api/cctv/devices/test-stream

curl -X POST https://portal.hub.gymsystems.co/api/cctv/devices/test-stream \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elimina definitivamente dal database un singolo record di rilevamento del volto. Usato per rimuovere voci di tracciamento non corrispondenti o errate dal registro delle attività di una persona.

Parametri

club `string` (obbligatorio) fdID `string` (obbligatorio)

DELETE /api/cctv/face-detections/:club/:fdID

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/:fdID \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati di rilevamento del volto di una persona

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personID `string` (obbligatorio) ID della persona nel sistema di identificazione facciale

GET /api/cctv/face-detections/:club/:personID

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i rilevamenti del volto che fanno riferimento a una determinata immagine ritagliata della persona, interrogati tramite il GSI personCropImage.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personCropImage `string` (obbligatorio) URL dell'immagine ritagliata della persona salvato nel record di rilevamento del volto. limit `string` (facoltativo) Numero massimo di rilevamenti da restituire. nextToken `string` (facoltativo) Token di paginazione di una risposta precedente.

GET /api/cctv/face-detections-by-person-crop-image/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections-by-person-crop-image/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati di rilevamento del volto di un club, raggruppati per intervallo rispetto all'ora attuale

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/face-detections/:club/timeline

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club/timeline \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati di rilevamento del volto di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/face-detections/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/face-detections/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca con OpenSearch i blocchi della sequenza temporale dei rilevamenti del volto in una struttura

Parametri

facilityId `string` (obbligatorio) ID interno della struttura in cui cercare timezone `string` (obbligatorio) Fuso orario IANA per la conversione delle date (ad es. Pacific/Auckland) startDate `string` (facoltativo) Filtro per data di inizio (YYYY-MM-DD), convertito in startUnix in base al fuso orario endDate `string` (facoltativo) Filtro per data di fine (YYYY-MM-DD), convertito in endUnix in base al fuso orario personId `string` (facoltativo) Filtra per uno specifico ID persona query `string` (facoltativo) Ricerca a testo libero (ad es. nome della persona) limit `string` (facoltativo) Risultati per pagina (predefinito 20, massimo 100) filters `string` (facoltativo) Oggetto filtri codificato in JSON (ad es. {"matchType":"identified"}) sortBy `string` (facoltativo) Campo per l'ordinamento (startUnix, endUnix, created). Il valore predefinito è endUnix. page `string` (facoltativo) Numero di pagina per la paginazione (predefinito 1) sortOrder `string` (facoltativo) Direzione di ordinamento (asc o desc). Il valore predefinito è desc.

GET /api/cctv/search/face-detections/timeline-blocks/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/face-detections/timeline-blocks/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco di report sulla struttura del club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/facility/:club/reports

curl -X GET https://portal.hub.gymsystems.co/api/cctv/facility/:club/reports \
  -H "x-api-key: YOUR_API_KEY"

{}

Avvia la generazione su richiesta delle mappe di calore. Richiama la stessa logica Starter usata dal cron programmato, ma consente di indicare una struttura specifica, una data/ora e un insieme di periodi. Se chiamato senza corpo, si comporta esattamente come il cron: analizza tutte le strutture idonee e mette in coda ogni dispositivo.

Corpo della richiesta

POST /api/cctv/heatmaps/generate

curl -X POST https://portal.hub.gymsystems.co/api/cctv/heatmaps/generate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Risolve la posizione di un PNG della mappa di calore composta su un intervallo mobile per un singolo dispositivo. Restituisce solo metadati JSON: i byte del PNG si trovano sul dominio dei contenuti e il front-end costruisce l'URL così: `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` Ordine di risoluzione: 1. Corrispondenza nell'indice DynamoDB `composed#…` → restituzione immediata (~10 ms). 2. HEAD su Wasabi con la chiave di cache deterministica. Se trovato, scrive una riga di indice di completamento e restituisce il risultato. 3. Ripiego su dati obsoleti: esiste un record composto per questa tupla (dispositivo, intervallo, ora), anche di una data diversa. Viene restituito subito con `cache: 'HIT-STALE'`, così il front-end può mostrare *qualcosa*. Una nuova composizione viene avviata in modo asincrono. 4. Percorso a freddo: non esiste alcun record. La Lambda di composizione viene messa in coda tramite `InvocationType: 'Event'` e l'endpoint restituisce `202 { cache: 'PENDING' }`. Il front-end interroga finché non arriva un record (di solito 3-5 secondi). Gestione di oggi: quando `endDate` è l'"oggi" locale della struttura, l'endpoint restituisce invece il PNG di ieri: le sezioni di oggi sono ancora in fase di scrittura da parte del cron Starter e una nuova composizione sarebbe incompleta. La risposta riporta l'`endDate` richiesto e include `endDateUsed` (= ieri). Enum `cache`: - `HIT`: servito dall'indice DDB per la data richiesta. - `HIT-FALLBACK`: richiesto oggi; servita la riga di indice di ieri. - `HIT-BACKFILL`: assente in DDB ma Wasabi aveva il PNG; la riga è appena stata scritta. - `HIT-FALLBACK-BACKFILL`: completamento sul ripiego di ieri. - `HIT-STALE`: nessun record per la data richiesta, ma esiste un record di un'altra data per questa tupla; servito subito e una nuova composizione viene messa in coda in background. - `PENDING`: nessun record; la composizione è stata messa in coda. Il front-end deve interrogare periodicamente. La risposta è `202 Accepted`, senza `filePath`.

Parametri

facilityId `string` (obbligatorio) deviceUUID `string` (obbligatorio) Dispositivo per cui eseguire la composizione. Le composizioni sono per dispositivo. hour `integer` (obbligatorio) Ora del giorno (0–23) da comporre nel periodo di riferimento. endDate `string` (facoltativo) Ultima data dell'intervallo (YYYY-MM-DD). Predefinita: oggi (fuso orario della struttura). range `string` (facoltativo) Periodo di riferimento. Deve essere uno degli intervalli consentiti. nocache `integer` (facoltativo) Imposta su `1` per ignorare i livelli di cache DDB + HEAD e forzare una nuova composizione.

GET /api/cctv/heatmaps/hourly/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/hourly/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Individua quali ore del giorno hanno record di sezioni `1h` per un dispositivo in un periodo di riferimento mobile. Il front-end lo usa per popolare il selettore dell'ora insieme a un selettore di data + intervallo prima di chiamare l'endpoint di composizione (`/api/cctv/heatmaps/hourly/...`). Esempio: `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` Internamente: una query di intervallo DynamoDB su `cctvheatmaps` (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`), raggruppata per ora. Restituisce una voce per ogni ora con almeno una sezione, inclusa una JPEG di riferimento rappresentativa (presa dal giorno più recente dell'intervallo: il riferimento è condiviso per dispositivo e per giorno).

Parametri

facilityId `string` (obbligatorio) deviceUUID `string` (obbligatorio) Dispositivo da interrogare. Le sezioni orarie sono per dispositivo. endDate `string` (facoltativo) Ultima data dell'intervallo (YYYY-MM-DD). Predefinita: oggi (fuso orario della struttura). range `string` (facoltativo) Periodo di riferimento. Deve essere uno degli intervalli consentiti.

GET /api/cctv/heatmaps/query-hourly/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/query-hourly/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Interroga i record delle mappe di calore pregenerate per una struttura. **Tutti i record per un tipo di periodo:** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **Intervallo di date, singolo tipo di periodo:** - `/api/cctv/heatmaps/Birkdale?periodType=1d&from=2026-03-01&to=2026-03-31` - `/api/cctv/heatmaps/Birkdale?periodType=6h&from=2026-03-31&to=2026-03-31` **Intervallo di date, tutti i tipi di periodo applicabili (ometti periodType):** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` Restituisce i record annuali, semestrali, trimestrali e così via, fino a quelli di 6h, che si sovrappongono all'intervallo indicato. **Momento specifico, tutti i 9 tipi di periodo per un dispositivo:** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` Restituisce fino a 9 record (1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h).

Parametri

facilityId `string` (obbligatorio) L'identificativo della struttura. deviceUUID `string` (facoltativo) Interroga un dispositivo specifico. Se omesso, interroga tutti i dispositivi (GSI). periodType `string` (facoltativo) Filtra per un singolo tipo di periodo. Se omesso insieme a from/to, interroga tutti i tipi. from `string` (facoltativo) Data di inizio (yyyy-mm-dd). Deve essere usata con `to`. to `string` (facoltativo) Data di fine (yyyy-mm-dd). Deve essere usata con `from`. date `string` (facoltativo) Ricerca in un momento specifico (yyyy-mm-dd o yyyy-mm-ddTHH:mm). Richiede deviceUUID. Restituisce un record per tipo di periodo.

GET /api/cctv/heatmaps/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/heatmaps/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni la miniatura della diretta del dispositivo

Parametri

club `string` (obbligatorio) ID interno del club. deviceId `string` (obbligatorio) ID interno del dispositivo TVCC.

GET /api/cctv/livestream/:club/thumbnail/:deviceId

curl -X GET https://portal.hub.gymsystems.co/api/cctv/livestream/:club/thumbnail/:deviceId \
  -H "x-api-key: YOUR_API_KEY"

{}

Comunica al sistema TVCC che stai per guardare una diretta

Parametri

club `string` (obbligatorio) ID interno del club. deviceId `string` (obbligatorio) ID interno del dispositivo TVCC.

POST /api/cctv/livestream/:club/iswatching/:deviceId

curl -X POST https://portal.hub.gymsystems.co/api/cctv/livestream/:club/iswatching/:deviceId \
  -H "x-api-key: YOUR_API_KEY"

{}

Approva una corrispondenza di intersezione

Imposta lo stato della corrispondenza su confermato e registra il revisore.

Parametri

club `string` (obbligatorio) matchId `string` (obbligatorio)

POST /api/cctv/matching/{club}/detail/{matchId}/approve

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/approve \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni una singola corrispondenza di intersezione con i dettagli della visita

Restituisce il record della corrispondenza e la relativa suddivisione dei tempi per visita.

Parametri

club `string` (obbligatorio) matchId `string` (obbligatorio)

GET /api/cctv/matching/{club}/detail/{matchId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Collega manualmente una persona senza corrispondenza a un membro

Associa un personId TVCC a un membro specifico, impostando la corrispondenza come confermata.

Parametri

club `string` (obbligatorio) matchId `string` (obbligatorio)

Corpo della richiesta

POST /api/cctv/matching/{club}/detail/{matchId}/link

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/link \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenca le corrispondenze di intersezione di una struttura

Restituisce le corrispondenze paginate filtrate per stato.

Parametri

club `string` (obbligatorio) status `string` (facoltativo) limit `integer` (facoltativo) nextToken `string` (facoltativo)

GET /api/cctv/matching/{club}/list

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/list \
  -H "x-api-key: YOUR_API_KEY"

{}

Rifiuta una corrispondenza di intersezione

Imposta lo stato della corrispondenza su rifiutato e registra il revisore.

Parametri

club `string` (obbligatorio) matchId `string` (obbligatorio)

POST /api/cctv/matching/{club}/detail/{matchId}/reject

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/reject \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni i conteggi riepilogativi delle corrispondenze di intersezione

Restituisce i conteggi delle corrispondenze della struttura raggruppati per stato.

Parametri

club `string` (obbligatorio) ID della struttura

GET /api/cctv/matching/{club}/summary

curl -X GET https://portal.hub.gymsystems.co/api/cctv/matching/{club}/summary \
  -H "x-api-key: YOUR_API_KEY"

{}

Scollega una corrispondenza di profilo appresa automaticamente

Riporta una corrispondenza collegata allo stato rifiutato e cancella autoLearnedFrom nel record del membro.

Parametri

club `string` (obbligatorio) matchId `string` (obbligatorio)

Corpo della richiesta

POST /api/cctv/matching/{club}/detail/{matchId}/unlink

curl -X POST https://portal.hub.gymsystems.co/api/cctv/matching/{club}/detail/{matchId}/unlink \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Legge lo stato di un'operazione "upsert identified person" in corso (copre creazione e modifica). Legge la riga direttamente dalla tabella `people-ops` di proprietà di cctv-rekognition-api, senza passare da una Lambda. Usato dal front-end TVCC per monitorare l'avanzamento dopo POST /api/cctv/people/{facility}/identified. Il percorso è allo stesso livello di `/cctv/people/...` (non annidato al suo interno), così il router express non può interpretare per errore `operationId` come `:personID` in `/cctv/people/:club/:personID`. Vedi l'ordine dei glob di createAPIRouter. Restituisce un segnaposto `pending` finché la Lambda upsertIdentifiedPerson non ha scritto la prima voce di fase (finestra di avvio a freddo). L'hook di polling del front-end tratta allo stesso modo il segnaposto e lo stato pending, quindi il contratto resta stabile per i chiamanti.

Parametri

operationId `string` (obbligatorio)

GET /api/cctv/people-operations/{operationId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people-operations/{operationId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiunge un'immagine del volto (da un rilevamento di tracciamento esistente) al soggetto di riconoscimento CompreFace della persona e salva un riferimento nella tabella delle foto ombra. NON carica l'immagine su Wasabi, perché è già presente come acquisizione del rilevamento del volto.

Parametri

club `string` (obbligatorio) personID `string` (obbligatorio) body `string` (obbligatorio)

POST /api/cctv/people/:club/:personID/add-face

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID/add-face \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiungi foto ombra al record di una persona

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personID `string` (obbligatorio) ID del record della persona body `string` (obbligatorio) Oggetto JSON del nuovo blocco di configurazione da aggiungere al sistema.

POST /api/cctv/people/:club/shadow-photos/:personID

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID \
  -H "x-api-key: YOUR_API_KEY"

{}

Interroga le foto ombra di una persona

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personID `string` (obbligatorio) ID del record della persona

GET /api/cctv/people/:club/shadow-photos/:personID

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID \
  -H "x-api-key: YOUR_API_KEY"

{}

Rimuove definitivamente un record di foto ombra da CCTVShadowPhotosTable e rimuove il volto corrispondente da CompreFace (se faceId è salvato).

Parametri

club `string` (obbligatorio) personID `string` (obbligatorio) id `string` (obbligatorio) L'ID del record della foto ombra (chiave primaria)

DELETE /api/cctv/people/:club/shadow-photos/:personID/:id

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/people/:club/shadow-photos/:personID/:id \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina i riferimenti e i record di riconoscimento associati in base a un personID

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personID `string` (obbligatorio) ID univoco della persona TVCC.

DELETE /api/cctv/people/:club/:personID

curl -X DELETE https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce il record di una persona di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. personID `string` (obbligatorio) ID database della persona.

GET /api/cctv/people/:club/:personID

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/:personID \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le zone di accesso corrispondenti al profilo di iscrizione di una persona

Risolve il tipo di membro, i tag e i piani di iscrizione della persona, poi restituisce le zone di accesso reali (origin=membership-plan, non assorbite) confrontate con le regole di inclusione ed esclusione. L'accessRestriction di ogni zona viene ridotto alle sole regole corrispondenti alla persona. Le telecamere delle zone figlie vengono unite nelle zone padre.

Parametri

club `string` (obbligatorio) ID interno della struttura personID `string` (obbligatorio) ID persona dalla tabella delle persone TVCC

GET /api/cctv/people/{club}/{personID}/allowed-zones

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/{club}/{personID}/allowed-zones \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce lo stato attuale di un processo di unione, inclusi i risultati per ogni origine. Interroga questo endpoint ogni 3-5 secondi finché lo stato è IN_PROGRESS.

Parametri

club `string` (obbligatorio) mergeJobID `string` (obbligatorio)

GET /api/cctv/people/:club/merge-status/:mergeJobID

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club/merge-status/:mergeJobID \
  -H "x-api-key: YOUR_API_KEY"

{}

Avvia in background l'unione di più profili di persone non identificate in un unico profilo superstite. Risponde subito 202 con un mergeJobID. Interroga /merge-status/:mergeJobID per l'avanzamento.

Parametri

club `string` (obbligatorio) body `string` (obbligatorio)

POST /api/cctv/people/:club/merge-unidentified

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/merge-unidentified \
  -H "x-api-key: YOUR_API_KEY"

Aggiungi un volto alla raccolta della blacklist di una struttura

Parametri

facilityId `string` (obbligatorio) ID interno della struttura

Corpo della richiesta

POST /api/cctv/people/{facilityId}/blacklist

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/blacklist \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Crea o aggiorna una persona identificata in una struttura: crea un nuovo record o ne aggiorna uno esistente. Inoltra la richiesta alla Lambda upsertIdentifiedPerson, che scrive il record della persona, carica su Wasabi l'eventuale foto fornita e reindicizza il volto in CompreFace. Quando `isNewRecord` è true (predefinito), la Lambda esegue il ramo di creazione (cctvPeople.save) e genera un `personID` se non viene fornito. Quando `isNewRecord` è false, la Lambda esegue il ramo di aggiornamento (cctvPeople.update): `personID` è obbligatorio e deve identificare un record esistente.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/cctv/people/{facilityId}/identified

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/identified \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Aggiorna l'insieme dei campi partner facoltativi sincronizzati nella tabella delle persone TVCC di una struttura.

Parametri

facilityId `string` (obbligatorio) ID interno della struttura

Corpo della richiesta

PUT /api/cctv/people/{facilityId}/sync-fields

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/people/{facilityId}/sync-fields \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Restituisce un elenco dei dati delle persone di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/people/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/people/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca persone in una struttura tramite l'immagine del volto. Richiama la Lambda imageFaceSearch di cctv-rekognition-api con l'immagine base64 caricata e l'ID della struttura indicato nel percorso. Restituisce le corrispondenze in ordine di rilevanza più un riepilogo degli attributi DeepFace.

Parametri

club `string` (obbligatorio) ID della struttura o del club body `string` (obbligatorio)

POST /api/cctv/people/{club}/search-by-face

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/{club}/search-by-face \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca persone in una struttura con OpenSearch

Parametri

facilityId `string` (obbligatorio) ID interno della struttura in cui cercare query `string` (facoltativo) Termine di ricerca (ad es. nome) page `string` (facoltativo) Numero di pagina (predefinito 1) limit `string` (facoltativo) Risultati per pagina (predefinito 20, massimo 100) filters `string` (facoltativo) Oggetto filtri codificato in JSON (ad es. {"membershipStatus":"active"}) sortBy `string` (facoltativo) Campo per l'ordinamento (created, lastName, firstName, membershipUpdatedOn). Il valore predefinito è created. sortOrder `string` (facoltativo) Direzione di ordinamento (asc o desc). Il valore predefinito è desc.

GET /api/cctv/search/people/:facilityId

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/people/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna gli elementi di rilevamento del volto con un nuovo personID e associa i record di riconoscimento

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. body `string` (obbligatorio) Oggetto JSON del nuovo blocco di configurazione da aggiungere al sistema.

POST /api/cctv/people/:club/validate

curl -X POST https://portal.hub.gymsystems.co/api/cctv/people/:club/validate \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un oggetto con tutti i filtri disponibili per i dati delle registrazioni TVCC di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/recordings/filters/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/filters/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Trasmetti la registrazione in streaming.

GET /api/cctv/recordings/:club/:dir/:filename

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:dir/:filename \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le informazioni sulla registrazione.

PUT /api/cctv/recordings/:club/:dir/:filename

curl -X PUT https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:dir/:filename \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un riepilogo dei dati delle registrazioni TVCC di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/recordings/:club/summary

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/summary \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati delle registrazioni TVCC di un club in base a un intervallo rispetto all'ora attuale

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/recordings/:club/timeline

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club/timeline \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei dati delle registrazioni TVCC di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/recordings/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/recordings/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Le registrazioni vengono eliminate automaticamente dopo un periodo prestabilito; usa questa funzione per conservarle

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

POST /api/cctv/recordings/:club/:action

curl -X POST https://portal.hub.gymsystems.co/api/cctv/recordings/:club/:action \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca le istantanee dei report di una struttura in un intervallo di date

Parametri

facilityId `string` (obbligatorio) ID interno della struttura startDate `string` (obbligatorio) Filtro per data di inizio (YYYY-MM-DD) endDate `string` (obbligatorio) Filtro per data di fine (YYYY-MM-DD) deviceIds `string` (facoltativo) Elenco separato da virgole di ID di telecamere o dispositivi in base a cui filtrare view `string` (facoltativo) Vista alternativa del report da calcolare (inoltrata alla Lambda dei report)

GET /api/cctv/reports/search-report-snapshots/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/reports/search-report-snapshots/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ricerca vettoriale sui contenuti multimediali TVCC indicizzati di una struttura. Risponde con un text/event-stream inoltrato dalla Lambda searchAnything, così il client può mostrare l'avanzamento mentre un container a freddo carica l'encoder. Gli eventi sono `status`, poi `result` oppure `error`. Ci sono tre modi per effettuare una ricerca, due dei quali con questo metodo. Invia `query` per cercare a testo libero. Invia `seedIndex` + `seedKey` per cercare per esempio ("altri simili") usando il vettore di una riga già presente nell'indice: è così che trovi altri risultati simili a quello che l'utente sta guardando. Per cercare tramite un'immagine in possesso dell'utente, invia invece i byte con `POST` a questo stesso percorso. Invia parole insieme a un'immagine per restringere l'una con l'altra: **il testo filtra, l'immagine ordina**. I candidati provengono dal seed, le parole decidono quali vengono mantenuti e la somiglianza visiva decide l'ordine: così i risultati continuano ad assomigliare all'immagine e le parole scartano quelli che non corrispondono. I due non vengono mai fusi in un unico vettore, per questo `queryKind` resta `similar` in una ricerca combinata; è la presenza di `query` nel risultato a indicare che è stato applicato un filtro testuale. Aspettati che le ricerche combinate restituiscano abbastanza spesso nessun risultato e tratta questo caso come un esito distinto: `perIndex..textGated` conta i candidati che corrispondevano all'immagine ma non alle parole, quindi una pagina vuota si può spiegare con "togli le parole" anziché "prova un'altra immagine". Una ricerca con seed senza parole non carica alcun encoder, quindi non subisce mai un avvio a freddo; aggiungendo parole si perde questo vantaggio. In ogni caso, per impostazione predefinita cerca in tutti gli indici: i vettori dei ritagli, delle registrazioni e dei timelapse condividono un unico spazio, quindi il ritaglio di una persona può trovare filmati corrispondenti. I punteggi delle ricerche con seed sono molto più alti di quelli testuali (il confronto tra immagini non attraversa alcun divario di modalità) e vengono filtrati da una soglia separata, non ancora calibrata: `result.queryKind` indica quale scala stai leggendo, e un punteggio di una scala non va mai confrontato con quello dell'altra. Per impostazione predefinita cerca in tutti gli indici e restituisce un unico elenco unito, ordinato per punteggio; ogni risultato riporta `index` e `kind`, così il chiamante può distinguere un risultato immagine da un risultato video (quest'ultimo aggiunge `offsetMs`). Gli indici senza tabella per la struttura vengono segnalati in `skipped` invece di generare un errore. I risultati sotto la soglia di rilevanza calibrata di ciascun indice vengono scartati, quindi una query senza corrispondenze reali restituisce un elenco vuoto invece di risultati insensati presentati con sicurezza; `perIndex` indica cosa ha fornito ciascun indice e perché. I risultati si possono restringere per ora di acquisizione e per telecamera. Preferisci `cameraId` a `camera`: è il balenaUUID della telecamera, l'unico valore che ogni indice salva in modo identico, quindi un solo filtro li restringe tutti. Un filtro a cui un indice non può rispondere viene segnalato in `perIndex..filtersIgnored` e in quell'indice si cerca senza restrizioni, invece di escluderlo dalla ricerca. I risultati delle registrazioni sono **uno per clip, non uno per fotogramma corrispondente**: i fotogrammi vengono campionati ogni 2 s, quindi un soggetto che si sofferma corrisponde a dieci fotogrammi quasi identici della stessa registrazione. Ogni clip restituisce il fotogramma migliore, più `matchCount` e `offsetsMs`, che elencano ogni momento corrispondente al suo interno e si possono usare direttamente come punti di ricerca nel video. I ritagli di persone non vengono mai accorpati, perché due ritagli della stessa persona sono due avvistamenti distinti.

Parametri

facilityId `string` (obbligatorio) ID interno della struttura in cui cercare query `string` (facoltativo) Descrizione a testo libero di ciò che cerchi. Obbligatoria a meno che non venga inviato warm=1 o un seed. Combinata con un seed, non è più l'elemento ordinato ma diventa un filtro sui candidati del seed, scartando quelli il cui punteggio testuale è sotto la soglia di rilevanza dell'indice. seedIndex `string` (facoltativo) Cerca per esempio anziché per testo: l'indice in cui si trova la riga seed (person-crops, recording-frames, timelapse-frames). È l'`index` del risultato su cui l'utente ha fatto clic. Deve essere inviato con seedKey. seedKey `string` (facoltativo) La `key` della riga seed, ripresa esattamente dal risultato. Il seed è escluso dai propri risultati: per una registrazione significa l'intera clip, perché gli altri suoi fotogrammi distano 2 s l'uno dall'altro e sono quasi identici. seedFrameId `string` (facoltativo) Obbligatorio quando seedIndex è recording-frames: quell'indice salva una riga per ogni fotogramma campionato e tutte condividono la chiave della clip, quindi la sola chiave identifica una clip e non un momento. Invia il `frameId` del risultato. Le righe meno recenti non lo hanno: in quel caso invia seedOffsetMs. seedOffsetMs `string` (facoltativo) Identificativo alternativo del fotogramma per i seed recording-frames la cui riga è precedente a `frame_id`. Invia l'`offsetMs` del risultato. Ignorato se viene fornito seedFrameId. warm `string` (facoltativo) Prepara un container Lambda senza eseguire una ricerca. Chiamalo al caricamento della pagina. warmTarget `string` (facoltativo) Quale encoder carica `warm`: `text` (predefinito), `image` o `both`. La torre visiva occupa 355 MB contro i 283 MB di quella testuale, quindi la sua preparazione è facoltativa: richiedi `image` solo quando l'utente ha effettivamente preparato un'immagine, non al caricamento della pagina. index `string` (facoltativo) Set di dati in cui cercare, separati da virgole: person-crops, recording-frames, timelapse-frames. I risultati vengono uniti in un unico elenco ordinato per punteggio. Per impostazione predefinita si cerca in tutti e tre; passa un elenco esplicito per restringere la ricerca. timelapse-frames riguarda le telecamere che non registrano e producono solo un fotogramma al minuto, e la sua soglia di rilevanza non è ancora calibrata. model `string` (facoltativo) Encoder con cui eseguire la query. Deve corrispondere all'encoder con cui è stato indicizzato il set di dati. limit `string` (facoltativo) Risultati da restituire per indice (predefinito 50, massimo 100): non è un totale, quindi una ricerca in tutti e tre gli indici può restituirne fino al triplo. Per le registrazioni conta le clip anziché i fotogrammi corrispondenti. from `string` (facoltativo) Trova solo i contenuti acquisiti a partire da questo momento, in millisecondi dall'epoch. Nota: si tratta dell'ora di acquisizione, non di caricamento. to `string` (facoltativo) Trova solo i contenuti acquisiti prima di questo momento (escluso), in millisecondi dall'epoch. cameraId `string` (facoltativo) balenaUUID delle telecamere, separati da virgole, a cui restringere la ricerca: il campo `balenaUUID` di ogni voce restituita da /api/cctv/recordings/filters/:club. È il filtro per telecamera da preferire: ogni indice salva questo stesso valore, quindi un solo filtro li restringe tutti. Nota che lo riportano solo i ritagli il cui collegamento al rilevamento del volto è stato risolto (circa l'1% oggi), quindi restringere i ritagli per telecamera restituirà pochi risultati o nessuno finché non verrà eseguito il completamento dei ritagli; le registrazioni sono completamente popolate e vengono filtrate con precisione. camera `string` (facoltativo) Nomi delle telecamere, separati da virgole, a cui restringere la ricerca. In pratica vale solo per le registrazioni: person-crops salva un nome di telecamera vuoto in ogni riga, quindi qualsiasi valore qui esclude tutti i ritagli. Preferisci cameraId. cameraGroup `string` (facoltativo) Gruppi di telecamere, separati da virgole, a cui restringere la ricerca. Popolato in tutte le registrazioni ma solo in circa l'1% dei ritagli, per lo stesso motivo di cameraId. minScore `string` (facoltativo) Sostituisce la soglia del coseno per indice che filtra il rumore. Omettilo in produzione; ogni indice ha un valore predefinito calibrato (e uno separato, non calibrato, per le ricerche con seed). Passa 0 per vedere i vicini più prossimi senza filtri quando esegui il debug della rilevanza.

GET /api/cctv/search/anything/:facilityId

curl -X GET https://portal.hub.gymsystems.co/api/cctv/search/anything/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca tramite un'immagine in possesso dell'utente, anziché tramite parole o un risultato già sullo schermo. Identico al GET sotto ogni altro aspetto (stessi parametri di query, stesso flusso di eventi, stessa forma del risultato), quindi qui sono documentate solo le differenze. Invia i **byte originali del file** come corpo della richiesta con un Content-Type `image/*`. Non ridimensionare, ritagliare o ricodificare prima l'immagine nel browser: il server riproduce un ridimensionamento molto specifico (una compressione a 256x256 con un kernel bilineare con antialiasing) con cui sono stati creati i vettori indicizzati, mentre il ridimensionamento del canvas ne usa uno diverso. Dalle misurazioni, questa sostituzione finisce a circa 0,93 di coseno dalla risposta corretta, una distanza maggiore di quella tra due immagini realmente diverse: i risultati vengono quindi ordinati in modo plausibile ma errato, senza alcun errore. Il limite è di 4 MB, un vincolo di trasporto e non di qualità: i byte viaggiano nel payload di invocazione della Lambda, limitato a 6 MB, e la codifica base64 li aumenta di un terzo. I risultati vengono valutati confrontando immagini, quindi `queryKind` è `image` e i punteggi sono sulla stessa scala, molto più alta, di una ricerca con seed: mai confrontabili con i punteggi testuali. Aspettati che siano leggermente *inferiori* a quelli di una ricerca con seed equivalente: il vettore di un seed è stato scritto dal dispositivo stesso, mentre un caricamento viene ricodificato qui da un motore diverso, che lo colloca a pochi centesimi da dove lo avrebbe posto il dispositivo. Dalle misurazioni, i risultati hanno comunque la stessa qualità; semplicemente non sono lo stesso identico insieme. Aggiungere `query` filtra i risultati in base a quelle parole, esattamente come per un seed. L'invio di un seed *e* di un'immagine viene rifiutato: entrambi sono l'elemento da ordinare, quindi la coppia non ha senso. Questa è la richiesta più costosa servita dall'endpoint. Un'immagine caricata carica la torre visiva, e aggiungere parole carica anche quella testuale, entrambe su un container a freddo. `warm=1&warmTarget=image`, inviato non appena l'utente prepara un'immagine, toglie questo costo dal percorso critico.

Parametri

facilityId `string` (obbligatorio) ID interno della struttura in cui cercare body `string` (obbligatorio) Byte dell'immagine non elaborati, non modificati, massimo 4 MB query `string` (facoltativo) Parole facoltative con cui restringere i risultati per immagine, scartando le corrispondenze il cui punteggio testuale è sotto la soglia di rilevanza dell'indice.

POST /api/cctv/search/anything/:facilityId

curl -X POST https://portal.hub.gymsystems.co/api/cctv/search/anything/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dettagli di archiviazione e altre metriche della TVCC del club

GET /api/cctv/storage-details/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/storage-details/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco dei record di caricamento dei timelapse di un club

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/timelapse/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/timelapse/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le azioni eseguite dagli utenti sulle registrazioni nel front-end o nell'interfaccia TVCC

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/cctv/ui/actions/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/ui/actions/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Registra un'azione eseguita da un utente sulle registrazioni nel front-end o nell'interfaccia TVCC

Parametri

body `string` (obbligatorio) Oggetto JSON del nuovo blocco di configurazione da aggiungere al sistema.

POST /api/cctv/ui/actions/:club

curl -X POST https://portal.hub.gymsystems.co/api/cctv/ui/actions/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni il token utente per il front-end o l'interfaccia TVCC

Parametri

club `string` (obbligatorio) ID del club

GET /api/cctv/ui/token/:club

curl -X GET https://portal.hub.gymsystems.co/api/cctv/ui/token/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Genera un token per l'accesso temporaneo o come ospite

Parametri

club `string` (obbligatorio) L'identificativo univoco del club. body `string` (obbligatorio) Oggetto JSON con i dettagli del token da emettere.

POST /api/cctv/token/{club}

curl -X POST https://portal.hub.gymsystems.co/api/cctv/token/{club} \
  -H "x-api-key: YOUR_API_KEY"

{
  "accessID": "00000000-0000-0000-0000-000000000014"
}

Restituisce un elenco dei record dei token per l'accesso temporaneo o come ospite

Parametri

club `string` (obbligatorio) L'identificativo univoco del club.

GET /api/cctv/token/{club}

curl -X GET https://portal.hub.gymsystems.co/api/cctv/token/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni il token di accesso tramite l'ID di accesso

Parametri

accessID `string` (obbligatorio) ID del record del token nel database.

POST /guest/cctv/token/:accessID

curl -X POST https://portal.hub.gymsystems.co/guest/cctv/token/:accessID \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina gli orari di accesso di una struttura

Parametri

facilityId `string` (obbligatorio) body `object` (obbligatorio) Oggetto JSON dei nuovi orari di accesso.

DELETE /api/ai/computer-vision/access-hours/:facilityId

curl -X DELETE https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco degli orari di accesso della struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/ai/computer-vision/access-hours/:facilityId

curl -X GET https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna o crea gli orari di accesso di una struttura

Parametri

facilityId `string` (obbligatorio) body `object` (obbligatorio) Oggetto JSON dei nuovi orari di accesso.

POST /api/ai/computer-vision/access-hours/:facilityId

curl -X POST https://portal.hub.gymsystems.co/api/ai/computer-vision/access-hours/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina una zona di accesso della struttura

Parametri

facilityId `string` (obbligatorio) body `object` (obbligatorio) Oggetto JSON della nuova zona di accesso.

DELETE /api/ai/computer-vision/access-zones/:facilityId

curl -X DELETE https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco delle zone di accesso della struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/ai/computer-vision/access-zones/:facilityId

curl -X GET https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna o crea una zona di accesso della struttura

Parametri

facilityId `string` (obbligatorio) body `object` (obbligatorio) Oggetto JSON della nuova zona di accesso.

POST /api/ai/computer-vision/access-zones/:facilityId

curl -X POST https://portal.hub.gymsystems.co/api/ai/computer-vision/access-zones/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'unione di tutti gli ID dei moduli amministrativi di brand e strutture di un'organizzazione, sotto forma di oggetti modulo.

Parametri

organisationId `string` (obbligatorio) ID dell'organizzazione

GET /api/organisations/{organisationId}/admin-modules

curl -X GET https://portal.hub.gymsystems.co/api/organisations/{organisationId}/admin-modules \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco di tutte le organizzazioni

Parametri

includeBrands `string` (facoltativo) Includi i brand associati all'organizzazione includeFacilities `string` (facoltativo) Includi le strutture associate all'organizzazione includeRegions `string` (facoltativo) Includi le regioni associate all'organizzazione

GET /api/organisations

curl -X GET https://portal.hub.gymsystems.co/api/organisations \
  -H "x-api-key: YOUR_API_KEY"

{}

Un semplice strumento AI che analizza il contenuto di un ticket di assistenza e crea suggerimenti in base agli argomenti disponibili e agli argomenti di ricerca Algolia suggeriti...

Parametri

messageBody `string` (obbligatorio) Corpo del messaggio da inviare topicData `string` (obbligatorio) Oggetto o array JSON dei topicData restituiti da osTicket (sistema di ticket e assistenza) facilityId `string` (facoltativo) L'ID interno del club necessario per individuare l'indice Algolia corretto in cui cercare.

PUT /api/ai/helpers/analyse-support-ticket

curl -X PUT https://portal.hub.gymsystems.co/api/ai/helpers/analyse-support-ticket \
  -H "x-api-key: YOUR_API_KEY"

{}

Una semplice API di generazione di immagini

Parametri

type `string` (obbligatorio) Tipo di immagine da generare name `string` (obbligatorio) Nome dell'immagine maxSize `string` (facoltativo) Dimensione massima facoltativa della risposta, ad es. 200KB, 1MB o un semplice numero di byte. L'immagine viene ridimensionata o compressa per rientrare nel limite.

PUT /api/ai/images/:type/:name

curl -X PUT https://portal.hub.gymsystems.co/api/ai/images/:type/:name \
  -H "x-api-key: YOUR_API_KEY"

{}

Query LLM semplice

Endpoint leggero per query LLM semplici e senza stato. Usa un modello economico senza ragionamento (gpt-4o-mini) con limiti di token rigorosi. Nessuna cronologia della conversazione, nessuno strumento, nessuno streaming: solo un prompt in ingresso e testo in uscita.

Corpo della richiesta

POST /api/ai/llm/query

curl -X POST https://portal.hub.gymsystems.co/api/ai/llm/query \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Restituisce la configurazione di Algolia, inclusi nome dell'indice, ID app e chiave API.

Parametri

facilityId `string` (obbligatorio)

GET /api/facilities/{facilityId}/algolia/config

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/algolia/config \
  -H "x-api-key: YOUR_API_KEY"

{}

Inizializza l'indice Algolia dei materiali di marketing per la stampa

Parametri

organisationId `string` (obbligatorio)

PUT /api/algolia/index

curl -X PUT https://portal.hub.gymsystems.co/api/algolia/index \
  -H "x-api-key: YOUR_API_KEY"

{}

Cerca materiali di marketing per la stampa

Corpo della richiesta

POST /algolia/search-marketing-print

curl -X POST https://portal.hub.gymsystems.co/algolia/search-marketing-print \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Cerca materiali di marketing per la stampa

Parametri

club `string` (facoltativo) ID del club searchTerms `string` (facoltativo) Termini di ricerca algoliaArgs `object` (facoltativo) Argomenti di ricerca Algolia aggiuntivi

GET /algolia/search-marketing-print

curl -X GET https://portal.hub.gymsystems.co/algolia/search-marketing-print \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna in blocco gli oggetti di marketing per la stampa di un club specifico

POST /algolia/bulk-update-marketing-print

curl -X POST https://portal.hub.gymsystems.co/algolia/bulk-update-marketing-print \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera da Algolia le risorse di marketing per la stampa.

Parametri

organisationId `string` (obbligatorio) search `string` (facoltativo) limit `string` (facoltativo) brand `string` (facoltativo) tag `string` (facoltativo)

GET /api/algolia/marketing/assets

curl -X GET https://portal.hub.gymsystems.co/api/algolia/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

{}

Inizializza l'indice Algolia dei materiali di marketing per la stampa con la configurazione della struttura.

Parametri

organisationId `string` (obbligatorio)

POST /api/algolia/marketing/assets

curl -X POST https://portal.hub.gymsystems.co/api/algolia/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

{}

Esegue una ricerca in un indice Algolia specificato in base a termini di ricerca, club e/o impostazioni locali. La ricerca può essere ulteriormente personalizzata con argomenti Algolia aggiuntivi.

Parametri

searchTerms `string` (obbligatorio) I termini da cercare nell'indice Algolia. club `string` (facoltativo) ID interno del club che effettua la richiesta. Se specificato, la ricerca viene filtrata in base alla regione associata al club. locale `string` (facoltativo) Le impostazioni locali da usare per determinare la regione se non viene specificato un club. Derivate da navigator.languages. algoliaArgs `string` (facoltativo) Argomenti aggiuntivi o personalizzati da passare alla richiesta di ricerca Algolia.

POST /api/algolia/search-wiki

curl -X POST https://portal.hub.gymsystems.co/api/algolia/search-wiki \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca tutti gli annunci

GET /api/announcements/list

curl -X GET https://portal.hub.gymsystems.co/api/announcements/list \
  -H "x-api-key: YOUR_API_KEY"

{}

Carica una risorsa in un BUCKET S3 PUBBLICO (tramite la Upload API), che poi elabora e ottimizza il file, genera le miniature e così via. *Nota: le risorse saranno disponibili pubblicamente*

Parametri

file `string` (facoltativo) Nome del file o della risorsa da caricare.

POST /api/asset-upload

curl -X POST https://portal.hub.gymsystems.co/api/asset-upload \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce lo stato del caricamento in base all'UUID indicato del record di caricamento

Parametri

uuid `string` (obbligatorio) UUID del record di caricamento

GET /api/asset-upload/:uuid

curl -X GET https://portal.hub.gymsystems.co/api/asset-upload/:uuid \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia un comando al sistema Sonos del club

Parametri

body `object` (obbligatorio) Oggetto JSON del comando e dell'input da inviare a Sonos.

PUT /api/audio-control/command/:club

curl -X PUT https://portal.hub.gymsystems.co/api/audio-control/command/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera la configurazione del front-end di Controllo audio

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/audio-control/config/:club

curl -X GET https://portal.hub.gymsystems.co/api/audio-control/config/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Modifica la configurazione del front-end di Controllo audio

Parametri

body `object` (obbligatorio) Oggetto JSON del nuovo blocco di configurazione da aggiungere al sistema.

PUT /api/audio-control/config/:club/:section

curl -X PUT https://portal.hub.gymsystems.co/api/audio-control/config/:club/:section \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera le impostazioni del brand per una regione specifica

Parametri

brandId `string` (facoltativo) L'ID del brand regionCode `string` (facoltativo) Il codice ISO della regione di cui recuperare le impostazioni

GET /api/brands/{brandId}/regions/{regionCode}

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/regions/{regionCode} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna più impostazioni del brand per una regione specifica

Parametri

brandId `string` (facoltativo) L'ID del brand da aggiornare regionCode `string` (facoltativo) Il codice ISO della regione di cui aggiornare le impostazioni acceptFreeTrialBookingsVisibility `string` (facoltativo) customTrackingCodeVisibility `string` (facoltativo) displayDataSources `string` (facoltativo) displayDefaultDataSource `string` (facoltativo) displayDefaultUI `string` (facoltativo) displayUIOptions `string` (facoltativo) defaultAboutBusiness `string` (facoltativo) defaultAboutBusinessFacebook `string` (facoltativo) facilityCoverImage `string` (facoltativo) digitalProfileSettingsVisibility `string` (facoltativo) facilityHoursVisibility `string` (facoltativo) facilityLocationVisibility `string` (facoltativo) facilityPaymentMethods `string` (facoltativo) facilityPrimaryLogo `string` (facoltativo) facilityStatusVisibility `string` (facoltativo) landingPagesVisibility `string` (facoltativo) lineChatIntegrationVisibility `string` (facoltativo) whatsAppIntegrationVisibility `string` (facoltativo) defaultWhatsAppMessage `string` (facoltativo) socialUrlsVisibility `string` (facoltativo) yextApiKey `string` (facoltativo) Chiave API usata dall'integrazione Yext per questa combinazione di brand e regione. Viene consultata solo quando `directorySyncMode` è `yext`. directorySyncMode `string` (facoltativo) Il backend di sincronizzazione da eseguire per le strutture di questa combinazione di brand e regione. Se manca, il valore predefinito è `yext`, per compatibilità con i brand precedenti all'introduzione di Directory Publishers. websiteUrl `string` (facoltativo) androidAppUrl `string` (facoltativo) iosAppUrl `string` (facoltativo) featuredMessageDescription `string` (facoltativo) yextCategoryIds `string` (facoltativo) Chiave di archiviazione legacy: si tratta in realtà di ID di categoria di Google Business Profile (ad es. gcid:gym). Il prefisso "yext" è precedente alla dismissione di Yext; viene mantenuto per compatibilità con le righe esistenti del database. customInputFields `string` (facoltativo) customInputFieldsToRemove `string` (facoltativo)

PUT /api/brands/{brandId}/regions/{regionCode}

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId}/regions/{regionCode} \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera le impostazioni del brand per una struttura specifica

Parametri

facilityId `string` (facoltativo) L'ID della struttura di cui recuperare le impostazioni del brand

GET /api/facilities/{facilityId}/brand-settings

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/brand-settings \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea un nuovo brand

Parametri

name `string` (obbligatorio) Il nome del brand organisationId `string` (obbligatorio) L'ID dell'organizzazione a cui appartiene il brand redirectDashboard `string` (facoltativo) L'URL a cui reindirizzare dopo l'accesso al posto della dashboard predefinita

POST /api/brands

curl -X POST https://portal.hub.gymsystems.co/api/brands \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco di tutti i brand

GET /api/brands

curl -X GET https://portal.hub.gymsystems.co/api/brands \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'oggetto brand

Parametri

brandId `string` (obbligatorio) L'ID del brand da recuperare includeOrganisation `boolean` (facoltativo) Indica se includere i dati dell'organizzazione nella risposta

GET /api/brands/{brandId}

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna un brand in base all'ID

Parametri

brandId `string` (facoltativo) L'ID del brand da aggiornare name `string` (obbligatorio) Il nome del brand brandOrganisationId `string` (facoltativo) L'ID dell'organizzazione a cui appartiene il brand redirectDashboard `string` (facoltativo) L'URL a cui reindirizzare dopo l'accesso al posto della dashboard predefinita yextApiKey `string` (facoltativo) La chiave API usata per accedere all'API di Yext per questo brand customMenuLayout `object` (facoltativo) Struttura del menu laterale per brand (sezioni / gruppi / voci con riferimenti a moduli di sistema o URL personalizzati). Può essere impostata solo da un amministratore dell'organizzazione di questo brand.

PUT /api/brands/{brandId}

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le strutture di un brand

Restituisce un elenco sintetico delle strutture (ID, nome, codice ISO della regione) appartenenti al brand. Usato per popolare i selettori di destinazione delle strutture nella configurazione del brand.

Parametri

brandId `string` (obbligatorio) L'ID del brand di cui elencare le strutture

GET /api/brands/{brandId}/facilities

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/facilities \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco di tutti i brand associati all'organizzazione del club.

GET /api/clubs/{club}/brands

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/brands \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco di tutti i tipi di calendario

GET /api/programs/calendars/calendar-types

curl -X GET https://portal.hub.gymsystems.co/api/programs/calendars/calendar-types \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina un banner della dashboard

Elimina logicamente un banner della dashboard appartenente al brand.

Parametri

brandId `string` (obbligatorio) L'ID del brand a cui appartiene il banner bannerId `string` (obbligatorio) L'ID del banner da eliminare

DELETE /api/brands/{brandId}/dashboard-banners/{bannerId}

curl -X DELETE https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners/{bannerId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca i banner della dashboard di un brand

Restituisce tutti i banner della dashboard (non eliminati) configurati per il brand, per la gestione da parte degli amministratori.

Parametri

brandId `string` (obbligatorio) L'ID del brand di cui elencare i banner

GET /api/brands/{brandId}/dashboard-banners

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea o aggiorna un banner della dashboard

Crea un nuovo banner della dashboard per il brand o ne aggiorna uno esistente quando `bannerId` viene fornito nel corpo. I banner possono essere programmati (inizio e fine in secondi unix, null = senza limite) e destinati all'intero brand, a regioni specifiche (codici ISO) o a strutture specifiche.

Parametri

brandId `string` (obbligatorio) L'ID del brand a cui appartiene il banner

Corpo della richiesta

PUT /api/brands/{brandId}/dashboard-banners

curl -X PUT https://portal.hub.gymsystems.co/api/brands/{brandId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni i banner attivi del pannello di controllo di una struttura

Determina i banner del pannello di controllo da mostrare in questo momento per una struttura, in base al brand della struttura, alla regione (codice paese ISO) e, per ogni banner, al flag enabled, alla finestra di pianificazione e al targeting. Usato dalle interfacce del pannello di controllo.

Parametri

facilityId `string` (obbligatorio) L'ID della struttura per cui determinare i banner

GET /api/facilities/{facilityId}/dashboard-banners

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/dashboard-banners \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce la risorsa KYC di un club.

Parametri

clubId `string` (obbligatorio) L'ID del club. key `string` (obbligatorio) La chiave della risorsa KYC.

GET /api/clubs/{clubId}/kyc-assets/{key}

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc-assets/{key} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce le informazioni KYC del club.

GET /api/clubs/{clubId}/kyc

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le informazioni KYC del club.

Parametri

clubId `string` (obbligatorio) L'ID del club da aggiornare. body `object` (obbligatorio)

PUT /api/clubs/{clubId}/kyc

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc \
  -H "x-api-key: YOUR_API_KEY"

{}

Carica una risorsa KYC per un club.

Parametri

clubId `string` (obbligatorio) L'ID del club. file `string` (obbligatorio) Il file da caricare.

POST /api/clubs/{clubId}/kyc-assets

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{clubId}/kyc-assets \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce le impostazioni delle preferenze del club.

GET /api/club/preferences/:club

curl -X GET https://portal.hub.gymsystems.co/api/club/preferences/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea o aggiorna la voce delle preferenze del club.

Corpo della richiesta

POST /api/club/preferences/:club

curl -X POST https://portal.hub.gymsystems.co/api/club/preferences/:club \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Restituisce l'elenco dei membri con accordo.

GET /api/clubpass/user/email/exist/:club

curl -X GET https://portal.hub.gymsystems.co/api/clubpass/user/email/exist/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco dei membri con accordo.

GET /api/clubpass/user/phone/exist/:club

curl -X GET https://portal.hub.gymsystems.co/api/clubpass/user/phone/exist/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco degli utenti che appartengono al club specificato

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere

GET /api/clubs/{club}/members

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/members \
  -H "x-api-key: YOUR_API_KEY"

{}

Indica se il club è aperto nella data specificata.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. date `string` (obbligatorio) Data da verificare in formato unix

GET /api/club-busy-hours/:club

curl -X GET https://portal.hub.gymsystems.co/api/club-busy-hours/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutti i metadati del club mostrati sui siti web di Example Club.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/clubs/clubpage/clubdata/{club}

curl -X GET https://portal.hub.gymsystems.co/api/clubs/clubpage/clubdata/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna i metadati di un club con i nuovi dati forniti dal front-end. I campi assenti dal corpo della richiesta vengono mantenuti (nessun SET, nessun REMOVE). I campi inviati come `null` o stringa vuota vengono cancellati. Passa `updateAll: false` per usare il percorso dedicato di unione parziale; in entrambi i casi, i chiamanti non devono mai inviare campi che non gestiscono.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. body `string` (obbligatorio) Oggetto JSON con i dati del club che vuoi aggiornare.

POST /api/clubs/clubpage/updateclub/{club}

curl -X POST https://portal.hub.gymsystems.co/api/clubs/clubpage/updateclub/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

aggiungi un nuovo record di tracciamento personalizzato

Parametri

club `string` (obbligatorio) ID del club body `string` (obbligatorio) Array di elementi di tracciamento personalizzato.

POST /api/clubs/{club}/customtracking

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/customtracking \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce il tracciamento personalizzato di un club specifico

GET /api/clubs/customtracking/:clubID

curl -X GET https://portal.hub.gymsystems.co/api/clubs/customtracking/:clubID \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le voci di tracciamento personalizzato

Parametri

club `string` (obbligatorio) ID del club body `string` (obbligatorio) Oggetto JSON con i dati del club che vuoi aggiornare.

POST /api/clubs/{club}/customtracking/update

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/customtracking/update \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'immagine predefinita della vetrina di un club.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/clubs/{club}/default-shop-front

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/default-shop-front \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le porte disponibili nella struttura

Parametri

body `object` (obbligatorio) Oggetto JSON con i dati del club che vuoi aggiornare.

POST /api/clubs/integrations/doors/:facilityId

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/doors/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Sblocca una porta specifica della struttura

Parametri

body `object` (obbligatorio) Oggetto JSON con i dati del club che vuoi aggiornare.

POST /api/clubs/integrations/doors/unlock

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/doors/unlock \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutte le integrazioni e i dettagli di configurazione del club specificato.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/clubs/integrations/list/{club}

curl -X GET https://portal.hub.gymsystems.co/api/clubs/integrations/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna i metadati di un club con i nuovi dati forniti dal front-end.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. body `object` (obbligatorio) Oggetto JSON con i dati del club che vuoi aggiornare.

POST /api/clubs/integrations/update/{club}

curl -X POST https://portal.hub.gymsystems.co/api/clubs/integrations/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un valore booleano che indica se il club si trova in un paese europeo

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. date `string` (obbligatorio) Data da verificare in formato unix

GET /api/clubs/is-eu/{club}

curl -X GET https://portal.hub.gymsystems.co/api/clubs/is-eu/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un elenco generale di tutti i club presenti nel nostro database.

GET /api/clubs/listclubs

curl -X GET https://portal.hub.gymsystems.co/api/clubs/listclubs \
  -H "x-api-key: YOUR_API_KEY"

{}

Indica se il club è aperto nella data specificata.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. date `string` (obbligatorio) Data da verificare in formato unix

GET /api/clubs/{club}/open-on/{date}

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/open-on/{date} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le recensioni del club da DynamoDB.

Parametri

club `string` (obbligatorio) ID del club

GET /api/clubs/{club}/reviews

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/reviews \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le impostazioni delle recensioni del club da DynamoDB.

Parametri

facilityId `string` (obbligatorio) ID della struttura

GET /api/clubs/{club}/reviews-settings

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le impostazioni delle recensioni del club su DynamoDB.

Parametri

club `string` (obbligatorio) ID del club

PUT /api/clubs/{club}/reviews-settings

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings \
  -H "x-api-key: YOUR_API_KEY"

{}

Riattiva la pubblicazione automatica nelle impostazioni delle recensioni.

Parametri

club `string` (obbligatorio) ID del club

PUT /api/clubs/{club}/reviews/publish-recent-reviews

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/publish-recent-reviews \
  -H "x-api-key: YOUR_API_KEY"

{}

Pubblica una recensione

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. review `string` (obbligatorio) ID interno della recensione che vuoi pubblicare.

PUT /api/clubs/{club}/reviews/{review}/publish

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{review}/publish \
  -H "x-api-key: YOUR_API_KEY"

{}

Riattiva la pubblicazione automatica nelle impostazioni delle recensioni.

Parametri

club `string` (obbligatorio) ID del club

PUT /api/clubs/{club}/reviews-settings/re-enable-auto-publish

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings/re-enable-auto-publish \
  -H "x-api-key: YOUR_API_KEY"

{}

Pubblica una risposta a una recensione tramite la piattaforma di origine (Google e così via).

Parametri

club `string` (obbligatorio) ID della struttura reviewId `string` (obbligatorio) ID della recensione PH (cercato nella tabella club-social-reviews) body `string` (obbligatorio)

POST /api/clubs/{club}/reviews/{reviewId}/respond

curl -X POST https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{reviewId}/respond \
  -H "x-api-key: YOUR_API_KEY"

{}

Annulla la pubblicazione di una recensione

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. review `string` (obbligatorio) ID interno della recensione di cui vuoi annullare la pubblicazione.

PUT /api/clubs/{club}/reviews/{review}/un-publish

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/{review}/un-publish \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce dal database PH un elenco dei proprietari che appartengono al club specificato

Parametri

clubID `string` (obbligatorio) ID interno del club a cui vuoi accedere

GET /api/clubs/{clubID}/owners

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubID}/owners \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutti i piani di iscrizione della struttura.

Parametri

facilityId `string` (obbligatorio) ID interno della struttura

GET /api/facilities/membership-plans/:facilityId

curl -X GET https://portal.hub.gymsystems.co/api/facilities/membership-plans/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna il record di un piano di iscrizione.

Parametri

facilityId `string` (obbligatorio) ID interno della struttura body `object` (obbligatorio) Oggetto JSON con i dati del piano di iscrizione che vuoi aggiornare.

PUT /api/facilities/membership-plans/:facilityId

curl -X PUT https://portal.hub.gymsystems.co/api/facilities/membership-plans/:facilityId \
  -H "x-api-key: YOUR_API_KEY"

{}

Riattiva la pubblicazione automatica nelle impostazioni delle recensioni.

Parametri

club `string` (obbligatorio) ID del club

PUT /api/clubs/{club}/reviews/publish-recent-reviews

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews/publish-recent-reviews \
  -H "x-api-key: YOUR_API_KEY"

{}

Riattiva la pubblicazione automatica nelle impostazioni delle recensioni.

Parametri

club `string` (obbligatorio) ID del club

PUT /api/clubs/{club}/reviews-settings/re-enable-auto-publish

curl -X PUT https://portal.hub.gymsystems.co/api/clubs/{club}/reviews-settings/re-enable-auto-publish \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco di tutte le valute disponibili

GET /api/currencies

curl -X GET https://portal.hub.gymsystems.co/api/currencies \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce la posizione geografica a partire dall'indirizzo IP.

Parametri

ip `string` (obbligatorio) Indirizzo IP da cercare

GET /api/geo/ip-location/:club

curl -X GET https://portal.hub.gymsystems.co/api/geo/ip-location/:club \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce la posizione geografica dell'utente corrente in base al suo IP.

GET /api/geo/ip-current

curl -X GET https://portal.hub.gymsystems.co/api/geo/ip-current \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce solo l'indirizzo IP pubblico del client richiedente (nessuna geolocalizzazione, nessuna chiamata ad API di terze parti). Usato dall'applet degli Agenti AI per confrontare l'IP pubblico del browser con l'IP WAN segnalato da un dispositivo, per rilevare se si trovano sulla stessa rete.

GET /api/geo/client-ip

curl -X GET https://portal.hub.gymsystems.co/api/geo/client-ip \
  -H "x-api-key: YOUR_API_KEY"

{}

Parser dei numeri di telefono.

Parametri

body `string` (obbligatorio) Oggetto JSON del numero che vuoi analizzare.

POST /api/phone/parser

curl -X POST https://portal.hub.gymsystems.co/api/phone/parser \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce il dispositivo orologio principale

Parametri

club_id `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo.

GET /api/clubs/{club_id}/smart-club/health-check/master-clock

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/master-clock \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce il dispositivo Sonos principale

Parametri

club_id `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo.

GET /api/clubs/{club_id}/smart-club/health-check/sonos-mqtt

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/sonos-mqtt \
  -H "x-api-key: YOUR_API_KEY"

{}

ottieni le notifiche di batteria scarica dei dispositivi Duress per un determinato club.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/clubs/{club}/smart-club/health-check/low-battery-duress

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/smart-club/health-check/low-battery-duress \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dati di analisi della rete

Parametri

club_id `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo.

GET /api/clubs/{club_id}/smart-club/health-check/network-analysis

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/network-analysis \
  -H "x-api-key: YOUR_API_KEY"

{}

invia le notifiche di batteria scarica dei dispositivi Duress per un determinato club.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/clubs/{club}/smart-club/health-check/send-low-battery-duress-notifs

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club}/smart-club/health-check/send-low-battery-duress-notifs \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dati dei test di velocità dei dispositivi per ogni tipo di dispositivo

Parametri

club_id `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo.

GET /api/clubs/{club_id}/smart-club/health-check/speed-test

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{club_id}/smart-club/health-check/speed-test \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni gli insights delle schede di una struttura. Per impostazione predefinita restituisce i totali giornalieri aggregati di tutti gli editori, oppure un singolo editore quando viene fornito `publisherId`.

Parametri

facilityId `string` (obbligatorio) publisherId `string` (facoltativo) startDate `string` (obbligatorio) endDate `string` (obbligatorio)

GET /api/facilities/{facilityId}/directory-insights

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-insights \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni gli insights aggregati delle schede di un brand su tutti gli editori.

Parametri

brandId `string` (obbligatorio) startDate `string` (obbligatorio) endDate `string` (obbligatorio)

GET /api/brands/{brandId}/directory-insights

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/directory-insights \
  -H "x-api-key: YOUR_API_KEY"

{}

Principali parole chiave di ricerca (con suddivisione tra brand e non brand) per una struttura, attualmente ricavate da Google Business Profile.

Parametri

facilityId `string` (obbligatorio) publisherId `string` (facoltativo) Il valore predefinito è "google": al momento è supportato solo Google. startDate `string` (obbligatorio) endDate `string` (obbligatorio) limit `string` (facoltativo)

GET /api/facilities/{facilityId}/directory-search-keywords

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-search-keywords \
  -H "x-api-key: YOUR_API_KEY"

{}

Principali parole chiave di ricerca per un brand, aggregate su tutte le strutture.

Parametri

brandId `string` (obbligatorio) startDate `string` (obbligatorio) endDate `string` (obbligatorio) limit `string` (facoltativo)

GET /api/brands/{brandId}/directory-search-keywords

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/directory-search-keywords \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le domande e risposte di una struttura.

Parametri

facilityId `string` (obbligatorio)

GET /api/facilities/{facilityId}/qna

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna \
  -H "x-api-key: YOUR_API_KEY"

{}

Rispondi a una domanda.

POST /api/facilities/{facilityId}/qna/{questionId}/answer

curl -X POST https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna/{questionId}/answer \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina una risposta.

DELETE /api/facilities/{facilityId}/qna/{questionId}/answer/{answerId}

curl -X DELETE https://portal.hub.gymsystems.co/api/facilities/{facilityId}/qna/{questionId}/answer/{answerId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce gli editori abilitati per l'organizzazione della struttura, con il relativo stato di connessione.

Parametri

facilityId `string` (obbligatorio) organisationId `string` (obbligatorio)

GET /api/facilities/{facilityId}/directory-publishers/resolved

curl -X GET https://portal.hub.gymsystems.co/api/facilities/{facilityId}/directory-publishers/resolved \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottieni le impostazioni condivise di Door & Gate Access di una struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/rules/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/rules/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna le impostazioni condivise di Door & Gate Access di una struttura

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/rules/{facilityId}

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/rules/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni le Access Policies di una struttura

La configurazione di accesso esistente viene convertita automaticamente in policy applicate equivalenti alla prima lettura.

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/policies/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Sostituisci le Access Policies con controllo ottimistico della revisione

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/policies/{facilityId}

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Crea una Access Policy

Parametri

facilityId `string` (obbligatorio)

POST /api/door-access/policies/{facilityId}

curl -X POST https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna una Access Policy

Parametri

facilityId `string` (obbligatorio) policyId `string` (obbligatorio)

PATCH /api/door-access/policies/{facilityId}/{policyId}

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elimina una Access Policy

Parametri

facilityId `string` (obbligatorio) policyId `string` (obbligatorio) revision `integer` (obbligatorio)

DELETE /api/door-access/policies/{facilityId}/{policyId}

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Duplica una Access Policy con un nuovo ID stabile

Parametri

facilityId `string` (obbligatorio) policyId `string` (obbligatorio)

POST /api/door-access/policies/{facilityId}/{policyId}/duplicate

curl -X POST https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId}/duplicate \
  -H "x-api-key: YOUR_API_KEY"

{}

Conta gli utenti e le porte interessati da tutte le Access Policies

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/policies/{facilityId}/impacts

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/impacts \
  -H "x-api-key: YOUR_API_KEY"

{}

Conta gli utenti e le porte interessati da una Access Policy

Parametri

facilityId `string` (obbligatorio) policyId `string` (obbligatorio)

GET /api/door-access/policies/{facilityId}/{policyId}/impact

curl -X GET https://portal.hub.gymsystems.co/api/door-access/policies/{facilityId}/{policyId}/impact \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca tipi di persona, stati e tag della struttura

Restituisce i valori distinti di tipo di persona, stato dell'iscrizione e tag presenti nelle righe User Access della struttura (ph-door-access-users), ricavati dalla sincronizzazione con i partner + inserimento manuale. L'applet door-gate-access li usa per popolare i menu a discesa delle regole di accesso. I tag sono l'unione dei `tags` sincronizzati e dei `customTags` amministrativi, come nel valutatore delle regole.

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/people-config/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/people-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca i controller delle porte di una struttura con le relative regole di Door & Gate Access effettive

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/doors/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Salva override per porta, icona e configurazione lato dispositivo

Unico punto di scrittura per tutto ciò che l'applet di amministrazione DGA modifica su una porta: - `accessRulesOverride` / `geofenceOverride`: passa `null` per cancellarli e tornare al valore predefinito della struttura. - `icon`: chiave stabile (vedi services/door-access/door-icons.js); i valori sconosciuti restituiscono 400. - `holdTimeSeconds` (1\u201330), `maintenanceMode` (`off` / `force-open` / `force-closed`), `doorLocation` (testo libero, \u226464 caratteri), `playNotificationSoundOnRelayToggle` (booleano), `autoUnlockSchedule` (griglia di finestre settimanali). Questi campi un tempo erano solo di Device Management, ma ora l'applet li scrive direttamente, così gli amministratori non devono lasciare il pannello della porta per le modifiche di configurazione quotidiane. Quando viene modificato uno qualsiasi dei campi lato dispositivo, la route invia anche le variabili d'ambiente Balena corrispondenti (`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`) e invia un comando MQTT `unlockUpdates`, così il dispositivo applica la nuova configurazione senza attendere il successivo aggiornamento delle variabili Balena. Best effort \u2014 la risposta è 200 anche se Balena è temporaneamente irraggiungibile.

Parametri

facilityId `string` (obbligatorio) doorId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/doors/{facilityId}/{doorId}/override

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/override \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Verifica leggera dello stato Balena per l'avviso di ricaricamento nel pannello della porta

Il pannello dell'applet DGA lo recupera in modo differito quando un amministratore apre una porta, per mostrare il testo corretto "il salvataggio ricaricherà il controller": la variante predefinita "pochi secondi" o quella più marcata "diversi minuti" quando è in sospeso anche un aggiornamento della release. Restituisce uno snapshot piatto ricavato da `balena.models.device.get()`. In caso di errore restituisce `data: null` (invece di un 5xx), così un'interruzione di Balena peggiora solo il testo dell'avviso invece di impedire l'apertura del pannello.

Parametri

facilityId `string` (obbligatorio) doorId `string` (obbligatorio)

GET /api/door-access/doors/{facilityId}/{doorId}/device-status

curl -X GET https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/device-status \
  -H "x-api-key: YOUR_API_KEY"

{}

Override amministrativo: sblocca una porta dall'applet

Attiva brevemente il relè usando l'attuale `holdTimeSeconds` della porta, scrivendo una riga di audit `admin-override` in ph-door-app-access-events, in modo che l'azione sia attribuibile nei Registri di accesso. Riesce sempre, anche con `maintenanceMode === 'force-closed'`: è la via d'uscita per gli amministratori. Restituisce 200 non appena viene inviata la pubblicazione MQTT; gli stati confermato / non riuscito / scaduto non vengono attesi qui (anche il flusso legacy /api/devices/door-controllers + /api/ics/devices/command è fire-and-forget).

Parametri

facilityId `string` (obbligatorio) doorId `string` (obbligatorio)

POST /api/door-access/doors/{facilityId}/{doorId}/unlock

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

{}

Riproduci una sequenza di segnali acustici di localizzazione sul controller della porta

Pubblica un comando MQTT `beep` affinché il controller emetta tre segnali acustici di media durata (~500 ms ciascuno, ~350 ms di pausa, ~2 s in totale). Usato dagli amministratori per individuare fisicamente un controller di porta sul posto. Il pulsante legacy di Device Management usa una raffica di ~30 s di segnali brevi, ma il driver del cicalino del firmware emette in modo affidabile solo il primo, quindi l'applet invia invece una sequenza più breve e affidabile. Nessuna riga di audit \u2014 azione diagnostica senza effetti sul controllo degli accessi.

Parametri

facilityId `string` (obbligatorio) doorId `string` (obbligatorio)

POST /api/door-access/doors/{facilityId}/{doorId}/identify

curl -X POST https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/identify \
  -H "x-api-key: YOUR_API_KEY"

{}

Riavvia da remoto un controller di porta

Pubblica lo stesso comando MQTT fire-and-forget `rebootDevice` che invia il pulsante legacy "Remotely Reboot Device" di Device Management, ma protetto dal modulo `door-gate-access`, così gli amministratori DGA possono riavviare un controller dalla sezione Avanzate del pannello della porta senza una concessione `device-management` separata. Restituisce 200 non appena la pubblicazione viene inviata; il dispositivo va offline per tutta la durata del riavvio.

Parametri

facilityId `string` (obbligatorio) doorId `string` (obbligatorio)

POST /api/door-access/doors/{facilityId}/{doorId}/reboot

curl -X POST https://portal.hub.gymsystems.co/api/door-access/doors/{facilityId}/{doorId}/reboot \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le righe User Access di una struttura

Restituisce tutte le righe user-access non eliminate della struttura. Supporta filtri lato client (source, search, accessEnabled, hasGrants). Il calcolo lato server `hideExcluded` della Fase 4 verrà aggiunto quando sarà disponibile il valutatore delle concessioni ibride; per ora il parametro è accettato ma restituisce l'insieme completo.

Parametri

facilityId `string` (obbligatorio) search `string` (facoltativo) source `string` (facoltativo) accessEnabled `string` (facoltativo) hasGrants `string` (facoltativo) hideExcluded `boolean` (facoltativo) Se true, gli utenti sincronizzati (source != manual) che non potrebbero passare da nessuna porta in nessun momento in questa struttura vengono nascosti. La risposta include un oggetto `hidden: { count, sample }`.

GET /api/door-access/users/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea manualmente una riga User Access in una struttura

Crea una nuova riga con `source: 'manual'`. Restituisce 409 con `existingUserId` se il telefono o l'email forniti corrispondono già a una riga in questa struttura.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/users/{facilityId}

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Ottieni una singola riga User Access

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

GET /api/door-access/users/{facilityId}/{userId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiornamento parziale di una riga User Access

Modifica qualsiasi sottoinsieme dei campi di identità / autorizzazione. Passa `null` per cancellare un campo facoltativo. Restituisce 409 se il nuovo telefono o la nuova email coincidono con un'altra riga nella stessa struttura. `appMessage` accetta la stessa struttura del messaggio a livello di struttura su PUT /api/door-access/rules/{facilityId}: testo, gravità, link facoltativo, pianificazione facoltativa di inizio/fine. L'app mobile mostra questo messaggio nella dashboard solo all'utente destinatario.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

Corpo della richiesta

PATCH /api/door-access/users/{facilityId}/{userId}

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Eliminazione reversibile di una riga User Access

Contrassegna la riga con `deleted: true` e disattiva l'accesso. Il collegamento del registro di controllo allo userId viene mantenuto; gli amministratori possono riattivarla manualmente.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

DELETE /api/door-access/users/{facilityId}/{userId}

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Attribuzione dell'accesso per porta di un utente

Per ogni porta restituisce l'autorizzazione deterministica corrente (`allowedNow`, `allowedVia`, `deniedReason`) e i percorsi configurati per Access Policies, concessioni permanenti, pianificazioni delle policy, concessioni di finestre temporali amministrative e finestre aggiornate delle origini partner mappate. Restituisce anche la disponibilità attiva/successiva e l'aggiornamento delle origini. Il blockAllAccess della porta e la manutenzione vengono valutati prima di tutti i percorsi di autorizzazione.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

GET /api/door-access/users/{facilityId}/{userId}/effective-access

curl -X GET https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/effective-access \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea in blocco righe User Access da un'importazione CSV

Crea più righe `source: 'manual'` in un'unica richiesta, riutilizzando la stessa convalida, normalizzazione di telefono/email, verifica dei conflitti per struttura, messaggistica automatica e logica di invito (facoltativa) della singola creazione. Le righe vengono elaborate in ordine, quindi una riga successiva che coincide con una creata in precedenza viene segnalata come duplicato. Le concessioni vengono fornite come ID di porte/gruppi già risolti (il client risolve i nomi in ID). Le concessioni di finestre temporali vengono intenzionalmente rifiutate in blocco e devono essere aggiunte tramite l'endpoint di sostituzione per utente dopo l'importazione. Non genera mai eccezioni per riga; l'esito di ogni riga viene segnalato singolarmente.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/users/{facilityId}/bulk

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Sostituisci le concessioni di autorizzazione ibrida di una riga User Access

Interfaccia del valutatore ibrido della Fase 3. Le concessioni coesistono con le regole basate sui tag della struttura: un utente è autorizzato quando una delle due corrisponde al momento dello sblocco.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/users/{facilityId}/{userId}/grants

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/grants \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Sostituisci le concessioni aggiuntive di Access Time Window di una riga User Access

Sostituisce solo `timeWindowGrants`; le `grants` permanenti e le `sourceTimeWindows` delle integrazioni restano invariate. Ogni elemento richiede un ambito (`facilityWide`, `doors` o `groups`) e una `window` assoluta o settimanale. L'invio di un array vuoto cancella esplicitamente tutte le finestre amministrative.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/users/{facilityId}/{userId}/time-window-grants

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/time-window-grants \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Blocca una riga User Access rispetto agli aggiornamenti di sincronizzazione dall'origine

Imposta `decoupledFromSource: true`, cancella tutte le `sourceTimeWindows` gestite dalle integrazioni e fa sì che la sincronizzazione (cron + stream) registri e salti questa riga finché un amministratore non cancella il flag tramite /recouple.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

POST /api/door-access/users/{facilityId}/{userId}/decouple

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/decouple \
  -H "x-api-key: YOUR_API_KEY"

{}

Ricollega una riga User Access agli aggiornamenti di sincronizzazione dall'origine

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

POST /api/door-access/users/{facilityId}/{userId}/recouple

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/recouple \
  -H "x-api-key: YOUR_API_KEY"

{}

Revoca tutti i token di aggiornamento dell'app Door & Gate Access di un utente

Revoca in base al telefono/email salvati dell'utente (la tabella dei token di aggiornamento ha come chiave `sha256(plaintext)`; i GSI byMobilePhone / byEmail ci consentono di eliminare a ventaglio partendo da un singolo utente). Anche altri utenti che condividono lo stesso telefono/email in un'altra struttura verrebbero disconnessi.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

POST /api/door-access/users/{facilityId}/{userId}/logout

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/logout \
  -H "x-api-key: YOUR_API_KEY"

{}

Invia (di nuovo) a un utente l'email di invito all'app Door & Gate Access

Forza l'invio dell'email di invito al download dell'app all'indirizzo email salvato dell'utente (solo email; nessun SMS). Ignora i controlli di idoneità e di invio già effettuato usati dal percorso di sincronizzazione automatica: si tratta di un'azione amministrativa esplicita. Restituisce 400 se l'utente non ha un'email registrata.

Parametri

facilityId `string` (obbligatorio) userId `string` (obbligatorio)

POST /api/door-access/users/{facilityId}/{userId}/resend-invite

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/{userId}/resend-invite \
  -H "x-api-key: YOUR_API_KEY"

{}

Anteprima dei destinatari di un invio in blocco di inviti all'app

Calcola l'insieme degli utenti che riceverebbero un'email di invito all'app. L'insieme di base comprende tutti gli utenti non eliminati con un'email che non hanno mai usato l'app (`appLastSeenAt` vuoto). Per impostazione predefinita l'insieme è ristretto agli utenti che hanno attualmente accesso (corrispondenza di regola o concessione) e non sono mai stati invitati; `includeAlreadyInvited` e `includeNoAccess` lo ampliano. Non viene inviata alcuna email: restituisce i conteggi, un piccolo campione e gli userId candidati per l'endpoint di esecuzione.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/users/{facilityId}/bulk-invite/preview

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk-invite/preview \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Invia le email di invito all'app a un gruppo di utenti

Invia l'email di invito al download dell'app a ciascuno degli userId forniti (massimo 50 per richiesta; il client suddivide in lotti l'elenco completo dei candidati ricavato dall'anteprima). Ogni utente viene riconvalidato al momento dell'invio: le righe che non esistono più, non hanno un'email o hanno usato l'app dopo l'anteprima vengono saltate, mai segnate come non riuscite. Gli esiti per utente vengono segnalati singolarmente, così il client può riepilogare inviati / non riusciti / saltati.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/users/{facilityId}/bulk-invite

curl -X POST https://portal.hub.gymsystems.co/api/door-access/users/{facilityId}/bulk-invite \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenca i gruppi di porte di una struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/door-groups/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Crea un gruppo di porte

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/door-groups/{facilityId}

curl -X POST https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Ottieni un singolo gruppo di porte

Parametri

facilityId `string` (obbligatorio) groupId `string` (obbligatorio)

GET /api/door-access/door-groups/{facilityId}/{groupId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna un gruppo di porte

Parametri

facilityId `string` (obbligatorio) groupId `string` (obbligatorio)

Corpo della richiesta

PATCH /api/door-access/door-groups/{facilityId}/{groupId}

curl -X PATCH https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Eliminazione reversibile di un gruppo di porte

Parametri

facilityId `string` (obbligatorio) groupId `string` (obbligatorio)

DELETE /api/door-access/door-groups/{facilityId}/{groupId}

curl -X DELETE https://portal.hub.gymsystems.co/api/door-access/door-groups/{facilityId}/{groupId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca le integrazioni con i partner configurate in una struttura

Restituisce le integrazioni con i partner della struttura (id, nome, logo, abilitazione) unendo ph-facility-partner-config con il catalogo ph-partners. Con ambito door-gate-access (così gli amministratori senza accesso alle integrazioni esterne possono comunque visualizzare i badge dei partner e l'elenco di sincronizzazione per partner).

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/partners/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/partners/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Leggi la configurazione di sincronizzazione User Access di una struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/sync-config/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/sync-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione di sincronizzazione User Access di una struttura

Sono accettati solo i campi controllati dagli amministratori (`enabled`, `requireIdentifier` e la mappa `partners` dei partner); `lastRunAt` e `lastRunCounts` vengono scritti dal motore di sincronizzazione stesso. `partner.partners` è una mappa di abilitazione per partner con chiave partnerId (opt-out): quando l'interruttore principale `partner.enabled` è attivo, un partner si sincronizza a meno che non abbia qui una voce esplicita `{ enabled: false }`.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/sync-config/{facilityId}

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/sync-config/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Leggi la configurazione della messaggistica automatica per utente di una struttura

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/auto-messages/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione della messaggistica automatica per utente di una struttura

Salva le regole, poi rivaluta immediatamente ogni riga User Access della struttura, così gli utenti esistenti ricevono o perdono subito il proprio messaggio automatico. I messaggi manuali e le righe scollegate restano invariati.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/auto-messages/{facilityId}

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Stato della rivalutazione in background dei messaggi automatici

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/auto-messages/{facilityId}/sweep-status

curl -X GET https://portal.hub.gymsystems.co/api/door-access/auto-messages/{facilityId}/sweep-status \
  -H "x-api-key: YOUR_API_KEY"

{}

Esegui su richiesta una sincronizzazione User Access per una struttura

Esamina in modo sincrono ogni origine abilitata (partner / cctv) della struttura e allinea le righe ph-door-access-users tramite la cascata di deduplicazione. Restituisce i conteggi per origine. Le origini disattivate compaiono come `skippedSyncDisabled: 1` invece di essere assenti, così l'interfaccia può mostrare entrambe le righe in modo coerente.

Parametri

facilityId `string` (obbligatorio)

POST /api/door-access/sync/{facilityId}/run

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/run \
  -H "x-api-key: YOUR_API_KEY"

{}

Anteprima di prova di un'eliminazione in blocco degli utenti sincronizzati dai partner

Restituisce il conteggio + un campione delle righe user-access che verrebbero eliminate in modo reversibile, più un confirmToken che deve essere rimandato all'endpoint di esecuzione. Nessun dato viene modificato. I registri di accesso non vengono mai toccati.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/sync/{facilityId}/bulk-delete/preview

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/bulk-delete/preview \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Esegui un'eliminazione in blocco degli utenti sincronizzati dai partner (eliminazione reversibile)

Elimina in modo reversibile ogni riga user-access sincronizzata dai partner nell'ambito. Richiede il confirmToken restituito dall'anteprima; se l'insieme attuale è cambiato dall'anteprima, il token non corrisponde e la richiesta viene rifiutata (409), così l'amministratore la riesamina. I registri di accesso vengono conservati.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

POST /api/door-access/sync/{facilityId}/bulk-delete

curl -X POST https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/bulk-delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Attività recente di sincronizzazione User Access (registro per la risoluzione dei problemi)

Restituisce gli esiti di sincronizzazione più recenti di una struttura (creato / saltato / disattivato) con il motivo, così gli amministratori possono capire perché un membro è stato o non è stato sincronizzato. Dal più recente.

Parametri

facilityId `string` (obbligatorio) limit `integer` (facoltativo)

GET /api/door-access/sync/{facilityId}/log

curl -X GET https://portal.hub.gymsystems.co/api/door-access/sync/{facilityId}/log \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca gli eventi Door & Gate Access di una struttura

Restituisce gli eventi di sblocco da app mobile, da override amministrativo e dalla Partner API esterna in un unico flusso in ordine cronologico inverso.

Parametri

facilityId `string` (obbligatorio) from `integer` (facoltativo) to `integer` (facoltativo) limit `integer` (facoltativo)

GET /api/door-access/events/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/events/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Simula una valutazione del geofence per il segnaposto della modalità di test amministrativa

Corpo della richiesta

POST /api/door-access/geofence/test

curl -X POST https://portal.hub.gymsystems.co/api/door-access/geofence/test \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Ottieni lo stato di onboarding / attivazione di una struttura

Alimenta la pagina iniziale "Get Started" dell'applet e il banner di avanzamento della configurazione. Restituisce i conteggi in tempo reale di porte e utenti, i due passaggi principali derivati (esiste un utente, esiste una porta), i flag facoltativi "reviewed" salvati e se la struttura è attivata (entrambi i passaggi principali completati). La prima volta che una struttura viene attivata, viene registrato il timestamp activatedAt.

Parametri

facilityId `string` (obbligatorio)

GET /api/door-access/onboarding/{facilityId}

curl -X GET https://portal.hub.gymsystems.co/api/door-access/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna i flag di onboarding facoltativi "reviewed" di una struttura

Salva i flag facoltativi dell'elenco di controllo della configurazione che un amministratore spunta (regole di accesso, impostazioni di sincronizzazione, geofencing). I passaggi principali e l'attivazione sono ricavati in tempo reale dai conteggi dei dati e non possono essere impostati qui. Restituisce lo stato di onboarding completo aggiornato.

Parametri

facilityId `string` (obbligatorio)

Corpo della richiesta

PUT /api/door-access/onboarding/{facilityId}

curl -X PUT https://portal.hub.gymsystems.co/api/door-access/onboarding/{facilityId} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/lead-events

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/lead-events \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/page-views

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/page-views \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/referrers

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/referrers \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/socials

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/socials \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/top-cities

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/top-cities \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/total-page-views

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/total-page-views \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce una risposta JSON con i dati di analisi della struttura.

Parametri

clubId `string` (facoltativo) L'ID della struttura di cui recuperare i dati di analisi. fromDate `string` (facoltativo) La data di inizio dei dati di analisi da recuperare. toDate `string` (facoltativo) La data di fine dei dati di analisi da recuperare.

GET /clubs/{clubId}/analytics/traffic

curl -X GET https://portal.hub.gymsystems.co/clubs/{clubId}/analytics/traffic \
  -H "x-api-key: YOUR_API_KEY"

{}

Genera un JWT (JSON Web Token) front-end temporaneo per i grafici incorporabili di Google Analytics nella pagina front-end 'analytics'.

GET /api/ga/onetimetoken

curl -X GET https://portal.hub.gymsystems.co/api/ga/onetimetoken \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i widget del pannello di controllo da 'The Training Camp' se la struttura ha membri attivi.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/reporting/apps/widgets/{club}

curl -X GET https://portal.hub.gymsystems.co/api/reporting/apps/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce tutte le festività della struttura non ancora verificate.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/reporting/club/{club}/unreviewed-holidays

curl -X GET https://portal.hub.gymsystems.co/api/reporting/club/{club}/unreviewed-holidays \
  -H "x-api-key: YOUR_API_KEY"

{}

Imposta come verificate tutte le festività della struttura non ancora verificate.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

PUT /api/reporting/club/{club}/review-holidays

curl -X PUT https://portal.hub.gymsystems.co/api/reporting/club/{club}/review-holidays \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce il report KPI in formato CSV, suddiviso mese per mese negli ultimi 12 mesi. *NOTA* Crea un unico report per TUTTE le strutture del sistema: non eseguirlo più volte in parallelo, altrimenti sovraccaricherai GymMaster!

Parametri

months `string` (facoltativo) Numero di mesi (dalla data corrente) da recuperare (predefinito 12)

GET /api/reporting/gymmaster/all-clubs-kpi-report

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/all-clubs-kpi-report \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i grafici dei ricavi dell'MMS per una determinata struttura.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. range `string` (facoltativo) Intervallo in giorni (a ritroso dalla data corrente) da recuperare

GET /api/reporting/gymmaster/revenuegraph/{club}

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/revenuegraph/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dati/le analisi MMS (Member Management System) del pannello di controllo per una determinata struttura. I dati includono le statistiche di GymMaster/Perfect Gym e altre metriche interne raccolte dal nostro sistema.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere. range `string` (facoltativo) Intervallo in giorni (a ritroso dalla data corrente) da recuperare

GET /api/reporting/gymmaster/widgets/{club}

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce i dati del widget Myzone del pannello di controllo per una determinata struttura.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/reporting/myzone/widgets/{club}

curl -X GET https://portal.hub.gymsystems.co/api/reporting/myzone/widgets/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce un oggetto con i servizi considerati offline da uno o più dei nostri endpoint di pagina di stato/monitoraggio, configurati tramite lo strumento interno 'Uptime Kuma'.

GET /api/reporting/statuspage/events

curl -X GET https://portal.hub.gymsystems.co/api/reporting/statuspage/events \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce le prenotazioni di allenamenti in programma nei prossimi 7 giorni.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi accedere.

GET /api/reporting/clubs/{club}/workout-bookings

curl -X GET https://portal.hub.gymsystems.co/api/reporting/clubs/{club}/workout-bookings \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce l'elenco delle festività storiche di una struttura.

Parametri

clubId `string` (facoltativo) ID del club fromDate `string` (facoltativo) Timestamp Unix della data di inizio dell'intervallo di festività da restituire. toDate `string` (facoltativo) Timestamp Unix della data di fine dell'intervallo di festività da restituire.

GET /api/clubs/{clubId}/historical-holidays

curl -X GET https://portal.hub.gymsystems.co/api/clubs/{clubId}/historical-holidays \
  -H "x-api-key: YOUR_API_KEY"

{}

Restituisce le automazioni dei dispositivi associate alla struttura.

Parametri

club `string` (obbligatorio) ID interno del club di cui vuoi elencare i dispositivi.

GET /api/ics/automations/list/{club}

curl -X GET https://portal.hub.gymsystems.co/api/ics/automations/list/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione di un display/dispositivo esistente.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/ics/automations/update/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/automations/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiunge/associa un dispositivo schermo fisico o un computer alla tua struttura.

Parametri

club `string` (obbligatorio) ID interno del club a cui vuoi aggiungere il dispositivo. body `string` (obbligatorio) Oggetto JSON del nuovo schermo da associare.

POST /api/ics/devices/add/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/add/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Indica al dispositivo di connettersi a un nuovo SSID in base ai parametri.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/ics/devices/changewifi/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/changewifi/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione di un display/dispositivo esistente.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/ics/devices/command/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/command/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Carica un URL/una pagina web sullo schermo di un dispositivo specifico.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

POST /api/ics/devices/loadurl/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/devices/loadurl/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione di un display/dispositivo esistente.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

PUT /api/ics/devices/update/{club}

curl -X PUT https://portal.hub.gymsystems.co/api/ics/devices/update/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Rinomina un display/dispositivo. Solo registrazione: a differenza dell'endpoint di aggiornamento, non invia nulla al dispositivo, quindi è disponibile anche per gli schermi che eseguono una build software a fine vita.

Parametri

club `string` (obbligatorio) ID interno della struttura a cui appartiene il dispositivo. body `string` (obbligatorio) Oggetto JSON con i parametri di ridenominazione.

PUT /api/ics/devices/rename/{club}

curl -X PUT https://portal.hub.gymsystems.co/api/ics/devices/rename/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottiene i widget e i link ai contenuti multimediali offline di una struttura, in base alla data fornita.

Parametri

club `string` (obbligatorio) ID interno della struttura di cui vuoi modificare il templated content. date `string` (obbligatorio) Data per cui restituire gli URL dei widget: usa il formato `YYYY-MM-DD`.

GET /api/ics/external-resources/{club}

curl -X GET https://portal.hub.gymsystems.co/api/ics/external-resources/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Ottiene i widget e i link ai contenuti multimediali offline di una struttura, in base alla data fornita.

Parametri

club `string` (obbligatorio) ID interno della struttura di cui vuoi modificare il templated content.

GET /api/ics/list-scheduled-workouts/{club}

curl -X GET https://portal.hub.gymsystems.co/api/ics/list-scheduled-workouts/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Modifica il templated content di una determinata struttura.

Parametri

club `string` (obbligatorio) ID interno della struttura di cui vuoi modificare il templated content. body `string` (obbligatorio) Oggetto JSON del nuovo templated content da applicare.

POST /api/ics/loadprogram/{club}

curl -X POST https://portal.hub.gymsystems.co/api/ics/loadprogram/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera la configurazione del templated content di un display/dispositivo esistente.

Parametri

club `string` (obbligatorio) ID interno della struttura di cui vuoi recuperare i dati del templated content.

GET /api/ics/programs/{club}

curl -X GET https://portal.hub.gymsystems.co/api/ics/programs/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Aggiorna la configurazione del templated content di un display/dispositivo esistente.

Parametri

club `string` (obbligatorio) ID interno della struttura in cui vuoi aggiornare il dispositivo. body `string` (obbligatorio) Oggetto JSON dei parametri di aggiornamento.

PUT /api/ics/programs/{club}

curl -X PUT https://portal.hub.gymsystems.co/api/ics/programs/{club} \
  -H "x-api-key: YOUR_API_KEY"

{}

Recupera le opzioni di configurazione del templated content.

GET /api/ics/programs/options/{facilityID}

curl -X GET https://portal.hub.gymsystems.co/api/ics/programs/options/{facilityID} \
  -H "x-api-key: YOUR_API_KEY"

{}

Chat con contesto RAG: non ha accesso agli strumenti, solo a un semplice strumento di richiesta|risposta API che consente di recuperare direttamente le conoscenze dalla knowledge base.

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione (rilevato automaticamente se non fornito)

Corpo della richiesta

POST /api/llm/chat

curl -X POST https://portal.hub.gymsystems.co/api/llm/chat \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elimina gli embedding degli articoli dal vector store e aggiorna lo stato di tracciamento degli embedding

Corpo della richiesta

DELETE /api/llm/delete-article

curl -X DELETE https://portal.hub.gymsystems.co/api/llm/delete-article \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Elenca i record del tracker degli embedding per organizzazione e stato

Parametri

organisationId `string` (facoltativo) ID dell'organizzazione (risolto automaticamente se omesso) status `string` (obbligatorio) Stato da filtrare (deve essere uno tra in_queue, done, anomaly, fail, deleted) Limit `string` (facoltativo) Numero massimo di elementi per pagina LastEvaluatedKey `string` (facoltativo) JSON del LastEvaluatedKey di DynamoDB per la paginazione

GET /api/llm/embedding-track/by-org-and-status

curl -X GET https://portal.hub.gymsystems.co/api/llm/embedding-track/by-org-and-status \
  -H "x-api-key: YOUR_API_KEY"

{}

Elenca i record del tracker degli embedding per organizzazione (con filtro facoltativo per tipo di risorsa)

Parametri

organisationId `string` (facoltativo) ID dell'organizzazione (risolto automaticamente se omesso) resourceType `string` (facoltativo) Tipo di risorsa facoltativo (ad es. "article"). Se fornito, filtra i record in cui resourceTypeId inizia con "{type}#". Limit `string` (facoltativo) Numero massimo di elementi per pagina LastEvaluatedKey `string` (facoltativo) JSON del LastEvaluatedKey di DynamoDB per la paginazione

GET /api/llm/embedding-track/by-org

curl -X GET https://portal.hub.gymsystems.co/api/llm/embedding-track/by-org \
  -H "x-api-key: YOUR_API_KEY"

{}

Inizializza la raccolta del database vettoriale dell'organizzazione

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione (rilevato automaticamente se non fornito)

POST /api/llm/init-org

curl -X POST https://portal.hub.gymsystems.co/api/llm/init-org \
  -H "x-api-key: YOUR_API_KEY"

{}

Ricerca semantica nella knowledge base

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione (rilevato automaticamente se non fornito)

Corpo della richiesta

POST /api/llm/semantic-search

curl -X POST https://portal.hub.gymsystems.co/api/llm/semantic-search \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Avvia l'elaborazione in streaming degli articoli in coda per l'embedding, con aggiornamenti di avanzamento in tempo reale

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione (rilevato automaticamente se non fornito)

POST /api/llm/start-embedding-stream

curl -X POST https://portal.hub.gymsystems.co/api/llm/start-embedding-stream \
  -H "x-api-key: YOUR_API_KEY"

{}

Inserisce o aggiorna gli embedding degli articoli nel database vettoriale

Gestisce l'embedding degli articoli in base allo stato corrente: - Se l'articolo non è pubblicato OPPURE è privato: elimina gli embedding - Se l'articolo è pubblicato E pubblico: ricrea gli embedding con il contenuto completo Richiede sempre il corpo completo dell'articolo.

Parametri

organisationId `string` (facoltativo) L'ID dell'organizzazione (rilevato automaticamente se non fornito)

Corpo della richiesta

POST /api/llm/upsert-embeddings

curl -X POST https://portal.hub.gymsystems.co/api/llm/upsert-embeddings \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Endpoint di test per eliminare in blocco gli embedding degli articoli per organizzazione e stato facoltativo

Parametri

organisationId `string` (facoltativo) ID dell'organizzazione (risolto automaticamente dal contesto utente se omesso) status `string` (facoltativo) Stato da filtrare (facoltativo: se omesso, elimina TUTTI gli articoli dell'organizzazione indipendentemente dallo stato) hardDelete `string` (facoltativo) Indica se eliminare definitivamente i record di tracciamento degli embedding (true) o eliminarli in modo reversibile aggiornandone lo stato (false)

DELETE /api/llm/test/batch-delete-by-status

curl -X DELETE https://portal.hub.gymsystems.co/api/llm/test/batch-delete-by-status \
  -H "x-api-key: YOUR_API_KEY"

{}

Trasforma e suddivide il testo in blocchi con statistiche dettagliate

Endpoint di test che trasforma il testo e lo suddivide in blocchi, quindi fornisce statistiche dettagliate sulla distribuzione dei blocchi, inclusi conteggi di caratteri, percentuali e metriche di qualità, per aiutare a valutare l'efficacia della suddivisione.

Corpo della richiesta

POST /api/llm/test/transform-chunk

curl -X POST https://portal.hub.gymsystems.co/api/llm/test/transform-chunk \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}