Introduction

Bienvenue dans l'API Performance Hub. Cette API gère les données des clubs et les systèmes clés qui s'intègrent à votre club et à ses systèmes externes. Il ne s'agit pas d'une API publique. Pour en savoir plus sur l'utilisation des différents systèmes Performance Hub pris en charge par cette API, consultez l'entrée correspondant au système souhaité dans notre [documentation Performance Hub](https://docs.performancehub.co).

https://portal.hub.gymsystems.co

Authentification

Les informations d'authentification vous seront communiquées une fois votre intégration approuvée.

Événement « tour de l'agent terminé » signalé par l'appareil (déclencheur de notification web push)

Appelé par le sidecar d'un appareil AI Agent appairé (jamais par un navigateur) lorsqu'une exécution de l'agent lancée depuis l'interface web se termine après avoir duré plus longtemps que le seuil de notification de l'appareil. Authentifié par un JWT HS256 de courte durée propre à l'appareil (aud 'events'). Dédoublonné par appareil+session+début et limité en débit par appareil, puis envoyé aux abonnements push HTML5 de l'utilisateur à l'origine de l'exécution, avec un lien direct vers la conversation.

Corps de la requête

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 '{}'

{}

Notification push initiée par l'agent (skill ph-notify)

Appelé par le sidecar d'un appareil AI Agent appairé pour le compte de l'agent embarqué (la skill ph-notify) afin d'envoyer une notification quelconque vers le navigateur et les appareils mobiles d'un utilisateur. Authentifié par un JWT HS256 de courte durée propre à l'appareil (aud 'events'). L'utilisateur cible doit avoir accès à l'appareil (politique d'accès par agent) ; s'il est omis, la notification est envoyée au propriétaire de l'appareil. Limité en débit par appareil, indépendamment des événements de fin de tour.

Corps de la requête

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 '{}'

{}

Envoyer une image de notification (skill ph-notify)

Accepte un corps d'image brut provenant d'un appareil appairé (JWT aud 'events') et le stocke dans le bucket public notify-media sous une clé UUID impossible à deviner. Les objets sont supprimés automatiquement après 7 jours (cycle de vie S3). Renvoie l'URL https publique à utiliser comme `imageUrl` dans /ai/events/agent-notify. Taille maximale de 5 Mo ; png/jpeg/gif/webp uniquement.

Corps de la requête

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 '{}'

{}

Relais MCP d'appareil pour Connected Apps (outils SaaS externes)

Point de terminaison MCP Streamable HTTP pour les appareils Agent IA appairés (serveur MCP "connected_apps" sur l'écouteur :8790 du sidecar de l'appareil). Authentifié par un JWT HS256 de courte durée propre à chaque appareil (aud 'mcp', même identifiant que /mcp) et conditionné par l'indicateur d'activation Connected Apps de l'AGENT (les connexions sont propres à chaque appareil agent, pas à chaque installation). Les requêtes sont transmises en flux au serveur MCP de session de la plateforme d'outils en amont de l'agent, avec les en-têtes de session injectés côté serveur ; les identifiants en amont n'atteignent jamais l'appareil. Les noms d'outils et la marque du fournisseur sont passés en marque blanche dans les deux sens pendant le transit. Une erreur 401/410 en amont (session expirée) déclenche une recréation de session et une nouvelle tentative.

POST /mcp/apps

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

{}

Rechercher dans les journaux d'audit de l'API (accès au module IAM & Admin)

Recherchez et filtrez les journaux d'accès à l'API grâce à des options de filtrage avancées. Les utilisateurs ne voient que les journaux des organisations auxquelles ils ont accès.

Paramètres

organisationId `string` (facultatif) ID de l'organisation pour la vérification des ACL (obligatoire)

Corps de la requête

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 '{}'

{}

Obtenir les statistiques des journaux d'audit mises en cache dans Redis (accès au module IAM & Admin)

Récupère les statistiques agrégées depuis le cache Redis pour un chargement instantané du tableau de bord

Paramètres

timeWindow `string` (facultatif) Fenêtre de temps des statistiques (12h par défaut)

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"

{}

Obtenir les statistiques des journaux d'audit (accès au module IAM & Admin)

Récupère les statistiques agrégées pour le tableau de bord. Limité aux organisations de l'utilisateur.

Paramètres

startTime `number` (facultatif) Heure de début (horodatage Unix), par défaut il y a 24 heures endTime `number` (facultatif) Heure de fin (horodatage Unix), par défaut maintenant

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"

{}

Obtenir les séries temporelles des journaux d'audit (accès au module IAM & Admin)

Récupère des séries temporelles regroupées par intervalles pour la visualisation chronologique des requêtes

Paramètres

timeWindow `string` (facultatif) Fenêtre de temps des séries temporelles : - 1h : dernière heure (blocs de 10 minutes) - 12h : 12 dernières heures (blocs de 10 minutes) - 24h : 24 dernières heures (blocs de 10 minutes) - 7d : 7 derniers jours (blocs d'une heure) - 14d : 14 derniers jours (blocs d'une heure)

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"

{}

Obtenir les organisations dont l'utilisateur peut consulter les journaux d'audit (accès au module IAM & Admin)

Renvoie la liste des organisations dont l'utilisateur actuel peut consulter les journaux d'audit

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"

{}

Appel initial pour créer un nouveau club. Notez que seul l'objet club « modèle » est créé : une seconde requête API est ensuite nécessaire pour compléter le club avec ses données, comme les horaires d'ouverture, l'emplacement, les URL des réseaux sociaux, etc.

Paramètres

body `string` (obligatoire) Objet JSON du nouveau club à ajouter au système.

POST /api/admin/clubs/addclub

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

{}

Ajoute un nouvel utilisateur au système

Paramètres

body `string` (obligatoire) Objet JSON des données utilisateur à ajouter ou mettre à jour.

POST /api/users

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

{}

Répertorie tous les utilisateurs (comptes Google Apps) ayant accès au système et à l'API de back-office

GET /api/admin/users/listusers

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

{}

Répertorie les clés MCP d'un utilisateur (masquées). Les utilisateurs peuvent répertorier leurs propres clés.

Paramètres

userId `string` (obligatoire)

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"

{}

Crée une nouvelle clé API MCP pour un utilisateur. Les utilisateurs peuvent créer leurs propres clés.

Paramètres

userId `string` (obligatoire) body `object` (facultatif)

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"

Révoque ou supprime une clé API MCP. Les utilisateurs peuvent supprimer leurs propres clés.

Paramètres

userId `string` (obligatoire) keyId `string` (obligatoire)

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"

{}

Retirer un rôle à un utilisateur

Paramètres

userId `string` (facultatif) Adresse e-mail de l'utilisateur auquel retirer le rôle. roleId `string` (facultatif) ID du rôle à retirer à l'utilisateur.

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"

{}

Met à jour les informations de profil d'un utilisateur existant (firstName, lastName, phoneNumber)

Paramètres

userId `string` (obligatoire) Adresse e-mail de l'utilisateur body `object` (obligatoire) Données du profil utilisateur à mettre à jour

PATCH /api/users/{userId}

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

{}

Créer ou mettre à jour un rôle utilisateur

Paramètres

body `object` (facultatif)

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 exécutés sur l'AI Agent d'une installation (sélecteur de publication)

Récupère via le tunnel les Live Services détectés par le bridge de l'appareil, pour le sélecteur « Publish to Performance Hub » de l'applet. Nécessite le module ph-ai-agent ET un accès 'open' à l'appareil (même exigence que pour la publication). Chaque service est annoté avec publishedAppId lorsqu'une Custom App existe déjà pour son port.

Paramètres

club `string` (obligatoire) device `string` (obligatoire)

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"

{}

Index des noms d'icônes MDI intégré à l'AI Agent d'une installation (sélecteur d'icônes)

Relaie via le tunnel l'index d'icônes MDI intégré au bridge de l'appareil (GET /__services/icons/mdi/index.json). Le sélecteur de publication et de modification utilise le catalogue fourni avec l'applet (même version épinglée 7.4.47) ; les SVG des applications publiées sont résolus à partir du paquet @mdi/js local de portal-server. Même exigence d'accès que le sélecteur de services (module ph-ai-agent + accès 'open' à l'appareil).

Paramètres

club `string` (obligatoire) device `string` (obligatoire)

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"

{}

Récupérer un lot de SVG d'icônes MDI depuis l'AI Agent d'une installation (aperçus du sélecteur)

Résout en un seul appel jusqu'à 60 glyphes MDI nommés à partir du jeu d'icônes intégré à l'appareil, nettoyés côté serveur avec la même liste d'autorisation que les icônes d'application enregistrées. Utilisé par le sélecteur d'icônes pour afficher les résultats de recherche ; les noms inconnus renvoient null.

Paramètres

club `string` (obligatoire) device `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Audiences auxquelles le demandeur peut publier depuis cette installation

Périmètre d'audience que l'éditeur peut accorder, pour le sélecteur de publication et de modification : les installations couvertes par ses rôles ph-ai-agent (portée multi-installations), et s'il dispose du niveau organisation requis pour les audiences couvrant toute la marque ou toute l'organisation de cette installation. Les mêmes règles sont de nouveau appliquées côté serveur lors de la publication ou de la mise à jour (validatePublishAudience) : ce point de terminaison ne sert qu'à adapter l'interface.

Paramètres

club `string` (obligatoire)

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"

{}

Suggestions d'utilisateurs pour l'audience nominative d'une application

Recherche UNIQUEMENT parmi les utilisateurs que le demandeur voit déjà : les personnes dont les rôles recoupent au moins une installation, région ou organisation de son propre accès ph-ai-agent. Une requête d'au moins 2 caractères et une limite de 10 résultats rendent ce point de terminaison inutilisable pour l'extraction de données ; le même périmètre est de nouveau appliqué côté serveur lors de l'enregistrement de l'audience.

Paramètres

club `string` (obligatoire) q `string` (obligatoire)

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"

{}

Publier un Live Service AI Agent en tant que Custom App Performance Hub

Enregistre une application web hébergée par l'AI Agent de l'installation (un Live Service détecté par le bridge) comme élément du menu latéral « Custom Apps » pour l'audience choisie. Nécessite le module ph-ai-agent dans cette installation ET un accès 'open' à l'appareil ; l'audience est limitée par les portées de rôle de l'éditeur (vous ne pouvez jamais publier au-delà de ce que vous pouvez atteindre). L'identité du service est résolue EN DIRECT à partir de la liste /__services de l'appareil ; le schéma http/https n'est jamais enregistré.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 Apps publiées visibles dans cette installation

Renvoie les applications publiées actives dont l'audience couvre cette installation, sous la forme affichée par le menu latéral (appId, name, icon, description). L'audience est de nouveau résolue en direct à chaque appel, si bien que les changements d'accès prennent effet immédiatement.

Paramètres

club `string` (obligatoire)

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"

{}

Applications publiées gérées depuis cette installation (vue de l'éditeur)

Lignes complètes des applications dont l'installation d'ORIGINE est ce club, pour la liste de gestion « Published Apps » de l'applet. Chaque ligne est annotée avec canManage pour l'utilisateur demandeur (éditeur).

Paramètres

club `string` (obligatoire)

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"

{}

Générer un jeton de consultation limité au service pour une Custom App publiée

Renvoie une URL signée de courte durée et un jeton que le navigateur utilise pour ouvrir UNE application publiée directement sur la passerelle relais régionale de l'appareil. Le jeton contient une revendication svc qui désigne le port du service, si bien que la passerelle limite la session à /__services/proxy// : le chat et le terminal de l'agent ne sont jamais accessibles avec ce jeton. Les utilisateurs qui consultent l'application ont besoin du module custom-apps dans une installation couverte par l'audience de l'application ; ils n'ont PAS besoin du module ph-ai-agent ni d'un accès à l'agent de l'appareil.

Paramètres

club `string` (obligatoire) appId `string` (obligatoire)

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"

{}

Contact d'assistance d'une Custom App publiée (propriétaire)

Qui assure l'assistance de cette application publiée par un utilisateur : l'adresse e-mail de l'éditeur (ou, à défaut, du propriétaire de l'agent hôte). Affiché sur les panneaux hors ligne et d'erreur de l'utilisateur afin que les demandes d'assistance soient adressées au propriétaire de l'application plutôt qu'à Performance Hub : les applications publiées ne relèvent pas de l'assistance principale de PH. L'audience de l'application est vérifiée en premier ; les utilisateurs avec lesquels l'application n'a jamais été partagée n'obtiennent aucune information. Les applications en pause sont également résolues (les propriétaires reçoivent aussi les questions « pourquoi est-elle en pause ? »).

Paramètres

club `string` (obligatoire) appId `string` (obligatoire)

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"

{}

Envoyer par e-mail une demande d'assistance au propriétaire d'une Custom App publiée

Envoie le message de l'utilisateur au contact d'assistance de l'application (l'éditeur, ou à défaut le propriétaire de l'agent) sous forme d'e-mail personnalisé : destinataire le propriétaire, copie à l'utilisateur (sa trace de la demande), réponse adressée à l'utilisateur afin que le propriétaire lui réponde directement. Les applications publiées sont gérées par les utilisateurs : leur assistance reste donc hors de la file de Performance Hub. L'audience est de nouveau vérifiée ; une demande par utilisateur et par application toutes les 15 minutes (délai d'attente Redis, ouvert en cas d'échec).

Paramètres

club `string` (obligatoire) appId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Mettre à jour une Custom App publiée (nom, icône, description, statut, audience)

Réservé à l'éditeur. Les modifications d'audience sont revalidées par rapport aux portées de rôle de la personne qui MODIFIE, avec les mêmes règles de limitation que pour la publication. Le statut bascule entre actif et en pause (les applications en pause disparaissent des menus et refusent la génération de jetons).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Dépublier une Custom App (suppression logique)

Réservé à l'éditeur. Supprime logiquement la ligne du registre : l'application disparaît immédiatement des menus et la génération de jetons de consultation est refusée ; les sessions de passerelle déjà émises prennent fin à l'expiration du jeton.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Transférer la propriété d'une Custom App publiée

Reprend le flux de réattribution du propriétaire de l'AI Agent : l'éditeur actuel ou un propriétaire de compte (module de facturation) peut confier l'application à un autre utilisateur, qui la gère ensuite. Le nouveau propriétaire doit avoir accès à l'installation du club d'origine de l'application.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Exports de skills préparés sur l'AI Agent d'une installation (sélecteur de partage)

Relaie via le tunnel la liste des exports préparés du bridge de l'appareil (GET /__skills/exports) pour le sélecteur « Share a skill » de l'applet. Les exports sont préparés par l'étape de sécurité et de portabilité ph-skill-sharing exécutée sur l'appareil ; chaque entrée contient le résultat de l'analyse côté appareil. Nécessite le module ph-ai-agent ET un accès 'open' à l'appareil (même exigence que pour la publication).

Paramètres

club `string` (obligatoire) device `string` (obligatoire)

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"

{}

Publier un export préparé en tant que NOUVELLE skill partagée (version brouillon)

Récupère via le tunnel l'archive d'export préparée indiquée depuis le bridge de l'appareil, l'extrait en mémoire (traversée de chemin, liens symboliques et tailles excessives refusés), exécute l'analyse de sécurité déterministe côté cloud, construit le manifeste à partir du frontmatter de SKILL.md, stocke l'archive adressée par son contenu dans le bucket privé des skills, puis crée l'en-tête de la skill et une version BROUILLON. Un blocage par l'analyse n'enregistre RIEN et renvoie les résultats. L'audience est limitée par les portées de rôle de l'éditeur. Soumettez le brouillon (POST submit) pour le publier.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Publier un export préparé en tant que NOUVELLE VERSION d'une skill partagée existante

Même traitement que pour la publication, appliqué à une skill existante : le nom indiqué dans le SKILL.md de l'export doit correspondre à la skill, la version doit être nouvelle (les versions sont immuables) et un journal des modifications est obligatoire. Seul l'éditeur peut ajouter des versions. Un blocage par l'analyse enregistre une ligne de version au statut 'rejected' (rapport uniquement, sans artefact) afin que les résultats apparaissent dans l'historique de l'éditeur.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Rapport d'analyse complet (+ revue LLM) d'une version de skill

Liste complète des résultats d'une version, réservée à l'éditeur et aux administrateurs de l'organisation (revues d'approbation) ; les personnes qui installent la skill voient à la place les totaux résumés dans le détail de la skill.

Paramètres

club `string` (obligatoire) skillId `string` (obligatoire) version `string` (obligatoire)

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"

{}

Soumettre une version brouillon de skill (publication ou mise en file d'approbation)

Fait avancer une version brouillon selon la gouvernance de l'organisation. Lorsque l'organisation a activé la revue LLM, la revue des instructions est exécutée d'abord (au mieux ; un verdict 'fail' entraîne le rejet, un verdict 'flag' impose la file d'approbation). Les partages au niveau de l'installation sont publiés immédiatement, sauf si la gouvernance exige une approbation ; les partages dans la bibliothèque de l'organisation (audience marque ou organisation) exigent une approbation par défaut. La publication définit le latestVersion de la skill : les installations en politique 'auto' la récupèrent lors du prochain cycle de réconciliation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Retirer une skill partagée (la supprime de la bibliothèque)

Réservé à l'éditeur. La skill disparaît immédiatement de la bibliothèque et refuse les nouvelles installations ; les installations EXISTANTES continuent de fonctionner : le retrait concerne uniquement la publication dans la liste, ce n'est pas un arrêt d'urgence.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Modifier la fiche d'une skill partagée (nom d'affichage, description, icône)

Réservé à l'éditeur. Champs de présentation uniquement : le nom canonique de la skill constitue son identité (manifestes, répertoires d'installation, correspondance des versions) et ne change jamais. Une chaîne vide réinitialise un champ à null (retour au nom canonique ou absence d'icône). Les icônes utilisent le catalogue MDI (mdi:icon-name), le même format que les applications d'agent publiées.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Transférer la propriété d'une skill partagée

Reprend le flux de transfert des applications publiées : l'éditeur actuel ou un propriétaire de compte (module de facturation) peut confier la skill à un autre utilisateur, qui gère ensuite ses versions et sa fiche. Le nouveau propriétaire doit avoir accès à l'installation du club d'origine de la skill.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Bibliothèque de skills visible dans cette installation (filtrée par audience)

Skills actives ayant au moins une version publiée dont l'audience couvre cette installation (ou désigne l'utilisateur), annotées avec le résumé de la dernière version publiée et l'adoption dans l'organisation (nombre d'installations distinctes, jamais le nombre brut d'installations de la skill). L'audience est de nouveau résolue en direct à chaque appel.

Paramètres

club `string` (obligatoire)

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"

{}

Détail d'une skill (versions, prérequis, résumé d'analyse, adoption)

Détail complet d'une skill de la bibliothèque : historique des versions avec journaux des modifications et résumés d'analyse (les listes de points de terminaison par version alimentent la comparaison d'analyse lors des mises à jour), prérequis déclarés dans le manifeste, provenance de l'éditeur et indicateur d'adoption par nombre d'installations. L'audience est de nouveau vérifiée : les utilisateurs avec lesquels une skill n'a jamais été partagée n'obtiennent aucune information (l'éditeur et les administrateurs de l'organisation la voient toujours).

Paramètres

club `string` (obligatoire) skillId `string` (obligatoire)

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"

{}

Skills publiées depuis cette installation (liste de gestion de l'éditeur)

Lignes complètes des skills dont l'installation d'ORIGINE est ce club, chacune annotée avec canManage pour l'utilisateur demandeur et le résumé de sa dernière version (brouillons et approbations en attente inclus : il s'agit de la vue de travail de l'éditeur).

Paramètres

club `string` (obligatoire)

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"

{}

Installer une skill de la bibliothèque sur l'AI Agent d'une installation

Soumis à la gouvernance : les installSources de l'organisation doivent l'autoriser, l'audience de la skill doit couvrir cette installation (ou désigner le demandeur), la version doit être publiée et le demandeur doit satisfaire le niveau whoCanInstall de l'appareil cible (propriétaire / utilisateur autorisé / administrateur de l'installation / administrateur de l'organisation, voir la gouvernance). Écrit la ligne de cycle de vie de l'installation (la source de vérité) et effectue immédiatement un envoi au mieux ; la tâche cron de réconciliation garantit la livraison dès que l'appareil est joignable.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Approuver une mise à jour de skill en attente pour une installation

Fait passer le desiredVersion de l'installation à la dernière version publiée (l'étape manuelle des politiques 'notify' et 'pinned', et le chemin suivi lorsque la gouvernance définit updatePosture sur 'approvalRequired'). Conserve la version actuelle comme cible de restauration en une étape et supprime tout blocage de mise à jour posé après une restauration (skipVersion). Même niveau d'autorisation whoCanInstall que pour l'installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Restaurer la version précédente d'une skill installée

Définit desiredVersion sur la previousVersion de la ligne d'installation (conservée à chaque changement de version) et laisse le chemin de livraison normal la réinstaller. En une étape : les versions sont permutées, donc deux restaurations successives vous ramènent au point de départ. Bloque également les mises à jour (skipVersion = la version abandonnée) afin que les politiques auto/notify conservent la restauration ; le blocage est levé lorsqu'une version strictement plus récente est publiée, lors d'un update-approve ou d'un set-policy.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Désinstaller une skill de l'AI Agent d'une installation

Marque la ligne d'installation comme en attente de désinstallation et envoie l'état souhaité ; la ligne est supprimée une fois que l'appareil confirme la suppression (relecture de réconciliation). Même niveau d'autorisation whoCanInstall que pour l'installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Définir la politique de mise à jour d'une skill installée sur un appareil

auto (la réconciliation applique automatiquement les nouvelles versions publiées, sauf si le updatePosture de l'organisation exige une approbation), notify (le propriétaire est averti une fois par nouvelle version et l'applique manuellement) ou pinned (aucun changement sans update-approve explicite). Changer de politique supprime tout blocage de mise à jour posé après une restauration (skipVersion). Même niveau d'autorisation whoCanInstall que pour l'installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Skills installées sur l'AI Agent d'une installation (onglet Skills)

Lignes de cycle de vie des installations d'un appareil, chacune annotée avec les champs de la fiche de la skill et l'existence éventuelle d'une version publiée plus récente. Nécessite un accès 'open' à l'appareil (l'onglet Skills se trouve dans le panneau de l'agent).

Paramètres

club `string` (obligatoire) device `string` (obligatoire)

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"

{}

Versions de skills en attente d'approbation dans l'organisation de cette installation

File d'approbation des administrateurs de l'organisation : toutes les versions en attente d'approbation parmi les skills de l'organisation, avec la fiche de la skill et les résumés d'analyse et de revue LLM. Réservé aux administrateurs de l'organisation.

Paramètres

club `string` (obligatoire)

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"

{}

Approuver une version de skill en attente (la publie)

Réservé aux administrateurs de l'organisation. La version est publiée, le latestVersion de la skill est mis à jour et l'éditeur est averti. Les installations en politique 'auto' récupèrent la version lors du prochain cycle de réconciliation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Refuser une version de skill en attente

Réservé aux administrateurs de l'organisation. La version est refusée avec le motif du réviseur et l'éditeur est averti : il peut corriger les problèmes relevés et soumettre une nouvelle version (les versions sont immuables).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Gouvernance effective des Agent Skills pour l'organisation de cette installation

Politique enregistrée de l'organisation, fusionnée avec les valeurs par défaut de la plateforme (une organisation sans ligne enregistrée voit uniquement les valeurs par défaut). Réservé aux administrateurs de l'organisation.

Paramètres

club `string` (obligatoire)

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"

{}

Mettre à jour la gouvernance des Agent Skills pour l'organisation de cette installation

Mise à jour partielle : seuls les champs fournis changent ; tout le reste conserve sa valeur enregistrée ou par défaut. Réservé aux administrateurs de l'organisation. Les exceptions par appareil se trouvent sur la ligne d'enregistrement, via les routes existantes de configuration des appareils.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Obtenir les données environnementales d'une installation

Renvoie les conditions météo actuelles, y compris le lever et le coucher du soleil (via Open-Meteo), ainsi que la température intérieure de l'installation (issue des capteurs Duress) pour le club indiqué. Mis en cache dans Redis pendant 30 minutes.

Paramètres

clubId `string` (obligatoire) ID interne du club ou de l'installation

GET /api/clubs/{clubId}/environment

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

{}

Ajoute ou associe un appareil IoT générique à un club.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil. body `string` (obligatoire) Objet JSON du nouvel écran à associer.

POST /api/devices/addGenericDevice/{club}

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

{}

Retirer et réinitialiser un écran d'affichage aux paramètres d'usine

Supprime l'association active de l'écran à l'installation et programme une réinitialisation d'usine persistante. Un écran éteint applique la réinitialisation après sa prochaine mise sous tension et reconnexion, puis revient à sa page d'appairage HDMI. L'historique de facturation est conservé.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Associe un contrôleur de porte à une installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Met à jour les paramètres d'un contrôleur de porte pour une installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Met hors service un contrôleur de porte d'une installation.

Paramètres

club `string` (obligatoire)

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"

{}

Renvoie la configuration des relais d'un contrôleur de porte.

Paramètres

uuid `string` (obligatoire)

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"

{}

Renvoie les métadonnées de l'appareil

Paramètres

uuid `string` (obligatoire) ID unique de l'appareil

GET /api/devices/metadata/{uuid}

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

{}

Renvoie les métadonnées de l'appareil. La réponse contient la ligne de métadonnées au premier niveau (ancienne forme), ainsi que `detectedType` (camera | ai-edge-processor | door-controller | ph-ai-agent | null) et `online` (true si l'appareil a été mis à jour au cours des 5 dernières minutes).

Paramètres

deviceSerialNumber `string` (obligatoire) Numéro de série de l'appareil

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"

{}

Renvoie les données Smart Club du club.

Paramètres

club_id `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil.

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"

{}

Renvoie tous les appareils associés à un club.

Paramètres

club `string` (obligatoire) ID interne du club dont vous souhaitez répertorier les appareils.

GET /api/devices/list/{club}

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

{}

Renvoie toutes les versions d'application publiées pour nos appareils balena.

GET /api/devices/listReleases

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

{}

Déplace un appareil vers une nouvelle installation (club) et met à jour les systèmes associés.

Paramètres

club `string` (obligatoire) ID de l'installation source (club dans lequel se trouve actuellement l'appareil) body `object` (obligatoire) Paramètres du déplacement

POST /api/devices/move/{club}

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

{}

Tente d'établir une connexion au routeur d'une installation en sélectionnant le meilleur appareil du club et en envoyant une commande MQTT pour créer un tunnel.

Paramètres

facilityID `string` (obligatoire) ID interne de l'installation pour laquelle la connexion au routeur est tentée.

GET /api/devices/openRouterWebpage/{facilityID}

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

{}

Catalogue Cloud Agent (zones, tailles, prix de vente en direct)

Paramètres

club `string` (obligatoire)

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"

{}

Obtenir un devis pour un Cloud Agent (logiciel + hébergement)

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"

Lancer un Cloud Agent (mise en file du provisionnement + association automatique)

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"

État de la tâche 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"

Purger un Cloud Agent (VM + balena + enregistrement)

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"

Résoudre la suppression en attente d'un Cloud Agent (relancer la sauvegarde, supprimer sans sauvegarde ou annuler)

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"

Répertorier les Connected Apps d'un agent (suites + applications avec comptes connectés)

Renvoie l'état des Connected Apps de l'agent : l'indicateur d'activation, les synthèses par suite (Google Workspace, Microsoft 365) et le catalogue d'applications sélectionnées avec les comptes connectés de chaque application (multicompte : un agent peut avoir plusieurs comptes par application, chacun avec un alias facultatif), résolus à partir de la session en amont de l'agent.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

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"

{}

Catalogue complet de la marketplace Connected Apps pour un agent

Renvoie toutes les applications connectables (le catalogue complet des kits d'outils à authentification gérée, mis en cache côté serveur pendant ~12 h) avec leurs niveaux mis en avant ou suite, les comptes connectés de l'agent pour chaque application, ainsi que les synthèses par suite et les demandes de connexion en attente de l'agent : une seule charge utile pour la marketplace d'applications consultable côté client.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

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"

{}

Ignorer une demande de connexion en attente d'un agent

Marque comme ignorée la demande de connexion en attente de l'agent pour un kit d'outils (elle disparaît de la section « Requested by your agent » de la marketplace). Idempotent : ignorer une demande qui n'est pas en attente n'a aucun effet.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Activer ou désactiver les Connected Apps pour un agent

Enregistre le paramètre Connected Apps de l'agent et envoie la variable d'appareil Balena PH_APPS_MCP_ENABLED à cet appareil uniquement (au mieux : l'indicateur côté PH est le verrou effectif du relais MCP).

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Commencer à connecter une application à un agent (flux OAuth Connect Link)

Lance un flux Connect Link hébergé pour un kit d'outils et renvoie l'URL vers laquelle rediriger l'utilisateur. Un alias facultatif nomme le nouveau compte (multicompte : connecter une application déjà connectée ajoute UN AUTRE compte, jusqu'à 10 par application). Passe par le même callback de chaînage que les connexions de suite (une suite d'un seul kit d'outils) : la fin du flux ramène donc sur la page de l'applet ph-ai-agent.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Données de préparation de la connexion d'une application (mode, champs d'identifiants, guide de configuration)

Tout ce dont la boîte de dialogue de connexion a besoin avant de démarrer une connexion : le mode de connexion de l'application (oauth = flux de consentement hébergé, credentials = formulaire dans le produit), les champs d'identifiants à recueillir en mode credentials et le guide de configuration dans le produit (rédigé pour les applications prioritaires, sinon généré à partir des métadonnées des champs de l'application, jamais un lien vers une documentation externe). Les applications OAuth à fournir soi-même indiquent aussi si l'application OAuth du client est déjà enregistrée pour CET agent (byoConfigured) et l'URL de redirection à enregistrer auprès du fournisseur.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent. toolkit `string` (obligatoire)

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"

{}

Connecter une application avec des identifiants fournis par l'utilisateur (clé API, etc., sans OAuth)

Crée un compte connecté pour une application en mode credentials directement depuis le formulaire du produit, sans flux de consentement hébergé. Les champs d'identifiants proviennent des données connect-info de l'application ; tous les champs obligatoires doivent être fournis. Les identifiants sont validés auprès du fournisseur lorsque c'est possible (au mieux : certaines applications ne refusent une clé erronée qu'au premier appel d'outil de l'agent). Un alias facultatif nomme le nouveau compte (multicompte : connecter une application déjà connectée ajoute UN AUTRE compte).

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Enregistrer l'application OAuth du client pour une application BYO et lancer son flux de connexion

Pour les applications OAuth à fournir soi-même (Xero, Shopify...) : récupère l'ID client et le secret client de l'application OAuth que le client a créée auprès du fournisseur (en suivant le guide de configuration de l'application), l'enregistre pour CET agent (le secret est stocké uniquement auprès de la plateforme d'intégration en amont, jamais dans Performance Hub) et lance immédiatement le flux de connexion hébergé associé. Renvoie l'URL de consentement vers laquelle rediriger l'utilisateur, avec le même contrat que le point de terminaison de connexion. Une nouvelle soumission remplace l'application enregistrée de l'agent (par exemple après la rotation d'un secret) ; les comptes connectés existants continuent de fonctionner.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Lancer la connexion en un clic d'une suite pour un agent (flux Connect Link chaînés)

Lance le flux de connexion chaîné pour une suite entière (par exemple google-workspace). L'URL renvoyée ouvre l'écran de consentement du premier kit d'outils ; chaque fin de flux redirige (302) directement vers le flux du kit suivant, et le tout se termine sur la page de l'applet ph-ai-agent. Les membres qui ont déjà un compte connecté sont IGNORÉS : une nouvelle tentative après un échec en cours de chaîne reprend donc avec les applications manquantes au lieu de créer des comptes en double. Lorsque tous les membres sont déjà connectés, toute la chaîne est de nouveau exécutée : c'est le flux explicite « ajouter un autre compte ».

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Déconnecter un compte connecté d'un agent

Supprime un seul compte connecté (multicompte : les autres comptes de la même application restent connectés). Le système vérifie que le compte appartient bien à cet agent avant la suppression ; s'il s'agissait du DERNIER compte de l'application, le kit d'outils est retiré de l'ensemble connecté de l'agent (la session est recréée à la demande afin de mettre à jour la liste d'outils de l'agent).

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Renommer (modifier l'alias de) l'un des comptes connectés d'un agent

Définit l'alias d'affichage d'un compte connecté. Les alias sont normalement définis automatiquement après l'OAuth (à partir de l'identité connectée) ; ce point de terminaison sert au renommage manuel dans la boîte de dialogue de détail de l'application. Un alias vide efface le libellé. Le système vérifie que le compte appartient bien à cet agent avant la mise à jour en amont.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent.

Corps de la requête

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 '{}'

{}

Activer ou désactiver un service Performance Hub intégré pour un agent

Active ou désactive pour cet agent un service intégré toujours disponible (Smart Search, Weather...). Les services intégrés ne nécessitent ni connexion ni OAuth : ils sont inclus avec chaque agent et activés par défaut ; ce paramètre enregistre l'exception propre à l'agent et recrée immédiatement sa session en amont afin de mettre à jour l'ensemble d'outils. Notez que le paramètre distinct « External apps » (la route /enable) désactive entièrement le serveur MCP des applications : lorsqu'il est désactivé, les services intégrés sont eux aussi indisponibles, quels que soient leurs paramètres individuels.

Paramètres

facilityId `string` (obligatoire) deviceId `string` (obligatoire) UUID balena de l'appareil de l'agent. slug `string` (obligatoire) Slug du service intégré.

Corps de la requête

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 '{}'

{}

Associer un appareil AI Agent à une installation

Association fondée d'abord sur les métadonnées. Recherche l'appareil par son numéro de série dans les métadonnées en direct des appareils, exige qu'il soit en ligne, puis crée à la demande la ligne d'enregistrement, attribue une région de relais Chisel, un port de tunnel et un secret, enregistre cet emplacement sur le relais et envoie la configuration de l'installation et du tunnel à l'appareil via Balena. Les nouveaux appareils reçoivent aussi un compte de service MCP par défaut (activé, limité à cette installation, toutes capacités) ; un nouvel appairage conserve toute autorisation MCP existante. Des paramètres avancés facultatifs remplacent les valeurs par défaut lors de l'appairage (configuration de sauvegarde, MCP activé ou non, restriction d'accès), et `restoreFrom` initialise le nouvel appareil à partir de la sauvegarde cloud d'un autre appareil de l'installation (source active ou mise hors service ; met en file une restauration entre dépôts, renvoyée sous `restoreRequest` pour le suivi de la progression).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Répertorier les appareils AI Agent d'une installation

Renvoie les appareils AI Agent de l'installation avec leur état en ligne et l'état du tunnel en direct (utilisé par le sélecteur d'appareils de l'applet).

Paramètres

club `string` (obligatoire)

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"

{}

Mise à jour et état en ligne de l'AI Agent

Indique si l'appareil est en ligne, si une mise à jour est disponible ou en attente, ainsi que la version proposée (la version épinglée de la flotte si elle est épinglée ; la version la plus récente réussie si la flotte suit la dernière version).

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

État et métriques en direct de l'appareil AI Agent

Renvoie un instantané sélectionné pour la barre de métriques et le panneau de gestion de l'applet : champs d'identité et d'enregistrement, activité et connexion, versions logicielles et dernières métriques du signal de présence (processeur, température, mémoire, stockage par point de montage, durée de fonctionnement, réseau). Aplatit la balise de métadonnées de l'appareil et l'état de mise à jour Balena ; l'une ou l'autre partie peut manquer lors d'une panne passagère.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Commentaire IA du rapport d'état de l'appareil

Renvoie une courte explication, destinée à l'opérateur, des problèmes d'état actuellement déduits. Les faits et les étapes de la procédure figurent toujours dans device-status ; ce paragraphe supplémentaire est fourni au mieux et peut être null.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Générer un jeton d'accès direct au relais pour un AI Agent

Renvoie une URL signée de courte durée que le navigateur utilise pour se connecter DIRECTEMENT à la passerelle relais régionale de l'appareil (en évitant le passage par PH/Sydney), ainsi que le jeton HS256. PH reste l'autorité (Google SSO + vérifications de module et d'installation ici) ; la passerelle relais vérifie le jeton. Le proxy /ai-agent-ui reste la solution de repli.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Envoyer un message de chat dans une session AI Agent (réponse directe depuis la notification)

Relais côté serveur utilisé par l'action de réponse directe de la notification web push : le service worker envoie un POST ici (même origine, cookies SSO), si bien qu'une réponse fonctionne sans aucun onglet Performance Hub ouvert. PH résout la cible de relais de l'appareil (même recherche que pour le proxy /ai-agent-ui), ajoute x-ph-user pour l'attribution du tour (la notification de fin qui en résulte est renvoyée à cet utilisateur) et transmet la requête à /api/chat/start de l'appareil avec l'ID de session.

Corps de la requête

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 '{}'

{}

Lire les paramètres de contrôle d'accès d'un AI Agent (propriétaire)

Renvoie le bloc d'accès de l'appareil (mode, liste d'autorisation, visibilité, option d'assistance PH) ainsi que les demandes d'accès en attente. Accessible au propriétaire de l'appareil ; les autres utilisateurs reçoivent une erreur 403.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Mettre à jour les paramètres de contrôle d'accès d'un AI Agent (propriétaire)

Écrit le mode (org/restricted), la liste d'autorisation restreinte, la visibilité de la liste (all/admins) et l'option « permit access from Performance Hub Support ». Autorisé pour le propriétaire de l'appareil. Le propriétaire lui-même ne peut être changé que via reallocate-owner. Les demandes d'accès approuvées sont persistantes : les demandeurs toujours approuvés sont réintégrés dans la liste d'autorisation enregistrée ; en retirer un de la liste soumise révoque son approbation (la demande passe à refusée ; il peut en faire une nouvelle).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Réattribuer le propriétaire d'un AI Agent

Réattribue la propriété de l'appareil à un autre utilisateur Performance Hub. Réservé aux propriétaires de compte (accès au module de facturation SaaS) : c'est la solution de secours lorsque le propriétaire d'un agent restreint s'en va. L'ancien et le nouveau propriétaire sont tous deux avertis (dans l'application, par notification push et par e-mail).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Liste des utilisateurs de l'installation pour les sélecteurs de liste d'autorisation et de propriétaire de l'AI Agent

Renvoie l'adresse e-mail et le nom (+ indicateurs isOrgAdmin) de chaque utilisateur dont le rôle donne accès à CETTE installation. Réservé au propriétaire de l'appareil et aux personnes habilitées à le réattribuer (propriétaire de compte), afin que les utilisateurs ordinaires ne puissent pas énumérer la base d'utilisateurs.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Demander l'accès à un AI Agent restreint

Crée (ou rouvre) la demande d'accès du demandeur à un appareil restreint ; idempotent par utilisateur et par appareil. Le propriétaire est averti dans l'application, par notification web push et par e-mail, avec un lien direct vers le module de l'agent.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Approuver ou refuser une demande d'accès à un AI Agent (propriétaire)

Traitement d'une demande en attente par le propriétaire de l'appareil. L'approbation ajoute le demandeur à la liste d'autorisation de l'appareil ; dans les deux cas, le demandeur est averti (dans l'application, par notification push et par e-mail).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Autoriser et appliquer une mise à jour de l'AI Agent

Épingle l'appareil sur la version proposée (version épinglée de la flotte, ou version la plus récente réussie si la flotte suit la dernière version) et libère le verrou de mise à jour afin que le superviseur balena l'applique. Les données du volume de données de l'appareil sont conservées lors de la mise à jour.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Planifier une mise à jour de l'AI Agent

Enregistre une heure d'installation planifiée dans l'enregistrement de l'appareil. Une tâche récurrente côté serveur (toutes les 5 minutes) applique la mise à jour (épinglage + déverrouillage) une fois l'heure planifiée passée. Toute nouvelle planification remplace la planification existante de l'appareil.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Annuler une mise à jour planifiée de l'AI Agent

Supprime l'installation planifiée en attente de l'appareil (sans effet si rien n'est planifié).

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Exécuter une commande à distance sur un appareil AI Agent

Publie une commande MQTT autorisée (redémarrage, redémarrage d'un conteneur, verrouillage ou déverrouillage des mises à jour, gestion du Wi-Fi) vers le device-controller exécuté sur l'AI Agent. L'appareil doit être associé à l'installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Mettre à jour la configuration d'un AI Agent visible par l'installation

Enregistre les paramètres modifiables par l'opérateur pour un Agent IA associé : le nom de l'appareil, son emplacement physique et la fréquence des redémarrages planifiés. Le calendrier de redémarrage est aussi transmis à l'appareil sous forme de variable d'environnement Balena REBOOT_DEVICE (2 h, heure locale), comme pour les Display Screens.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Installations vers lesquelles un Agent IA de cette installation peut être déplacé

Renvoie les installations de la même organisation auxquelles l'utilisateur connecté a accès (hors installation actuelle), pour le sélecteur « Déplacer vers une autre installation ». Le déplacement lui-même est effectué par POST /api/devices/move/:club, qui applique côté serveur les mêmes règles de même organisation et d'accès à la cible.

Paramètres

club `string` (obligatoire)

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'enveloppe d'accès MCP que le demandeur peut accorder aux Agents IA d'une installation

Renvoie ce que l'utilisateur connecté est autorisé à accorder au compte de service MCP d'un Agent IA dans l'organisation de cette installation : les installations et régions comprises dans son propre accès, la possibilité ou non d'accorder une portée à l'échelle de l'organisation, l'ensemble des modules dont il dispose et le catalogue complet des outils MCP (pour le masque avancé par outil). L'interface s'en sert pour que les utilisateurs ne voient jamais que des options comprises dans leur propre périmètre d'autorisations ; le point de terminaison POST mcp-access applique la même atténuation côté serveur.

Paramètres

club `string` (obligatoire)

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"

{}

Obtenir la configuration du compte de service MCP d'un Agent IA

Renvoie la configuration d'accès MCP de l'appareil (portée, modules, masque d'outils, champs d'audit).

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Configurer le compte de service MCP d'un Agent IA

Enregistre la configuration d'accès MCP de l'appareil avec atténuation au moment de l'octroi. Les demandeurs ne peuvent accorder que des installations et régions comprises dans leur propre accès, une portée à l'échelle de l'organisation uniquement s'ils détiennent un rôle à l'échelle de l'organisation, et les modules dont ils disposent eux-mêmes dans l'organisation de l'installation. L'indicateur enabled est aussi transmis à l'appareil sous forme de variable d'environnement Balena PH_MCP_ENABLED.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Obtenir la configuration VPN d'un Agent IA (masquée)

Renvoie l'indicateur de prise en charge VPN de l'appareil et la liste de ses connexions. Le contenu des profils et les valeurs des identifiants ne sont jamais renvoyés : uniquement les métadonnées enregistrées à l'importation (serveurs distants, routes, DNS) et des indicateurs de présence d'identifiants. L'état en direct de chaque connexion provient du point de terminaison device-status (beacon metadata.vpn).

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Activer ou désactiver la prise en charge VPN d'un Agent IA

Active ou désactive la fonction VPN de l'appareil. Transmet la variable d'appareil balena PH_VPN_ENABLED et notifie l'appareil (MQTT vpnConfigChanged) ; les connexions sont conservées lors de la désactivation (les tunnels s'arrêtent, la configuration reste pour une réactivation).

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Importer un ou plusieurs profils OpenVPN sur un Agent IA

Accepte des fichiers encodés en base64 : un seul fichier .ovpn/.conf, des lots de fichiers séparés (configuration + certificats/clés) et des archives (.zip, exports Pritunl .tar/.tgz, .tblk Tunnelblick, .visc/.visz Viscosity). Les profils sont normalisés sous une forme intégrée canonique ; chaque profil devient une connexion (importée à l'état déconnecté : saisissez les identifiants, puis connectez-vous). Des erreurs 400 exploitables sont renvoyées pour les fichiers inutilisables.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Mettre à jour une connexion VPN d'un Agent IA (nom / identifiants / DNS fractionné)

Met à jour la connexion enregistrée. Les champs d'identifiants sont en écriture seule (omis = conserver la valeur enregistrée ; chaîne vide = effacer). Les modifications d'identifiants ou de DNS fractionné incrémentent la révision de la connexion, de sorte qu'un tunnel actif redémarre avec les nouvelles valeurs.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Supprimer une connexion VPN d'un Agent IA

Retire la connexion de l'enregistrement et notifie l'appareil, qui ferme le tunnel et purge le profil et les identifiants en cache.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire) connectionId `string` (obligatoire)

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"

{}

Connecter / déconnecter une connexion VPN d'un Agent IA

Modèle d'état souhaité : définit l'indicateur enabled de la connexion dans l'enregistrement et notifie l'appareil (MQTT vpnConfigChanged sans contenu) ; l'appareil récupère l'état de référence par son appel universal-api authentifié par JWT et rapproche ses tunnels. Une notification manquée est rattrapée lors de la synchronisation périodique.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Obtenir la configuration et l'état de la sauvegarde cloud d'un Agent IA

Renvoie les paramètres de sauvegarde de l'appareil (activation, rétention, région de stockage), l'état courant des sauvegardes (dernière sauvegarde, taille, erreurs), la région automatique résolue et les régions de stockage disponibles pour le sélecteur. Le mot de passe du dépôt restic n'est jamais renvoyé.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Mettre à jour la configuration de sauvegarde cloud d'un Agent IA

Enregistre l'activation, la rétention et la région. Prend effet lors de la prochaine sauvegarde horaire de l'appareil (l'appareil demande son contexte d'exécution à PH avant chaque exécution) : aucun redémarrage de l'appareil n'est nécessaire.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Lister les sources de restauration de sauvegarde pour l'appairage d'un nouvel Agent IA

Vue à l'échelle de l'installation pour l'option « restaurer à partir d'une sauvegarde » de la boîte de dialogue d'ajout d'agent : chaque enregistrement de l'installation (actif ET mis hors service/remplacé) qui dispose encore d'un dépôt de sauvegarde déchiffrable et d'au moins un point de restauration utilisable, avec ses instantanés les plus récents. Renvoie aussi les listes d'options de configuration de sauvegarde (allowedRetentionDays, availableRegions), de sorte que la boîte de dialogue n'a besoin d'aucun UUID d'appareil pour remplir ses listes.

Paramètres

club `string` (obligatoire)

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"

{}

Lister les points de restauration d'un Agent IA

Renvoie l'index des instantanés de l'appareil (du plus récent au plus ancien) depuis DynamoDB, sans aller-retour vers l'appareil ou le dépôt, ainsi que l'état actuel des demandes de sauvegarde manuelle ou de restauration pour l'interrogation du panneau. Les demandes obsolètes (jamais prises en charge, ou sans signal de progression) sont présentées comme ayant échoué, afin que l'interface puisse toujours en soumettre une nouvelle.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire)

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"

{}

Demander immédiatement une sauvegarde manuelle d'un Agent IA

Écrit une demande d'exécution manuelle (avec la note de l'utilisateur) dans la ligne d'enregistrement et notifie l'appareil via MQTT. L'appareil récupère la demande vérifiée par son appel run-context universal-api authentifié par JWT ; même sans MQTT, elle est prise en charge au prochain cycle du planificateur. Refusée tant qu'une autre sauvegarde ou restauration est en cours.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Épingler ou désépingler un point de restauration d'un Agent IA

Les points de restauration épinglés sont protégés de l'élagage lié à la rétention : la maintenance nocturne de l'appareil reçoit les identifiants des instantanés épinglés par son appel run-context et les exclut de restic forget, et leurs lignes d'index n'expirent jamais par TTL. Le désépinglage rétablit le comportement de rétention normal.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Restaurer un Agent IA à partir d'un point de restauration

Écrit une demande de restauration dans la ligne d'enregistrement et notifie l'appareil. Les restaurations complètes écrasent /data et /home/hermeswebui (l'appareil prend d'abord un instantané de sécurité automatique avant restauration et arrête l'agent pendant la restauration) et exigent la saisie du nom de l'appareil en guise de confirmation. Transmettre `paths` effectue à la place une restauration non perturbatrice de ces seuls chemins, au niveau des fichiers. Peut aussi, en option, épingler l'appareil sur la version logicielle de l'instantané une fois la restauration des données terminée (voir backup-restore-release).

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Appliquer la version logicielle enregistrée lors d'une restauration terminée

Dernière étape d'une restauration qui a demandé la version logicielle de l'instantané : une fois que l'appareil signale la fin de la restauration des données, ce point de terminaison épingle l'appareil sur la version enregistrée et déverrouille les mises à jour (même mécanisme que le point de terminaison de mise à jour). Déclenché par l'interrogation du panneau ; idempotent : l'épinglage enregistré est effacé une fois appliqué.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Parcourir les fichiers d'un point de restauration

Liste un niveau de répertoire d'un instantané restic, servi entièrement côté serveur depuis le dépôt Wasabi (fonctionne même si l'appareil est hors ligne). Seules les métadonnées de l'arborescence sont lues : aucune donnée de fichier n'est téléchargée pour les listes.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire) takenAt `number` (obligatoire) path `string` (facultatif)

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"

{}

Rechercher des noms de fichiers dans un point de restauration

Recherche de noms de fichiers insensible à la casse à partir d'un répertoire et en descendant, servie côté serveur depuis les métadonnées de l'arborescence restic (aucune donnée de fichier n'est lue ; fonctionne même si l'appareil est hors ligne). Diffuse la liste et s'arrête aux 200 premiers résultats.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire) takenAt `number` (obligatoire) q `string` (obligatoire) path `string` (facultatif)

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"

{}

Différences entre deux points de restauration

Exécute côté serveur un restic diff entre deux instantanés de l'appareil (métadonnées de l'arborescence uniquement) et renvoie la liste des fichiers ajoutés, supprimés ou modifiés (limitée à 500 modifications) ainsi que des statistiques récapitulatives. Les résultats sont mis en cache, car les instantanés sont immuables.

Paramètres

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

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"

{}

Historique des versions d'un fichier sur tous les points de restauration

Un seul restic find côté serveur sur tous les instantanés du dépôt de l'appareil, réduit aux versions DISTINCTES (les résultats consécutifs de taille et mtime identiques sont fusionnés) et joint aux lignes de l'index des instantanés pour les dates, types et notes.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire) path `string` (obligatoire)

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"

{}

Rechercher un nom de fichier dans tous les points de restauration des sauvegardes d'un appareil

Le chemin de récupération des fichiers supprimés : un seul restic find côté serveur sur TOUS les instantanés du dépôt (insensible à la casse, sous-chaîne ou glob), regroupé par chemin avec les points de restauration dans lesquels chaque fichier apparaît. Un fichier supprimé de l'appareil reste trouvable ici tant qu'un point de restauration le contient.

Paramètres

club `string` (obligatoire) uuid `string` (obligatoire) q `string` (obligatoire)

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"

{}

Télécharger un fichier depuis un point de restauration

Diffuse un fichier directement du dépôt restic vers le navigateur (en pièce jointe). Les répertoires sont diffusés sous forme d'archive tar. Taille plafonnée ; servi côté serveur, donc fonctionne même si l'appareil est hors ligne.

Paramètres

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

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"

{}

Mettre hors service un Agent IA d'une installation

Paramètres

club `string` (obligatoire)

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"

{}

Retirer un Agent IA d'une installation et réinitialiser le matériel aux paramètres d'usine

Dissocie complètement l'appareil pour qu'il puisse être appairé dans N'IMPORTE QUELLE installation, et efface toutes les données du NUC. L'effacement est armé via la variable d'appareil balena PH_FACTORY_RESET (un nonce à usage unique) AVANT le démantèlement cloud, de sorte qu'il s'applique même si l'appareil est hors ligne au moment du retrait : l'effacement s'exécute à sa prochaine connexion. Une notification MQTT factoryReset rend le cas en ligne immédiat. Le démantèlement cloud révoque ensuite tous les identifiants et autorisations, supprime le rattachement de l'installation dans Balena (variables d'appareil + étiquette club) et le clubID des métadonnées, et supprime les demandes d'accès et l'enregistrement DNS LAN. Les sauvegardes cloud sont CONSERVÉES : l'index des instantanés et le mot de passe du dépôt restent sur l'enregistrement supprimé de manière logique, utilisables comme source de restauration lors de l'ajout d'un appareil de remplacement. Exige la saisie du nom de l'appareil en guise de confirmation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Remplacer un Agent IA défaillant par un nouveau NUC (reprise après sinistre)

Remplacement d'appareil en une seule opération : associe le NUC de remplacement (emplacement de tunnel, secrets, variables balena, amorçage de la sauvegarde), reprend le nom, l'emplacement, le calendrier de redémarrage, les paramètres de sauvegarde, le blocage d'accès et l'autorisation MCP de l'ancien appareil, réindexe l'ancien index d'instantanés sur le nouvel appareil (pour que tout l'historique de sauvegarde reste consultable), met hors service l'ancien enregistrement (marqué replacedBy / replacedFrom) et, sauf si `restore` vaut false, met en file d'attente une restauration complète du point de restauration choisi depuis le dépôt de sauvegarde de l'ANCIEN appareil vers le nouveau matériel. Fonctionne même si l'ancien appareil est défaillant ou hors ligne ; exige la saisie du nom de l'ancien appareil en guise de confirmation. Uniquement au sein de la même installation.

Paramètres

club `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Résout un lien court de QR code d'appareil Performance Hub vers le lien profond vers lequel il pointe, afin que le scanner Ajouter un appareil puisse détecter le type d'appareil. Seuls les hôtes performancehub.co sont suivis.

Paramètres

url `string` (obligatoire) Le lien court scanné

GET /api/devices/resolve-qr

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

{}

Teste la connectivité au contrôleur Unifi d'une installation et la validité des identifiants.

Paramètres

facilityID `string` (obligatoire) ID interne de l'installation avec laquelle vous souhaitez tester la connectivité 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"

{}

Met à jour un appareil IoT générique associé à une installation.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

PUT /api/devices/updateGenericDevice/{club}

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

{}

Indique le nombre d'accords en suspens nécessitant une action, selon l'utilisateur et les clubs qui lui sont associés

GET /api/agreements/agreements-outstanding

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

{}

Répertorie tous les accords disponibles pour un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. contracts-sort `string` (facultatif) Trie les accords par date d'effet ou par ordre alphabétique. Par défaut : date d'effet. contracts-acknowledgement `string` (facultatif) Filtre les accords : tous, acceptés ou non acceptés. Par défaut : tous. contracts-requirement `string` (facultatif) Filtre les accords : tous, signature, case à cocher, fenêtre contextuelle ou aucun. Par défaut : tous. contracts-status `string` (facultatif) Filtre les accords : tous, actifs ou archivés. Par défaut : tous.

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"

{}

Signe un accord à partir de son ID.

Paramètres

club `string` (obligatoire) ID interne du club qui signe l'accord. agreementid `string` (obligatoire) ID de l'accord à signer. body `string` (obligatoire) Objet JSON contenant l'accord et les paramètres à ajouter ou envoyer au système...

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"

{}

Résumé Model Router de l'installation (configuration, solde, dépenses).

Paramètres

clubID `string` (obligatoire) tz `string` (facultatif) Fuseau horaire IANA de l'utilisateur : solution de repli pour les fenêtres de dépenses journalières et mensuelles lorsque l'installation n'a pas de fuseau horaire.

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"

{}

Catalogue des modèles disponibles avec leur état d'activation par installation (tous activés par défaut).

Paramètres

clubID `string` (obligatoire)

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"

{}

Garde-fous disponibles et modèles prédéfinis PH.

Paramètres

clubID `string` (obligatoire)

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"

{}

Services Model Router connectés. Comprend les appareils AI Agent appairés, les agents externes explicitement typés et le service Workflow de l'installation. La configuration se modifie via PATCH /keys/{keyHash}.

Paramètres

clubID `string` (obligatoire) tz `string` (facultatif) Fuseau horaire IANA de l'utilisateur : solution de repli pour les fenêtres de dépenses journalières et mensuelles lorsque l'installation n'a pas de fuseau horaire.

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"

{}

Active Model Router pour une installation et provisionne son accès à l'inférence.

Paramètres

clubID `string` (obligatoire)

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"

{}

Met à jour le forfait, la liste des modèles autorisés, les garde-fous, les filtres de contenu (masquage ou blocage par regex côté PH), la limite de dépenses et la configuration de rechargement automatique.

Paramètres

clubID `string` (obligatoire)

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"

{}

Remet à 0 le compteur du plafond absolu sur toute la durée (nouvelle référence égale aux dépenses actuelles) et consigne la période clôturée dans l'historique.

Paramètres

clubID `string` (obligatoire)

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"

{}

Historique des réinitialisations du plafond absolu (les plus récentes d'abord) : plafond, montant dépensé et horodatages pour chaque période clôturée.

Paramètres

clubID `string` (obligatoire)

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"

{}

Crée une nouvelle clé API phk_ pour l'installation (texte en clair renvoyé une seule fois). Accepte en option des plafonds de dépenses, une liste de modèles autorisés, des garde-fous, des filtres de contenu et des limites de débit rpmLimit/tpmLimit.

Paramètres

clubID `string` (obligatoire)

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"

Met à jour les champs modifiables de la clé : libellé, plafonds de dépenses par clé, liste de modèles autorisés, garde-fous, filtres de contenu et limites de débit rpmLimit/tpmLimit (synchronisés avec la clé).

Paramètres

clubID `string` (obligatoire) keyHash `string` (obligatoire)

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"

{}

Journaux d'inférence par requête pour l'installation (en direct, métadonnées uniquement).

Paramètres

clubID `string` (obligatoire) page `string` (facultatif) pageSize `string` (facultatif) status `string` (facultatif) model `string` (facultatif) provider `string` (facultatif) source `string` (facultatif) `key` ou `agent` keyHash `string` (facultatif) Filtre sur une seule clé ou un seul agent à partir de son keyHash PH. q `string` (facultatif) Recherche en texte libre sur l'ID de requête, le libellé de la clé ou de l'agent, le modèle, le fournisseur et l'utilisateur final. minutes `string` (facultatif) Fenêtre inférieure à une journée (par exemple Live=1440) ; remplace startDate/endDate. startTs `string` (facultatif) Début de la fenêtre en secondes epoch (clic pour zoomer) ; remplace les minutes et les dates. endTs `string` (facultatif) Fin de la fenêtre en secondes epoch (clic pour zoomer) ; remplace les minutes et les dates.

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"

{}

Histogramme des requêtes dans le temps pour la vue Logs. Mêmes filtres que la route de liste, mais agrégés côté serveur par intervalles de temps (nombre de succès et d'échecs), de sorte que la réponse reste très légère quel que soit le volume de journaux. La taille des intervalles est choisie automatiquement en fonction de la période.

Paramètres

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

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"

{}

Intervalles d'analyse de l'utilisation et totaux par modèle pour une période (en direct).

Paramètres

clubID `string` (obligatoire) range `string` (facultatif) 24h | 7 | 30 | 90 | year | all (ignoré si startDate/endDate sont fournis) startDate `string` (facultatif) endDate `string` (facultatif) groupBy `string` (facultatif) model (par défaut) | key | source | provider | status : dimension des intervalles et des groupes subgroupBy `string` (facultatif) seconde dimension facultative imbriquée dans chaque groupe (Explore) keyHash `string` (facultatif) filtre d'analyse détaillée : limite à une seule clé ou un seul agent model `string` (facultatif) filtre d'analyse détaillée : limite à un seul modèle provider `string` (facultatif) source `string` (facultatif) compare `string` (facultatif) définir sur "prev" pour renvoyer également groupsPrev (période de même durée immédiatement précédente)

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"

{}

Calendrier d'activité quotidienne sur l'année glissante écoulée (environ 53 semaines, à la manière de GitHub).

Paramètres

clubID `string` (obligatoire)

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"

{}

Débite la carte de facturation SaaS enregistrée pour ajouter du crédit Model Router prépayé.

Paramètres

clubID `string` (obligatoire) body `object` (facultatif)

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"

{}

Finalise une recharge une fois que l'applet a terminé l'authentification 3DS.

Paramètres

clubID `string` (obligatoire)

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"

{}

Résumé de la carte de facturation SaaS enregistrée qui sera débitée lors des recharges et des recharges automatiques.

Paramètres

clubID `string` (obligatoire)

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"

{}

Transactions du registre de l'installation, les plus récentes d'abord. Filtrage facultatif par type (par exemple `types=topup,adjustment` pour l'historique des mouvements d'argent, ou `types=charge-reconcile` avec `from`/`to` pour les déductions d'utilisation d'un mois).

Paramètres

clubID `string` (obligatoire) limit `integer` (facultatif) Nombre maximal de lignes (50 par défaut, 200 au maximum) types `string` (facultatif) Types de transactions séparés par des virgules (topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (facultatif) Uniquement les transactions avec createdAt >= from (secondes Unix) to `integer` (facultatif) Uniquement les transactions avec createdAt <= to (secondes 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"

{}

Mois `YYYY-MM` distincts (UTC, les plus récents d'abord) contenant au moins une transaction des types demandés. Alimente les listes déroulantes de filtre par année et par mois afin que l'interface ne propose que les périodes qui contiennent réellement des données.

Paramètres

clubID `string` (obligatoire) types `string` (facultatif) Types de transactions séparés par des virgules (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"

{}

Reçu de paiement PDF personnalisé pour une transaction Model Router.

Paramètres

clubID `string` (obligatoire) txId `string` (obligatoire)

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"

{}

Ensemble de reçus de paiement PDF personnalisés pour les transactions de recharge sélectionnées, au format ZIP. Chaque ID doit correspondre à une recharge de l'installation : les déductions d'utilisation et les ajustements administratifs n'ont pas de reçu et sont refusés.

Paramètres

clubID `string` (obligatoire) ids `string` (obligatoire) ID de transactions séparés par des virgules (50 au maximum)

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"

{}

Cumuls par mois civil (UTC) des déductions d'utilisation de l'installation, les plus récents d'abord. Le mois en cours est toujours inclus et signalé par `isCurrentMonth` (depuis le début du mois).

Paramètres

clubID `string` (obligatoire) months `integer` (facultatif) Période d'historique en mois (12 par défaut, 24 au maximum ; ignorée lorsque `year` est défini) year `integer` (facultatif) Limite les cumuls à une année civile UTC (par exemple 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"

{}

Relevé d'utilisation mensuel en PDF personnalisé : synthèse des déductions d'utilisation du mois (sous-totaux journaliers + total). Il ne s'agit explicitement ni d'une facture ni d'un reçu ; les déductions d'utilisation n'entraînent aucun encaissement.

Paramètres

clubID `string` (obligatoire) month `string` (obligatoire) Mois civil 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"

{}

Lignes brutes de déduction d'utilisation d'un mois au format CSV (ID de transaction, horodatage UTC, montant, solde après opération, instantané des dépenses cumulées) : l'export détaillé qui se rapproche du total du relevé du mois.

Paramètres

clubID `string` (obligatoire) month `string` (obligatoire) Mois civil 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"

{}

Synthèse de l'utilisation et des dépenses de l'installation (en direct et registre rapproché).

Paramètres

clubID `string` (obligatoire) tz `string` (facultatif) Fuseau horaire IANA de l'utilisateur : solution de repli pour les fenêtres de dépenses journalières et mensuelles lorsque l'installation n'a pas de fuseau horaire.

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"

{}

Associe ou met à jour un appareil AI Edge Processor pour un club

Paramètres

body `string` (obligatoire) Objet JSON de mise à jour de l'enregistrement de l'appareil 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"

{}

Associe un appareil AI Edge Processor à un club. Résout l'appareil en privilégiant les métadonnées (le signal de présence en direct l'emporte), complète la ligne d'enregistrement si l'appareil ne s'est jamais enregistré lui-même et nettoie les lignes d'enregistrement obsolètes laissées par du matériel reprovisionné.

Paramètres

body `string` (obligatoire) Objet JSON de mise à jour de l'enregistrement de l'appareil 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"

{}

Renvoie la liste des enregistrements d'envoi bbox d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Index de recherche de la base de données de caméras

Relaie l'index de recherche public camera-db de la documentation (fabricants, gammes, modèles, alias) utilisé par la boîte de dialogue Find my camera lors de l'ajout de caméras réseau. Mis en cache côté serveur pendant 12 heures.

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"

{}

Modèles de fabricant de la base de données de caméras

Relaie les modèles d'URL RTSP et les valeurs par défaut d'un fabricant depuis la base de données publique de caméras de la documentation. Le slug est validé pour empêcher toute traversée de chemin. Mis en cache côté serveur pendant 12 heures.

Paramètres

slug `string` (obligatoire) Slug du fabricant (par exemple 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"

{}

Renvoie la liste des données d'enregistrement des arrivées d'une installation

Paramètres

club `string` (obligatoire) ID interne du club ou de l'installation auquel vous souhaitez accéder. startDate `string` (facultatif) Date de début au format YYYY-MM-DD endDate `string` (facultatif) Date de fin au format YYYY-MM-DD timezone `string` (facultatif) Fuseau horaire utilisé pour interpréter les dates (Australia/Brisbane par défaut) nextToken `string` (facultatif) Jeton de pagination pour récupérer la page suivante

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"

{}

Récupérer la configuration du front-end ou de l'interface CCTV

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

GET /api/cctv/config/:club

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

{}

Obtenir la configuration de diffusion de contenu CCTV

Renvoie le domaine de contenu utilisé par les clients CCTV pour résoudre les fichiers multimédias. Le domaine est défini par la variable d'environnement CONTENT_DOMAIN, avec à défaut une valeur par défaut qui dépend de l'environnement (la production sert /cctv, les autres environnements servent /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"

{}

Modifier la configuration du front-end ou de l'interface CCTV

Paramètres

body `object` (obligatoire) Objet JSON du nouveau bloc de configuration à ajouter au système.

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"

{}

Renvoie la liste des régions de bucket disponibles pour la configuration du fournisseur de stockage CCTV

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Réinitialiser la collection de visages non identifiés

Réinitialise la collection CompreFace des personnes non identifiées de l'installation en supprimant tous les sujets. Les fiches de personnes DynamoDB, les détections de visages et les blocs de chronologie OpenSearch ne sont PAS affectés. Seules les données sous-jacentes de reconnaissance faciale sont effacées. De nouveaux profils fantômes sont créés automatiquement à mesure que le système traite de nouvelles détections des caméras.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Obtenir les informations de la collection des personnes non identifiées

Renvoie le nombre actuel de sujets de la collection CompreFace des personnes non identifiées de l'installation.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Ajoute une caméra réseau (caméra OEM/IP) via une URL de flux (RTSP, HTTP, HTTPS)

Paramètres

body `string` (obligatoire) Objet JSON pour l'ajout d'une caméra réseau.

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"

{}

Ajouter en masse des caméras réseau à un Edge Processor

Enregistre plusieurs caméras réseau RTSP/HTTP sur un même Edge Processor, puis envoie FEED_CONFIG une seule fois afin que l'appareil ne recharge sa configuration qu'une fois.

Paramètres

body `object` (obligatoire)

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"

{}

Associe ou met à jour un appareil pour un club

Paramètres

body `string` (obligatoire) Objet JSON de mise à jour de l'enregistrement de l'appareil CCTV.

POST /api/cctv/devices

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

{}

Associe un appareil à un club

Paramètres

body `string` (obligatoire) Objet JSON de mise à jour de l'enregistrement de l'appareil CCTV.

POST /api/cctv/devices/associate

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

{}

Envoie une requête MQTT à l'UUID d'un appareil donné et attend en réponse (via websocket) les capacités disponibles de la caméra.

Paramètres

club `string` (obligatoire) ID interne du club propriétaire de l'appareil interrogé. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Répertorier les enregistrements d'appareils

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

GET /api/cctv/devices/:club

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

{}

Supprime une caméra réseau en la marquant comme supprimée et en la retirant du FEED_CONFIG de l'Edge Processor

Paramètres

club `string` (obligatoire) ID interne du club propriétaire de l'appareil. balenaUUID `string` (obligatoire) UUID de la caméra réseau à supprimer.

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"

{}

Enregistre tout ou partie des capacités configurées de la caméra et les applique à l'appareil sous forme de variable d'environnement (via balena)

Paramètres

club `string` (obligatoire) ID interne du club propriétaire de l'appareil interrogé. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Enregistre un masque de mouvement (s'il est configuré) pour la caméra et l'applique à l'appareil sous forme de variable d'environnement (via balena)

Paramètres

club `string` (obligatoire) ID interne du club propriétaire de l'appareil interrogé. body `string` (obligatoire) Objet JSON du masque de la caméra.

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"

{}

Envoie une commande v4l2 précise (luminosité ou contraste, par exemple) à l'appareil physique

Paramètres

club `string` (obligatoire) ID interne du club propriétaire de l'appareil interrogé. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Tester l'URL de flux d'une caméra réseau

Envoie une commande de test à un Edge Processor pour valider l'URL de flux d'une caméra avec ffprobe

Corps de la requête

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 '{}'

{}

Supprime définitivement une détection de visage de la base de données. Sert à retirer les entrées de suivi erronées ou mal associées du journal d'activité d'une personne.

Paramètres

club `string` (obligatoire) fdID `string` (obligatoire)

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"

{}

Renvoie la liste des données de détection de visages d'une personne

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personID `string` (obligatoire) ID de la personne dans le système d'identification faciale

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"

{}

Renvoie les détections de visages qui font référence à une image recadrée de personne donnée, interrogées via le GSI personCropImage.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personCropImage `string` (obligatoire) URL de l'image recadrée de la personne enregistrée dans la détection de visage. limit `string` (facultatif) Nombre maximal de détections à renvoyer. nextToken `string` (facultatif) Jeton de pagination issu d'une réponse précédente.

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"

{}

Renvoie la liste des données de détection de visages d'un club, regroupées sur une plage relative à l'heure actuelle

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie la liste des données de détection de visages d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Rechercher des blocs de chronologie de détection de visages dans une installation avec OpenSearch

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation dans laquelle effectuer la recherche timezone `string` (obligatoire) Fuseau horaire IANA pour la conversion des dates (par exemple Pacific/Auckland) startDate `string` (facultatif) Filtre de date de début (YYYY-MM-DD), converti en startUnix selon le fuseau horaire endDate `string` (facultatif) Filtre de date de fin (YYYY-MM-DD), converti en endUnix selon le fuseau horaire personId `string` (facultatif) Filtrer sur un ID de personne précis query `string` (facultatif) Recherche en texte libre (par exemple le nom d'une personne) limit `string` (facultatif) Résultats par page (20 par défaut, 100 au maximum) filters `string` (facultatif) Objet de filtres encodé en JSON (par exemple {"matchType":"identified"}) sortBy `string` (facultatif) Champ de tri (startUnix, endUnix, created). Par défaut : endUnix. page `string` (facultatif) Numéro de page pour la pagination (1 par défaut) sortOrder `string` (facultatif) Sens du tri (asc ou desc). Par défaut : 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"

{}

Renvoie la liste des rapports concernant l'installation du club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Déclenche à la demande la génération de cartes de chaleur. Appelle la même logique Starter que la tâche cron planifiée, mais permet de cibler une installation, une date/heure et un ensemble de périodes précis. Sans corps de requête, se comporte exactement comme la tâche cron : analyse toutes les installations éligibles et met en file chaque appareil.

Corps de la requête

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 '{}'

{}

Résout l'emplacement d'un PNG de carte de chaleur composé sur fenêtre glissante pour un appareil. Renvoie uniquement des métadonnées JSON : les octets du PNG se trouvent sur le domaine de contenu, et le front-end construit l'URL ainsi : `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` Ordre de résolution : 1. Correspondance dans l'index DynamoDB `composed#…` → renvoi immédiat (~10 ms). 2. HEAD Wasabi sur la clé de cache déterministe. En cas de correspondance, écrit une ligne d'index de complément et renvoie le résultat. 3. Repli sur une version obsolète : il existe un enregistrement composé pour ce tuple (appareil, plage, heure), même à une autre date. Renvoyé immédiatement avec `cache: 'HIT-STALE'` afin que le front-end puisse afficher *quelque chose*. Une nouvelle composition est lancée en asynchrone. 4. Chemin à froid : aucun enregistrement n'existe. La Lambda de composition est mise en file via `InvocationType: 'Event'` et le point de terminaison renvoie `202 { cache: 'PENDING' }`. Le front-end interroge jusqu'à l'arrivée d'un enregistrement (généralement 3 à 5 secondes). Gestion du jour courant : lorsque `endDate` correspond à « aujourd'hui » à l'heure locale de l'installation, le point de terminaison sert le PNG de la veille : les tranches du jour sont encore en cours d'écriture par la tâche cron Starter et une nouvelle composition serait incomplète. La réponse reprend la `endDate` demandée et inclut `endDateUsed` (= la veille). Énumération `cache` : - `HIT` : servi depuis l'index DDB pour la date demandée. - `HIT-FALLBACK` : jour courant demandé ; ligne d'index de la veille servie. - `HIT-BACKFILL` : absent de DDB mais Wasabi avait le PNG ; la ligne vient d'être écrite. - `HIT-FALLBACK-BACKFILL` : complément sur le repli à la veille. - `HIT-STALE` : aucun enregistrement pour la date demandée, mais il en existe un à une autre date pour ce tuple ; servi immédiatement et une nouvelle composition est mise en file en arrière-plan. - `PENDING` : aucun enregistrement ; la composition a été mise en file. Le front-end doit interroger de nouveau. La réponse est `202 Accepted`, sans `filePath`.

Paramètres

facilityId `string` (obligatoire) deviceUUID `string` (obligatoire) Appareil pour lequel composer. Les compositions sont propres à chaque appareil. hour `integer` (obligatoire) Heure de la journée (0 à 23) à composer sur la fenêtre d'historique. endDate `string` (facultatif) Dernière date de la fenêtre (YYYY-MM-DD). Par défaut, aujourd'hui (fuseau horaire de l'installation). range `string` (facultatif) Fenêtre d'historique. Doit faire partie des plages autorisées. nocache `integer` (facultatif) Définir sur `1` pour contourner les couches de cache DDB + HEAD et forcer une nouvelle composition.

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"

{}

Indique quelles heures de la journée disposent de tranches `1h` pour un appareil sur une fenêtre d'historique glissante. Le front-end s'en sert pour alimenter le sélecteur d'heure, à côté d'un sélecteur de date et de plage, avant d'appeler le point de terminaison de composition (`/api/cctv/heatmaps/hourly/...`). Exemple : `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` En interne : une requête de plage DynamoDB sur `cctvheatmaps` (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`), regroupée par heure. Renvoie une entrée par heure comportant au moins une tranche, avec une image JPEG de référence représentative (issue du jour le plus récent de la fenêtre : la référence est commune à chaque appareil pour une même journée).

Paramètres

facilityId `string` (obligatoire) deviceUUID `string` (obligatoire) Appareil à interroger. Les tranches horaires sont propres à chaque appareil. endDate `string` (facultatif) Dernière date de la fenêtre (YYYY-MM-DD). Par défaut, aujourd'hui (fuseau horaire de l'installation). range `string` (facultatif) Fenêtre d'historique. Doit faire partie des plages autorisées.

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"

{}

Interroge les enregistrements de cartes de chaleur pré-générés d'une installation. **Tous les enregistrements d'un type de période :** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **Plage de dates, un seul type de période :** - `/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` **Plage de dates, tous les types de période applicables (omettre periodType) :** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` Renvoie les enregistrements annuels, semestriels, trimestriels, etc., jusqu'aux enregistrements 6h, qui chevauchent la plage indiquée. **Instant précis, les 9 types de période pour un appareil :** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` Renvoie jusqu'à 9 enregistrements (1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h).

Paramètres

facilityId `string` (obligatoire) Identifiant de l'installation. deviceUUID `string` (facultatif) Interroge un appareil précis. S'il est omis, la requête porte sur tous les appareils (GSI). periodType `string` (facultatif) Filtre sur un seul type de période. S'il est omis avec from/to, tous les types sont interrogés. from `string` (facultatif) Date de début (yyyy-mm-dd). Doit être utilisée avec `to`. to `string` (facultatif) Date de fin (yyyy-mm-dd). Doit être utilisée avec `from`. date `string` (facultatif) Recherche à un instant précis (yyyy-mm-dd ou yyyy-mm-ddTHH:mm). Nécessite deviceUUID. Renvoie un enregistrement par type de période.

GET /api/cctv/heatmaps/{facilityId}

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

{}

Obtenir la miniature du flux en direct de l'appareil

Paramètres

club `string` (obligatoire) ID interne du club. deviceId `string` (obligatoire) ID interne de l'appareil CCTV.

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"

{}

Indiquer au système CCTV que vous allez regarder un flux en direct

Paramètres

club `string` (obligatoire) ID interne du club. deviceId `string` (obligatoire) ID interne de l'appareil CCTV.

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"

{}

Approuver une correspondance d'intersection

Définit le statut de la correspondance sur confirmé et enregistre le réviseur.

Paramètres

club `string` (obligatoire) matchId `string` (obligatoire)

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"

{}

Obtenir une correspondance d'intersection avec le détail des visites

Renvoie l'enregistrement de la correspondance et la répartition des horaires par visite.

Paramètres

club `string` (obligatoire) matchId `string` (obligatoire)

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"

{}

Associer manuellement une personne non reconnue à un membre

Associe un personId CCTV à un membre précis et définit la correspondance comme confirmée.

Paramètres

club `string` (obligatoire) matchId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Répertorier les correspondances d'intersection d'une installation

Renvoie les correspondances paginées, filtrées par statut.

Paramètres

club `string` (obligatoire) status `string` (facultatif) limit `integer` (facultatif) nextToken `string` (facultatif)

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"

{}

Refuser une correspondance d'intersection

Définit le statut de la correspondance sur refusé et enregistre le réviseur.

Paramètres

club `string` (obligatoire) matchId `string` (obligatoire)

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"

{}

Obtenir les totaux récapitulatifs des correspondances d'intersection

Renvoie le nombre de correspondances de l'installation, regroupées par statut.

Paramètres

club `string` (obligatoire) ID de l'installation

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"

{}

Dissocier une correspondance de profil apprise automatiquement

Rétablit le statut refusé d'une correspondance associée et efface autoLearnedFrom dans la fiche du membre.

Paramètres

club `string` (obligatoire) matchId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Lit l'état d'une opération « upsert identified person » en cours (création et modification). Lit la ligne directement dans la table `people-ops` gérée par cctv-rekognition-api, sans passer par une Lambda. Utilisé par le front-end CCTV pour suivre la progression après POST /api/cctv/people/{facility}/identified. Le chemin est voisin de `/cctv/people/...` (et non imbriqué dessous) afin que le routeur express ne puisse pas confondre `operationId` avec `:personID` sur `/cctv/people/:club/:personID`. Voir l'ordre des globs de createAPIRouter. Renvoie un espace réservé `pending` tant que la Lambda upsertIdentifiedPerson n'a pas encore écrit sa première étape (période de démarrage à froid). Le hook d'interrogation du front-end traite de la même façon l'espace réservé et l'état pending, ce qui garantit un contrat stable pour les appelants.

Paramètres

operationId `string` (obligatoire)

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"

{}

Ajoute une image de visage (issue d'une détection de suivi existante) au sujet de reconnaissance CompreFace de la personne et enregistre une référence dans la table des photos fantômes. N'envoie PAS l'image vers Wasabi : elle s'y trouve déjà en tant que capture de détection de visage.

Paramètres

club `string` (obligatoire) personID `string` (obligatoire) body `string` (obligatoire)

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"

{}

Ajouter des photos fantômes à la fiche d'une personne

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personID `string` (obligatoire) ID d'enregistrement de la personne body `string` (obligatoire) Objet JSON du nouveau bloc de configuration à ajouter au système.

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"

{}

Interroger les photos fantômes d'une personne

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personID `string` (obligatoire) ID d'enregistrement de la personne

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"

{}

Supprime définitivement un enregistrement de photo fantôme de CCTVShadowPhotosTable et retire le visage correspondant de CompreFace (si faceId est enregistré).

Paramètres

club `string` (obligatoire) personID `string` (obligatoire) id `string` (obligatoire) ID de l'enregistrement de photo fantôme (clé primaire)

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"

{}

Supprime les références et les enregistrements Rekognition associés à partir d'un personID

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personID `string` (obligatoire) ID unique de la personne CCTV.

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"

{}

Renvoie la fiche d'une personne d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. personID `string` (obligatoire) ID de la personne dans la base de données.

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"

{}

Obtenir les zones d'accès correspondant au profil d'abonnement d'une personne

Résout le type de membre, les étiquettes et les formules d'abonnement de la personne, puis renvoie les zones d'accès réelles (origin=membership-plan, non absorbées) qui correspondent aux règles d'inclusion et d'exclusion. Le champ accessRestriction de chaque zone est réduit aux seules règles qui s'appliquent à la personne. Les caméras des zones enfants sont fusionnées dans les zones parentes.

Paramètres

club `string` (obligatoire) ID interne de l'installation personID `string` (obligatoire) ID de la personne dans la table des personnes CCTV

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"

{}

Renvoie l'état actuel d'une tâche de fusion, avec les résultats pour chaque source. Interrogez ce point de terminaison toutes les 3 à 5 secondes tant que le statut est IN_PROGRESS.

Paramètres

club `string` (obligatoire) mergeJobID `string` (obligatoire)

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"

{}

Lance en arrière-plan la fusion de plusieurs profils de personnes non identifiées en un seul profil conservé. Répond immédiatement 202 avec un mergeJobID. Interrogez /merge-status/:mergeJobID pour suivre la progression.

Paramètres

club `string` (obligatoire) body `string` (obligatoire)

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"

Ajouter un visage à la collection de la liste noire d'une installation

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation

Corps de la requête

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 '{}'

{}

Crée ou met à jour une personne identifiée dans une installation : crée une nouvelle fiche ou met à jour une fiche existante. Relaie la requête à la Lambda upsertIdentifiedPerson, qui écrit la fiche de la personne, envoie la photo éventuellement fournie vers Wasabi et réindexe le visage dans CompreFace. Lorsque `isNewRecord` vaut true (par défaut), la Lambda exécute la branche de création (cctvPeople.save) et un `personID` est généré s'il n'est pas fourni. Lorsque `isNewRecord` vaut false, la Lambda exécute la branche de mise à jour (cctvPeople.update) : `personID` est alors obligatoire et doit identifier une fiche existante.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

Met à jour l'ensemble des champs partenaires facultatifs synchronisés dans la table des personnes CCTV d'une installation.

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation

Corps de la requête

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 '{}'

{}

Renvoie la liste des données des personnes d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

GET /api/cctv/people/:club

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

{}

Recherche des personnes dans une installation à partir d'une image de visage. Appelle la Lambda imageFaceSearch de cctv-rekognition-api avec l'image base64 envoyée et l'ID de l'installation indiqué dans le chemin. Renvoie les correspondances classées ainsi qu'une synthèse des attributs DeepFace.

Paramètres

club `string` (obligatoire) ID de l'installation ou du club body `string` (obligatoire)

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"

{}

Rechercher des personnes dans une installation avec OpenSearch

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation dans laquelle effectuer la recherche query `string` (facultatif) Terme de recherche (par exemple un nom) page `string` (facultatif) Numéro de page (1 par défaut) limit `string` (facultatif) Résultats par page (20 par défaut, 100 au maximum) filters `string` (facultatif) Objet de filtres encodé en JSON (par exemple {"membershipStatus":"active"}) sortBy `string` (facultatif) Champ de tri (created, lastName, firstName, membershipUpdatedOn). Par défaut : created. sortOrder `string` (facultatif) Sens du tri (asc ou desc). Par défaut : 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"

{}

Met à jour les détections de visages avec un nouveau personID et associe les enregistrements Rekognition

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. body `string` (obligatoire) Objet JSON du nouveau bloc de configuration à ajouter au système.

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"

{}

Renvoie un objet contenant tous les filtres disponibles pour les données d'enregistrements CCTV d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Diffuser l'enregistrement.

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"

{}

Mettre à jour les informations de l'enregistrement.

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"

{}

Renvoie une synthèse des données d'enregistrements CCTV d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie la liste des données d'enregistrements CCTV d'un club sur une plage relative à l'heure actuelle

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie la liste des données d'enregistrements CCTV d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

GET /api/cctv/recordings/:club

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

{}

Les enregistrements sont supprimés automatiquement après une période définie : utilisez cette fonction pour les conserver

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Rechercher les instantanés de rapport d'une installation sur une plage de dates

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation startDate `string` (obligatoire) Filtre de date de début (YYYY-MM-DD) endDate `string` (obligatoire) Filtre de date de fin (YYYY-MM-DD) deviceIds `string` (facultatif) Liste d'ID de caméras ou d'appareils, séparés par des virgules, sur lesquels filtrer view `string` (facultatif) Autre vue de rapport à calculer (transmise à la Lambda de rapport)

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"

{}

Recherche vectorielle dans les médias CCTV indexés d'une installation. Répond par un flux text/event-stream relayé depuis la Lambda searchAnything, afin que le client puisse afficher la progression pendant qu'un conteneur à froid charge l'encodeur. Les événements sont `status`, puis `result` ou `error`. Il existe trois façons d'interroger, dont deux avec ce verbe. Envoyez `query` pour une recherche en texte libre. Envoyez `seedIndex` + `seedKey` pour une recherche par l'exemple (« plus de résultats similaires ») à partir du vecteur d'une ligne déjà présente dans l'index : c'est ainsi que vous trouvez d'autres résultats semblables à celui que l'utilisateur consulte. Pour rechercher à partir d'une image dont dispose l'utilisateur, envoyez plutôt les octets en `POST` sur ce même chemin. Envoyez des mots avec une image pour affiner l'un par l'autre : **le texte filtre, l'image classe**. Les candidats proviennent de l'exemple, les mots déterminent lesquels sont conservés et la similarité visuelle détermine l'ordre : les résultats ressemblent donc toujours à l'image, et les mots écartent ceux qui ne correspondent pas. Les deux ne sont jamais fusionnés en un seul vecteur, c'est pourquoi `queryKind` reste `similar` pour une recherche combinée ; c'est la présence de `query` dans le résultat qui indique qu'un filtre textuel a été appliqué. Les recherches combinées ne renvoient assez souvent aucun résultat ; traitez ce cas comme un résultat à part entière : `perIndex..textGated` compte les candidats qui correspondaient à l'image mais pas aux mots, de sorte qu'une page vide peut s'expliquer par « retirez les mots » plutôt que « essayez une autre image ». Une recherche par l'exemple sans mots ne charge aucun encodeur et ne subit donc jamais de démarrage à froid ; ajouter des mots fait perdre cet avantage. Dans tous les cas, la recherche porte par défaut sur tous les index : les vecteurs des images recadrées, des enregistrements et des timelapses partagent un même espace, si bien qu'une image recadrée de personne peut retrouver des séquences correspondantes. Les scores des recherches par l'exemple sont bien plus élevés que ceux des recherches textuelles (d'image à image, il n'y a pas d'écart de modalité) et sont filtrés par un seuil distinct, pas encore calibré : `result.queryKind` indique l'échelle utilisée, et un score de l'une ne doit jamais être comparé à un score de l'autre. Par défaut, la recherche porte sur tous les index et renvoie une seule liste fusionnée triée par score ; chaque résultat contient `index` et `kind` afin que l'appelant puisse distinguer un résultat image d'un résultat vidéo (ce dernier ajoute `offsetMs`). Les index sans table pour l'installation sont signalés dans `skipped` au lieu de provoquer un échec. Les résultats sous le seuil de pertinence calibré de chaque index sont écartés : une requête sans véritable correspondance renvoie donc une liste vide plutôt que des résultats absurdes présentés avec assurance ; `perIndex` indique ce que chaque index a apporté et pourquoi. Les résultats peuvent être restreints par heure de capture et par caméra. Préférez `cameraId` à `camera` : il s'agit du balenaUUID de la caméra, la seule valeur stockée de manière identique dans tous les index, si bien qu'un seul filtre les restreint tous. Un filtre qu'un index ne peut pas appliquer est signalé sous `perIndex..filtersIgnored`, et cet index est interrogé sans restriction plutôt qu'exclu de la recherche. Les résultats d'enregistrements sont **un par clip, et non un par image correspondante** : les images sont échantillonnées toutes les 2 s, si bien qu'un sujet qui s'attarde correspond à dix images quasi identiques du même enregistrement. Chaque clip renvoie sa meilleure image, ainsi que `matchCount` et `offsetsMs`, qui listent tous les moments correspondants du clip et peuvent servir directement de points de lecture. Les images recadrées de personnes ne sont jamais regroupées, car deux images recadrées d'une même personne correspondent à deux observations distinctes.

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation dans laquelle effectuer la recherche query `string` (facultatif) Description en texte libre de ce qu'il faut rechercher. Obligatoire sauf si warm=1 ou si un exemple est envoyé. Combinée à un exemple, elle ne sert plus au classement mais devient un filtre sur les candidats de l'exemple, en écartant ceux dont le score textuel est inférieur au seuil de pertinence de l'index. seedIndex `string` (facultatif) Recherche par l'exemple plutôt que par texte : l'index dans lequel se trouve la ligne d'exemple (person-crops, recording-frames, timelapse-frames). Il s'agit de l'`index` du résultat sur lequel l'utilisateur a cliqué. Doit être envoyé avec seedKey. seedKey `string` (facultatif) La `key` de la ligne d'exemple, reprise telle quelle du résultat. L'exemple est exclu de ses propres résultats : pour un enregistrement, cela concerne tout le clip, puisque ses autres images sont espacées de 2 s et quasi identiques. seedFrameId `string` (facultatif) Obligatoire lorsque seedIndex vaut recording-frames : cet index stocke une ligne par image échantillonnée et toutes partagent la clé du clip, si bien que la clé seule désigne un clip et non un moment. Envoyez le `frameId` du résultat. Les lignes plus anciennes n'en ont pas : envoyez alors seedOffsetMs. seedOffsetMs `string` (facultatif) Identifiant d'image de repli pour les exemples recording-frames dont la ligne est antérieure à `frame_id`. Envoyez l'`offsetMs` du résultat. Ignoré lorsque seedFrameId est fourni. warm `string` (facultatif) Préchauffe un conteneur Lambda sans exécuter de recherche. À déclencher au chargement de la page. warmTarget `string` (facultatif) Encodeur chargé par `warm` : `text` (par défaut), `image` ou `both`. Le modèle de vision pèse 355 Mo contre 283 Mo pour le modèle textuel ; son préchauffage est donc facultatif : ne demandez `image` qu'une fois que l'utilisateur a réellement préparé une image, pas au chargement de la page. index `string` (facultatif) Jeux de données à interroger, séparés par des virgules : person-crops, recording-frames, timelapse-frames. Les résultats sont fusionnés en une seule liste triée par score. Les trois sont interrogés par défaut ; passez une liste explicite pour restreindre la recherche. timelapse-frames couvre les caméras qui n'enregistrent rien et ne produisent qu'une image par minute, et son seuil de pertinence n'est pas encore calibré. model `string` (facultatif) Encodeur à utiliser pour la requête. Doit correspondre à l'encodeur utilisé pour indexer le jeu de données. limit `string` (facultatif) Nombre de résultats à renvoyer par index (50 par défaut, 100 au maximum) : il ne s'agit pas d'un total, une recherche sur les trois index peut donc renvoyer jusqu'à trois fois ce nombre. Pour les enregistrements, ce sont les clips qui sont comptés, et non les images correspondantes. from `string` (facultatif) Ne retient que les médias capturés à partir de cette heure, en millisecondes depuis l'epoch. Il s'agit de l'heure de capture, et non de l'heure d'envoi. to `string` (facultatif) Ne retient que les médias capturés avant cette heure (exclue), en millisecondes depuis l'epoch. cameraId `string` (facultatif) balenaUUID des caméras sur lesquelles restreindre la recherche, séparés par des virgules : le champ `balenaUUID` de chaque entrée renvoyée par /api/cctv/recordings/filters/:club. C'est le filtre de caméra à privilégier : tous les index stockent cette même valeur, si bien qu'un seul filtre les restreint tous. Notez que seules les images recadrées dont la jointure avec la détection de visage a abouti la contiennent (~1 % aujourd'hui) : restreindre les images recadrées par caméra renverra donc peu ou pas de résultats tant que le complément des images recadrées n'aura pas été exécuté ; les enregistrements sont entièrement renseignés et filtrés avec précision. camera `string` (facultatif) Noms des caméras sur lesquelles restreindre la recherche, séparés par des virgules. Ne concerne en pratique que les enregistrements : person-crops stocke un nom de caméra vide sur chaque ligne, si bien que toute valeur exclut toutes les images recadrées. Préférez cameraId. cameraGroup `string` (facultatif) Groupes de caméras sur lesquels restreindre la recherche, séparés par des virgules. Renseigné pour tous les enregistrements mais seulement pour ~1 % des images recadrées, pour la même raison que cameraId. minScore `string` (facultatif) Remplace le seuil cosinus par index qui filtre le bruit. À omettre en production ; chaque index dispose d'une valeur par défaut calibrée (et d'une autre, distincte et non calibrée, pour les recherches par l'exemple). Passez 0 pour voir les plus proches voisins sans filtre lors du débogage de la pertinence.

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"

{}

Recherche à partir d'une image dont dispose l'utilisateur, plutôt que par des mots ou par un résultat déjà affiché. Identique au GET à tous les autres égards (mêmes paramètres de requête, même flux d'événements, même forme de résultat) : seule la différence est donc documentée ici. Envoyez les **octets du fichier d'origine** comme corps de requête avec un Content-Type `image/*`. Ne redimensionnez pas, ne recadrez pas et ne réencodez pas l'image dans le navigateur au préalable : le serveur reproduit un redimensionnement très précis (compression en 256x256 avec un noyau bilinéaire anticrénelé) utilisé pour construire les vecteurs indexés, alors que la mise à l'échelle par canvas en utilise un autre. Mesurée, cette substitution aboutit à une distance cosinus d'environ 0,93 par rapport à la bonne réponse, soit davantage qu'entre deux images réellement différentes : les résultats sont alors classés de façon plausible mais erronée, sans aucune erreur. Limite de 4 Mo, qui tient au transport et non à la qualité : les octets transitent dans la charge utile d'appel de la Lambda, plafonnée à 6 Mo, et le base64 en augmente la taille d'un tiers. Les résultats sont évalués d'image à image : `queryKind` vaut donc `image` et les scores sont sur la même échelle, bien plus élevée, qu'une recherche par l'exemple ; ils ne sont jamais comparables aux scores textuels. Attendez-vous à des scores légèrement *inférieurs* à ceux d'une recherche par l'exemple équivalente : le vecteur d'un exemple a été écrit par l'appareil lui-même, alors qu'une image envoyée est réencodée ici par un autre moteur, ce qui la place à quelques centièmes de l'endroit où l'appareil l'aurait placée. Mesurés, les résultats sont malgré tout de qualité égale ; ce n'est simplement pas exactement le même ensemble. Ajouter `query` filtre les résultats selon ces mots, exactement comme pour un exemple. L'envoi d'un exemple *et* d'une image est refusé : les deux constituent l'élément à classer, la combinaison n'a donc pas de sens. Il s'agit de la requête la plus coûteuse traitée par ce point de terminaison. Une image envoyée charge le modèle de vision, et l'ajout de mots charge aussi le modèle textuel, les deux sur un conteneur à froid. Appeler `warm=1&warmTarget=image` dès que l'utilisateur prépare une image retire ce coût du chemin critique.

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation dans laquelle effectuer la recherche body `string` (obligatoire) Octets bruts de l'image, non modifiés, 4 Mo au maximum query `string` (facultatif) Mots facultatifs pour affiner les résultats de l'image, en écartant les correspondances dont le score textuel est inférieur au seuil de pertinence de l'index.

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"

{}

Renvoie les informations de stockage et d'autres métriques de la vidéosurveillance du 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"

{}

Renvoie la liste des enregistrements d'envoi de timelapses d'un club

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

GET /api/cctv/timelapse/:club

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

{}

Répertorier les actions effectuées par les utilisateurs sur les enregistrements dans le front-end ou l'interface CCTV

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Consigner une action effectuée par un utilisateur sur les enregistrements dans le front-end ou l'interface CCTV

Paramètres

body `string` (obligatoire) Objet JSON du nouveau bloc de configuration à ajouter au système.

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"

{}

Obtenir le jeton utilisateur pour le front-end ou l'interface CCTV

Paramètres

club `string` (obligatoire) ID du 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"

{}

Générer un jeton d'accès temporaire ou invité

Paramètres

club `string` (obligatoire) Identifiant unique du club. body `string` (obligatoire) Objet JSON des détails du jeton à émettre.

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"
}

Renvoie la liste des enregistrements de jetons d'accès temporaire ou invité

Paramètres

club `string` (obligatoire) Identifiant unique du 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"

{}

Obtenir un jeton d'accès à partir d'un ID d'accès

Paramètres

accessID `string` (obligatoire) ID de l'enregistrement du jeton dans la base de données.

POST /guest/cctv/token/:accessID

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

{}

Supprimer des horaires d'accès de l'installation

Paramètres

facilityId `string` (obligatoire) body `object` (obligatoire) Objet JSON des nouveaux horaires d'accès.

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"

{}

Renvoie la liste des horaires d'accès de l'installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Met à jour ou crée des horaires d'accès de l'installation

Paramètres

facilityId `string` (obligatoire) body `object` (obligatoire) Objet JSON des nouveaux horaires d'accès.

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"

{}

Supprimer une zone d'accès de l'installation

Paramètres

facilityId `string` (obligatoire) body `object` (obligatoire) Objet JSON de la nouvelle zone d'accès.

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"

{}

Renvoie la liste des zones d'accès de l'installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Met à jour ou crée une zone d'accès de l'installation

Paramètres

facilityId `string` (obligatoire) body `object` (obligatoire) Objet JSON de la nouvelle zone d'accès.

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"

{}

Renvoie l'union de tous les ID de modules d'administration des marques et installations d'une organisation, sous forme d'objets module.

Paramètres

organisationId `string` (obligatoire) ID de l'organisation

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"

{}

Renvoie la liste de toutes les organisations

Paramètres

includeBrands `string` (facultatif) Inclure les marques associées à l'organisation includeFacilities `string` (facultatif) Inclure les installations associées à l'organisation includeRegions `string` (facultatif) Inclure les régions associées à l'organisation

GET /api/organisations

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

{}

Outil d'IA simple qui analyse le contenu d'un ticket d'assistance et propose des suggestions à partir des sujets disponibles, ainsi que des sujets de recherche Algolia suggérés...

Paramètres

messageBody `string` (obligatoire) Corps du message à envoyer topicData `string` (obligatoire) Objet ou tableau JSON des topicData renvoyées par osTicket (système de tickets et d'assistance) facilityId `string` (facultatif) ID interne du club, nécessaire pour déterminer l'index Algolia dans lequel effectuer la recherche.

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"

{}

API simple de génération d'images

Paramètres

type `string` (obligatoire) Type d'image à générer name `string` (obligatoire) Nom de l'image maxSize `string` (facultatif) Taille maximale facultative de la réponse, par exemple 200KB, 1MB ou un nombre d'octets. L'image est redimensionnée ou compressée pour respecter cette taille.

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"

{}

Requête LLM simple

Point de terminaison léger pour des requêtes LLM simples et sans état. Utilise un modèle économique sans raisonnement (gpt-4o-mini) avec des limites de jetons strictes. Pas d'historique de conversation, pas d'outils, pas de streaming : un prompt en entrée, du texte en sortie.

Corps de la requête

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 '{}'

{}

Renvoie la configuration Algolia, notamment le nom de l'index, l'ID de l'application et la clé API.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Initialise l'index Algolia des supports marketing imprimés

Paramètres

organisationId `string` (obligatoire)

PUT /api/algolia/index

curl -X PUT https://portal.hub.gymsystems.co/api/algolia/index \
  -H "x-api-key: YOUR_API_KEY"

{}

Rechercher des supports marketing imprimés

Corps de la requête

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 '{}'

{}

Rechercher des supports marketing imprimés

Paramètres

club `string` (facultatif) ID du club searchTerms `string` (facultatif) Termes de recherche algoliaArgs `object` (facultatif) Arguments de recherche Algolia supplémentaires

GET /algolia/search-marketing-print

curl -X GET https://portal.hub.gymsystems.co/algolia/search-marketing-print \
  -H "x-api-key: YOUR_API_KEY"

{}

Met à jour en masse les objets marketing imprimés d'un club donné

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"

{}

Récupère les supports marketing imprimés depuis Algolia.

Paramètres

organisationId `string` (obligatoire) search `string` (facultatif) limit `string` (facultatif) brand `string` (facultatif) tag `string` (facultatif)

GET /api/algolia/marketing/assets

curl -X GET https://portal.hub.gymsystems.co/api/algolia/marketing/assets \
  -H "x-api-key: YOUR_API_KEY"

{}

Initialise l'index Algolia des supports marketing imprimés avec la configuration de l'installation.

Paramètres

organisationId `string` (obligatoire)

POST /api/algolia/marketing/assets

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

{}

Effectue une recherche dans un index Algolia donné à partir de termes de recherche, d'un club et/ou d'une langue. La recherche peut être affinée avec des arguments Algolia supplémentaires.

Paramètres

searchTerms `string` (obligatoire) Termes à rechercher dans l'index Algolia. club `string` (facultatif) ID interne du club qui effectue la requête. S'il est indiqué, la recherche est filtrée selon la région associée au club. locale `string` (facultatif) Langue utilisée pour déterminer la région si aucun club n'est indiqué. Déduite de navigator.languages. algoliaArgs `string` (facultatif) Arguments supplémentaires ou personnalisés à transmettre à la requête de recherche 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"

{}

Répertorie toutes les annonces

GET /api/announcements/list

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

{}

Envoie un fichier vers un BUCKET S3 PUBLIC (via l'API d'envoi de fichiers), qui le post-traite et l'optimise, génère des miniatures, etc. *Remarque : les fichiers seront accessibles publiquement*

Paramètres

file `string` (facultatif) Nom du fichier à envoyer.

POST /api/asset-upload

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

{}

Renvoie l'état de l'envoi à partir de l'UUID de l'enregistrement d'envoi

Paramètres

uuid `string` (obligatoire) UUID de l'enregistrement d'envoi

GET /api/asset-upload/:uuid

curl -X GET https://portal.hub.gymsystems.co/api/asset-upload/:uuid \
  -H "x-api-key: YOUR_API_KEY"

{}

Envoyer une commande au système Sonos du club

Paramètres

body `object` (obligatoire) Objet JSON de la commande et des données à envoyer à 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"

{}

Récupérer la configuration du front-end Contrôle audio

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Modifier la configuration du front-end Contrôle audio

Paramètres

body `object` (obligatoire) Objet JSON du nouveau bloc de configuration à ajouter au système.

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"

{}

Récupère les paramètres d'une marque pour une région donnée

Paramètres

brandId `string` (facultatif) ID de la marque regionCode `string` (facultatif) Code ISO de la région dont récupérer les paramètres

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"

{}

Met à jour plusieurs paramètres d'une marque pour une région donnée

Paramètres

brandId `string` (facultatif) ID de la marque à mettre à jour regionCode `string` (facultatif) Code ISO de la région dont mettre à jour les paramètres acceptFreeTrialBookingsVisibility `string` (facultatif) customTrackingCodeVisibility `string` (facultatif) displayDataSources `string` (facultatif) displayDefaultDataSource `string` (facultatif) displayDefaultUI `string` (facultatif) displayUIOptions `string` (facultatif) defaultAboutBusiness `string` (facultatif) defaultAboutBusinessFacebook `string` (facultatif) facilityCoverImage `string` (facultatif) digitalProfileSettingsVisibility `string` (facultatif) facilityHoursVisibility `string` (facultatif) facilityLocationVisibility `string` (facultatif) facilityPaymentMethods `string` (facultatif) facilityPrimaryLogo `string` (facultatif) facilityStatusVisibility `string` (facultatif) landingPagesVisibility `string` (facultatif) lineChatIntegrationVisibility `string` (facultatif) whatsAppIntegrationVisibility `string` (facultatif) defaultWhatsAppMessage `string` (facultatif) socialUrlsVisibility `string` (facultatif) yextApiKey `string` (facultatif) Clé API utilisée par l'intégration Yext pour cette marque et cette région. Consultée uniquement lorsque `directorySyncMode` vaut `yext`. directorySyncMode `string` (facultatif) Système de synchronisation à exécuter pour les installations de cette marque et de cette région. Vaut `yext` par défaut lorsqu'il est absent, pour la rétrocompatibilité avec les marques antérieures au déploiement de Directory Publishers. websiteUrl `string` (facultatif) androidAppUrl `string` (facultatif) iosAppUrl `string` (facultatif) featuredMessageDescription `string` (facultatif) yextCategoryIds `string` (facultatif) Ancienne clé de stockage : il s'agit en réalité d'ID de catégories Google Business Profile (par exemple gcid:gym). Le préfixe "yext" est antérieur à l'abandon de Yext ; il est conservé pour la rétrocompatibilité avec les lignes existantes de la base de données. customInputFields `string` (facultatif) customInputFieldsToRemove `string` (facultatif)

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"

{}

Récupère les paramètres de marque d'une installation donnée

Paramètres

facilityId `string` (facultatif) ID de l'installation dont récupérer les paramètres de marque

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"

{}

Crée une nouvelle marque

Paramètres

name `string` (obligatoire) Nom de la marque organisationId `string` (obligatoire) ID de l'organisation à laquelle appartient la marque redirectDashboard `string` (facultatif) URL de redirection après la connexion, à la place du tableau de bord par défaut

POST /api/brands

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

{}

Renvoie la liste de toutes les marques

GET /api/brands

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

{}

Renvoie l'objet marque

Paramètres

brandId `string` (obligatoire) ID de la marque à récupérer includeOrganisation `boolean` (facultatif) Indique s'il faut inclure les données de l'organisation dans la réponse

GET /api/brands/{brandId}

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

{}

Met à jour une marque à partir de son ID

Paramètres

brandId `string` (facultatif) ID de la marque à mettre à jour name `string` (obligatoire) Nom de la marque brandOrganisationId `string` (facultatif) ID de l'organisation à laquelle appartient la marque redirectDashboard `string` (facultatif) URL de redirection après la connexion, à la place du tableau de bord par défaut yextApiKey `string` (facultatif) Clé API utilisée pour accéder à l'API Yext pour cette marque customMenuLayout `object` (facultatif) Arborescence du menu latéral propre à la marque (sections / groupes / éléments faisant référence à des modules du système ou à des URL personnalisées). Ne peut être définie que par un administrateur de l'organisation de cette marque.

PUT /api/brands/{brandId}

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

{}

Répertorier les installations d'une marque

Renvoie une liste allégée des installations (ID, nom, code ISO de la région) appartenant à la marque. Sert à alimenter les sélecteurs de ciblage d'installations dans la configuration de la marque.

Paramètres

brandId `string` (obligatoire) ID de la marque dont répertorier les installations

GET /api/brands/{brandId}/facilities

curl -X GET https://portal.hub.gymsystems.co/api/brands/{brandId}/facilities \
  -H "x-api-key: YOUR_API_KEY"

{}

Renvoie la liste de toutes les marques associées à l'organisation du 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"

{}

Renvoie la liste de tous les types de calendrier

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"

{}

Supprimer une bannière du tableau de bord

Supprime logiquement une bannière du tableau de bord appartenant à la marque.

Paramètres

brandId `string` (obligatoire) ID de la marque à laquelle appartient la bannière bannerId `string` (obligatoire) ID de la bannière à supprimer

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"

{}

Répertorier les bannières du tableau de bord d'une marque

Renvoie toutes les bannières du tableau de bord (non supprimées) configurées pour la marque, à des fins de gestion.

Paramètres

brandId `string` (obligatoire) ID de la marque dont répertorier les bannières

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"

{}

Créer ou mettre à jour une bannière du tableau de bord

Crée une nouvelle bannière du tableau de bord pour la marque, ou met à jour une bannière existante lorsque `bannerId` est fourni dans le corps. Les bannières peuvent être planifiées (début/fin en secondes Unix, null = sans limite) et ciblées sur toute la marque, sur des régions précises (codes ISO) ou sur des installations précises.

Paramètres

brandId `string` (obligatoire) ID de la marque à laquelle appartient la bannière

Corps de la requête

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 '{}'

{}

Obtenir les bannières actives du tableau de bord d'une installation

Détermine les bannières du tableau de bord à afficher actuellement pour une installation, selon la marque et la région (code pays ISO) de l'installation, ainsi que l'indicateur d'activation, la période de diffusion et le ciblage de chaque bannière. Utilisé par les interfaces du tableau de bord.

Paramètres

facilityId `string` (obligatoire) L'ID de l'installation pour laquelle déterminer les bannières

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"

{}

Renvoie le fichier KYC d'un club.

Paramètres

clubId `string` (obligatoire) ID du club. key `string` (obligatoire) Clé du fichier 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"

{}

Renvoie les informations KYC du 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"

{}

Met à jour les informations KYC du club.

Paramètres

clubId `string` (obligatoire) ID du club à mettre à jour. body `object` (obligatoire)

PUT /api/clubs/{clubId}/kyc

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

{}

Envoie un fichier KYC pour un club.

Paramètres

clubId `string` (obligatoire) ID du club. file `string` (obligatoire) Fichier à envoyer.

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"

{}

Renvoie les paramètres de préférences du 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"

{}

Crée ou met à jour une entrée de préférences du club.

Corps de la requête

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 '{}'

{}

Renvoie la liste des membres ayant un accord.

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"

{}

Renvoie la liste des membres ayant un accord.

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"

{}

Renvoie la liste des utilisateurs du club indiqué

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder

GET /api/clubs/{club}/members

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

{}

Indique si le club est ouvert à la date donnée.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. date `string` (obligatoire) Date à vérifier, au format 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"

{}

Renvoie toutes les métadonnées du club affichées sur les sites web Example Club.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Met à jour les métadonnées d'un club avec les nouvelles données fournies par le front-end. Les champs absents du corps de la requête sont conservés (ni SET ni REMOVE). Les champs envoyés avec `null` ou une chaîne vide sont effacés. Passez `updateAll: false` pour utiliser le chemin dédié de fusion partielle ; dans les deux cas, les appelants n'ont jamais besoin d'envoyer des champs qui ne leur appartiennent pas.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. body `string` (obligatoire) Objet JSON des données du club à mettre à jour.

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"

{}

ajouter un nouvel enregistrement de suivi personnalisé

Paramètres

club `string` (obligatoire) ID du club body `string` (obligatoire) Tableau des éléments de suivi personnalisé.

POST /api/clubs/{club}/customtracking

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

{}

Renvoie le suivi personnalisé d'un club donné

GET /api/clubs/customtracking/:clubID

curl -X GET https://portal.hub.gymsystems.co/api/clubs/customtracking/:clubID \
  -H "x-api-key: YOUR_API_KEY"

{}

Mettre à jour les entrées de suivi personnalisé

Paramètres

club `string` (obligatoire) ID du club body `string` (obligatoire) Objet JSON des données du club à mettre à jour.

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"

{}

Renvoie l'image de devanture par défaut d'un club.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Répertorier les portes disponibles dans l'installation

Paramètres

body `object` (obligatoire) Objet JSON des données du club à mettre à jour.

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"

{}

Déverrouiller une porte donnée de l'installation

Paramètres

body `object` (obligatoire) Objet JSON des données du club à mettre à jour.

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"

{}

Renvoie toutes les intégrations et leurs détails de configuration pour le club indiqué.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Met à jour les métadonnées d'un club avec les nouvelles données fournies par le front-end.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. body `object` (obligatoire) Objet JSON des données du club à mettre à jour.

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"

{}

Renvoie un booléen indiquant si le club se trouve dans un pays européen

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. date `string` (obligatoire) Date à vérifier, au format 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"

{}

Renvoie une liste générale de tous les clubs de notre base de données.

GET /api/clubs/listclubs

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

{}

Indique si le club est ouvert à la date donnée.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. date `string` (obligatoire) Date à vérifier, au format 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"

{}

Récupère les avis du club depuis DynamoDB.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Récupère les paramètres des avis du club depuis DynamoDB.

Paramètres

facilityId `string` (obligatoire) ID de l'installation

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"

{}

Met à jour les paramètres des avis du club dans DynamoDB.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Réactive la publication automatique dans les paramètres des avis.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Publie un avis

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. review `string` (obligatoire) ID interne de l'avis à publier.

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"

{}

Réactive la publication automatique dans les paramètres des avis.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Publie une réponse à un avis via la plateforme d'origine de l'avis (Google, etc.).

Paramètres

club `string` (obligatoire) ID de l'installation reviewId `string` (obligatoire) ID de l'avis PH (recherché dans la table club-social-reviews) body `string` (obligatoire)

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"

{}

Dépublie un avis

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. review `string` (obligatoire) ID interne de l'avis à dépublier.

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"

{}

Renvoie la liste des propriétaires du club indiqué depuis la base de données PH

Paramètres

clubID `string` (obligatoire) ID interne du club auquel vous souhaitez accéder

GET /api/clubs/{clubID}/owners

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

{}

Renvoie toutes les formules d'abonnement de l'installation.

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation

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"

{}

Met à jour une formule d'abonnement.

Paramètres

facilityId `string` (obligatoire) ID interne de l'installation body `object` (obligatoire) Objet JSON des données de la formule d'abonnement à mettre à jour.

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"

{}

Réactive la publication automatique dans les paramètres des avis.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Réactive la publication automatique dans les paramètres des avis.

Paramètres

club `string` (obligatoire) ID du 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"

{}

Renvoie la liste de toutes les devises disponibles

GET /api/currencies

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

{}

Renvoie la position géographique à partir d'une adresse IP.

Paramètres

ip `string` (obligatoire) Adresse IP à rechercher

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"

{}

Renvoie la position géographique de l'utilisateur actuel d'après son adresse 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"

{}

Renvoie uniquement l'adresse IP publique du client demandeur (aucune géolocalisation, aucun appel à une API tierce). Utilisé par l'applet Agent IA pour comparer l'adresse IP publique du navigateur à l'adresse IP WAN signalée par un appareil, afin de détecter s'ils sont sur le même réseau.

GET /api/geo/client-ip

curl -X GET https://portal.hub.gymsystems.co/api/geo/client-ip \
  -H "x-api-key: YOUR_API_KEY"

{}

Analyseur de numéros de téléphone.

Paramètres

body `string` (obligatoire) Objet JSON du numéro à analyser.

POST /api/phone/parser

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

{}

Renvoie l'appareil horloge maître

Paramètres

club_id `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil.

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"

{}

Renvoie l'appareil Sonos maître

Paramètres

club_id `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil.

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"

{}

obtenir les notifications de batterie faible Duress pour un club donné.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie les données d'analyse du réseau

Paramètres

club_id `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil.

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"

{}

envoyer les notifications de batterie faible Duress pour un club donné.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie les données de test de débit des appareils pour chaque type d'appareil

Paramètres

club_id `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil.

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"

{}

Obtenir les statistiques de fiche d'une installation. Renvoie par défaut les totaux quotidiens agrégés de tous les éditeurs, ou ceux d'un seul éditeur lorsque `publisherId` est fourni.

Paramètres

facilityId `string` (obligatoire) publisherId `string` (facultatif) startDate `string` (obligatoire) endDate `string` (obligatoire)

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"

{}

Obtenir les statistiques de fiche agrégées d'une marque pour tous les éditeurs.

Paramètres

brandId `string` (obligatoire) startDate `string` (obligatoire) endDate `string` (obligatoire)

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"

{}

Principaux mots-clés de recherche (avec répartition marque / hors marque) pour une installation, provenant actuellement de Google Business Profile.

Paramètres

facilityId `string` (obligatoire) publisherId `string` (facultatif) Valeur par défaut : "google" ; seul Google est pris en charge actuellement. startDate `string` (obligatoire) endDate `string` (obligatoire) limit `string` (facultatif)

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"

{}

Principaux mots-clés de recherche d'une marque, agrégés sur toutes les installations.

Paramètres

brandId `string` (obligatoire) startDate `string` (obligatoire) endDate `string` (obligatoire) limit `string` (facultatif)

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"

{}

Lister les questions-réponses d'une installation.

Paramètres

facilityId `string` (obligatoire)

GET /api/facilities/{facilityId}/qna

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

{}

Répondre à une question.

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"

{}

Supprimer une réponse.

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"

{}

Renvoie les éditeurs activés pour l'organisation de l'installation, avec leur état de connexion.

Paramètres

facilityId `string` (obligatoire) organisationId `string` (obligatoire)

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"

{}

Obtenir les paramètres partagés de Door/Gate Access d'une installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Mettre à jour les paramètres partagés de Door/Gate Access d'une installation

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Obtenir les Access Policies d'une installation

La configuration d'accès existante est automatiquement convertie en stratégies appliquées équivalentes lors de la première lecture.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Remplacer les Access Policies avec contrôle de révision optimiste

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Créer une Access Policy

Paramètres

facilityId `string` (obligatoire)

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"

{}

Mettre à jour une Access Policy

Paramètres

facilityId `string` (obligatoire) policyId `string` (obligatoire)

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"

{}

Supprimer une Access Policy

Paramètres

facilityId `string` (obligatoire) policyId `string` (obligatoire) revision `integer` (obligatoire)

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"

{}

Dupliquer une Access Policy avec un nouvel ID stable

Paramètres

facilityId `string` (obligatoire) policyId `string` (obligatoire)

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"

{}

Compter les utilisateurs et les portes concernés par toutes les Access Policies

Paramètres

facilityId `string` (obligatoire)

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"

{}

Compter les utilisateurs et les portes concernés par une Access Policy

Paramètres

facilityId `string` (obligatoire) policyId `string` (obligatoire)

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"

{}

Lister les types de personnes, statuts et étiquettes de l'installation

Renvoie les valeurs distinctes de type de personne, de statut d'adhésion et d'étiquette présentes dans les lignes User Access de l'installation (ph-door-access-users), issues de la synchronisation partenaire et de la saisie manuelle. L'applet door-gate-access s'en sert pour remplir les listes déroulantes des règles d'accès. Les étiquettes sont l'union des `tags` synchronisés et des `customTags` d'administration, comme dans l'évaluateur de règles.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Lister les contrôleurs de porte d'une installation avec leurs règles Door/Gate Access effectives

Paramètres

facilityId `string` (obligatoire)

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"

{}

Enregistrer les remplacements par porte, l'icône et la configuration côté appareil

Point d'écriture unique pour tout ce que l'applet d'administration DGA modifie sur une porte : - `accessRulesOverride` / `geofenceOverride` : transmettez `null` pour effacer la valeur et revenir à la valeur par défaut de l'installation. - `icon` : clé de transmission stable (voir services/door-access/door-icons.js) ; les valeurs inconnues renvoient 400. - `holdTimeSeconds` (1 à 30), `maintenanceMode` (`off` / `force-open` / `force-closed`), `doorLocation` (texte libre, 64 caractères maximum), `playNotificationSoundOnRelayToggle` (booléen), `autoUnlockSchedule` (grille de créneaux hebdomadaires). Ces champs n'étaient auparavant modifiables que dans Gestion d'appareils, mais l'applet les écrit désormais sur place, pour que les administrateurs n'aient pas à quitter le panneau de la porte pour les modifications de configuration courantes. Lorsque l'un des champs côté appareil est modifié, la route transmet aussi les variables d'environnement Balena correspondantes (`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`) et envoie une commande MQTT `unlockUpdates`, afin que l'appareil applique la nouvelle configuration sans attendre la prochaine actualisation des variables Balena. Au mieux : la réponse est 200 même si Balena est temporairement injoignable.

Paramètres

facilityId `string` (obligatoire) doorId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Sonde légère de l'état Balena pour l'avis de rechargement du panneau de la porte

Le panneau de l'applet DGA récupère ces données à la demande lorsqu'un administrateur ouvre une porte, afin d'afficher le bon texte « l'enregistrement va recharger le contrôleur » : la variante par défaut « quelques secondes », ou la variante plus forte « plusieurs minutes » lorsqu'une mise à jour de version est aussi en attente. Renvoie un instantané à plat dérivé de `balena.models.device.get()`. En cas d'échec, renvoie `data: null` (plutôt qu'une erreur 5xx), de sorte qu'une panne de Balena dégrade le texte de l'avis au lieu d'empêcher l'ouverture du panneau.

Paramètres

facilityId `string` (obligatoire) doorId `string` (obligatoire)

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"

{}

Forçage administrateur : déverrouiller une porte depuis l'applet

Active brièvement le relais selon le `holdTimeSeconds` actuel de la porte, et écrit une ligne d'audit `admin-override` dans ph-door-app-access-events afin que l'action soit attribuable dans les Journaux d'accès. Réussit toujours, même si `maintenanceMode === 'force-closed'` : c'est l'issue de secours de l'administrateur. Renvoie 200 dès que la publication MQTT est envoyée ; les états confirmé / échoué / expiré ne sont pas attendus ici (l'ancien flux /api/devices/door-controllers + /api/ics/devices/command fonctionne lui aussi sans attente de confirmation).

Paramètres

facilityId `string` (obligatoire) doorId `string` (obligatoire)

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"

{}

Émettre une séquence de bips de localisation sur le contrôleur de porte

Publie une commande MQTT `beep` pour que le contrôleur émette trois bips de durée moyenne (environ 500 ms chacun, environ 350 ms d'intervalle, environ 2 s au total). Utilisé par les administrateurs pour localiser physiquement un contrôleur de porte sur site. L'ancien bouton de Gestion d'appareils utilise une salve d'environ 30 s de bips courts, mais le pilote du buzzer du firmware n'émet de façon fiable que le premier ; l'applet envoie donc une séquence plus courte et plus fiable. Aucune ligne d'audit : action de diagnostic sans effet sur le contrôle d'accès.

Paramètres

facilityId `string` (obligatoire) doorId `string` (obligatoire)

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"

{}

Redémarrer à distance un contrôleur de porte

Publie la même commande MQTT `rebootDevice`, sans attente de confirmation, que le bouton « Remotely Reboot Device » de l'ancienne Gestion d'appareils, mais conditionnée par le module `door-gate-access`, pour que les administrateurs DGA puissent redémarrer un contrôleur depuis la section Advanced du panneau de la porte sans autorisation `device-management` distincte. Renvoie 200 dès que la publication est envoyée ; l'appareil passe hors ligne pendant le redémarrage.

Paramètres

facilityId `string` (obligatoire) doorId `string` (obligatoire)

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"

{}

Lister les lignes User Access d'une installation

Renvoie toutes les lignes user-access non supprimées de l'installation. Prend en charge des filtres côté client (source, search, accessEnabled, hasGrants). Le calcul côté serveur `hideExcluded` de la phase 4 sera ajouté lorsque l'évaluateur d'autorisations hybrides sera disponible ; pour l'instant, le paramètre est accepté mais l'ensemble complet est renvoyé.

Paramètres

facilityId `string` (obligatoire) search `string` (facultatif) source `string` (facultatif) accessEnabled `string` (facultatif) hasGrants `string` (facultatif) hideExcluded `boolean` (facultatif) Si true, les utilisateurs synchronisés (source != manual) qui ne peuvent franchir aucune porte de cette installation à aucun moment sont masqués. La réponse inclut une enveloppe `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"

{}

Créer manuellement une ligne User Access dans une installation

Crée une nouvelle ligne avec `source: 'manual'`. Renvoie 409 avec `existingUserId` si le téléphone ou l'e-mail fourni correspond déjà à une ligne de cette installation.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

Obtenir une ligne User Access

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Mise à jour partielle d'une ligne User Access

Modifie n'importe quel sous-ensemble des champs d'identité et d'autorisation. Transmettez `null` pour effacer un champ facultatif. Renvoie 409 si le nouveau téléphone ou e-mail entre en conflit avec une autre ligne de la même installation. `appMessage` accepte la même structure que le message à l'échelle de l'installation de PUT /api/door-access/rules/{facilityId} : corps du texte, gravité, lien facultatif, calendrier de début et de fin facultatif. L'application mobile l'affiche sur le tableau de bord uniquement pour l'utilisateur ciblé.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Supprimer de manière logique une ligne User Access

Marque la ligne `deleted: true` et désactive l'accès. Le lien du journal d'audit avec le userId est conservé ; les administrateurs peuvent réactiver l'accès manuellement.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Attribution des accès par porte pour un utilisateur

Pour chaque porte, renvoie l'autorisation déterministe actuelle (`allowedNow`, `allowedVia`, `deniedReason`) et les chemins configurés pour les Access Policies, les autorisations permanentes, les calendriers de stratégie, les autorisations par créneau horaire accordées par un administrateur et les créneaux récents mappés depuis la source partenaire. Renvoie aussi la disponibilité active ou suivante et la fraîcheur de la source. Le blockAllAccess de la porte et la maintenance sont évalués avant tous les chemins d'autorisation.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Créer en masse des lignes User Access à partir d'une importation CSV

Crée plusieurs lignes `source: 'manual'` en une seule requête, en réutilisant la même validation, la même normalisation du téléphone et de l'e-mail, le même contrôle de conflit par installation, la même messagerie automatique et la même logique d'invitation (facultative) que la création unitaire. Les lignes sont traitées dans l'ordre : une ligne ultérieure en conflit avec une ligne créée plus tôt est signalée comme doublon. Les autorisations sont fournies sous forme d'ID de porte ou de groupe déjà résolus (le client convertit les noms en ID). Les autorisations par créneau horaire sont volontairement refusées en masse et doivent être ajoutées via le point de terminaison de remplacement par utilisateur après l'importation. Ne lève jamais d'erreur par ligne ; le résultat de chaque ligne est signalé individuellement.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Remplacer les autorisations hybrides d'une ligne User Access

Interface de l'évaluateur hybride de la phase 3. Les autorisations coexistent avec les règles d'étiquettes de l'installation : un utilisateur est autorisé si l'une ou l'autre correspond au moment du déverrouillage.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Remplacer les autorisations additives Access Time Window d'une ligne User Access

Remplace uniquement `timeWindowGrants` ; les `grants` permanents et les `sourceTimeWindows` d'intégration ne sont pas modifiés. Chaque élément exige une portée (`facilityWide`, `doors` ou `groups`) et un `window` absolu ou hebdomadaire. L'envoi d'un tableau vide efface explicitement tous les créneaux d'administration.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Figer une ligne User Access face aux mises à jour de synchronisation provenant de la source

Définit `decoupledFromSource: true`, efface tous les `sourceTimeWindows` gérés par l'intégration, et fait en sorte que la synchronisation (cron + flux) journalise et ignore cette ligne jusqu'à ce qu'un administrateur efface l'indicateur via /recouple.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Rattacher une ligne User Access aux mises à jour de synchronisation provenant de la source

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Révoquer tous les jetons d'actualisation de l'application Door/Gate Access d'un utilisateur

Révoque selon le téléphone ou l'e-mail enregistré de l'utilisateur (la table des jetons d'actualisation est indexée par `sha256(plaintext)` ; les GSI byMobilePhone / byEmail permettent une suppression en éventail à partir d'un seul utilisateur). Les autres utilisateurs partageant le même téléphone ou e-mail dans une autre installation seraient aussi déconnectés.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

(Ré)envoyer l'e-mail d'invitation à l'application Door/Gate Access à un utilisateur

Force l'envoi de l'e-mail d'invitation au téléchargement de l'application à l'adresse e-mail enregistrée de l'utilisateur (e-mail uniquement, pas de SMS). Ignore les contrôles d'éligibilité et de déjà-envoyé utilisés par la synchronisation automatique : il s'agit d'une action explicite d'un administrateur. Renvoie 400 si aucun e-mail n'est enregistré pour l'utilisateur.

Paramètres

facilityId `string` (obligatoire) userId `string` (obligatoire)

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"

{}

Prévisualiser les destinataires d'un envoi groupé d'invitations à l'application

Calcule l'ensemble des utilisateurs qui recevraient un e-mail d'invitation à l'application. Le groupe de base comprend tous les utilisateurs non supprimés disposant d'un e-mail et n'ayant jamais utilisé l'application (`appLastSeenAt` vide). Par défaut, le groupe est restreint aux utilisateurs qui ont actuellement accès (correspondance de règle ou autorisation) et n'ont jamais été invités ; `includeAlreadyInvited` et `includeNoAccess` l'élargissent. Aucun e-mail n'est envoyé : renvoie des totaux, un petit échantillon et les userIds candidats pour le point de terminaison d'exécution.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Envoyer des e-mails d'invitation à l'application à un lot d'utilisateurs

Envoie l'e-mail d'invitation au téléchargement de l'application à chacun des userIds fournis (50 maximum par requête ; le client découpe en lots la liste complète des candidats issue de la prévisualisation). Chaque utilisateur est revalidé au moment de l'envoi : les lignes qui n'existent plus, sans e-mail ou dont l'utilisateur a utilisé l'application depuis la prévisualisation sont ignorées, jamais en échec. Le résultat de chaque utilisateur est signalé individuellement pour que le client puisse récapituler les envois réussis, échoués et ignorés.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Lister les groupes de portes d'une installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Créer un groupe de portes

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

Obtenir un groupe de portes

Paramètres

facilityId `string` (obligatoire) groupId `string` (obligatoire)

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"

{}

Mettre à jour un groupe de portes

Paramètres

facilityId `string` (obligatoire) groupId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Supprimer de manière logique un groupe de portes

Paramètres

facilityId `string` (obligatoire) groupId `string` (obligatoire)

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"

{}

Lister les intégrations partenaires configurées dans une installation

Renvoie les intégrations partenaires de l'installation (id, name, logo, enabled) en joignant ph-facility-partner-config au catalogue ph-partners. Limité à door-gate-access (pour que les administrateurs sans accès external-integrations puissent quand même afficher les badges partenaires et la liste de synchronisation par partenaire).

Paramètres

facilityId `string` (obligatoire)

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"

{}

Lire la configuration de synchronisation User Access d'une installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Mettre à jour la configuration de synchronisation User Access d'une installation

Seuls les champs contrôlés par l'administrateur (`enabled`, `requireIdentifier` et la table `partners` des partenaires) sont acceptés ; `lastRunAt` et `lastRunCounts` sont écrits par le moteur de synchronisation lui-même. `partner.partners` est une table d'activation par partenaire indexée par partnerId (désactivation explicite) : lorsque le `partner.enabled` principal est activé, un partenaire est synchronisé sauf s'il a ici une entrée explicite `{ enabled: false }`.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Lire la configuration de messagerie automatique par utilisateur d'une installation

Paramètres

facilityId `string` (obligatoire)

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"

{}

Mettre à jour la configuration de messagerie automatique par utilisateur d'une installation

Enregistre les règles, puis réévalue immédiatement chaque ligne User Access de l'installation, afin que les utilisateurs existants reçoivent ou perdent tout de suite leur message automatique. Les messages manuels et les lignes découplées ne sont pas modifiés.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

État de la réévaluation en arrière-plan des messages automatiques

Paramètres

facilityId `string` (obligatoire)

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"

{}

Lancer à la demande une synchronisation User Access pour une installation

Parcourt de façon synchrone chaque source activée (partenaire / vidéosurveillance) de l'installation et fait converger les lignes ph-door-access-users via la cascade de dédoublonnage. Renvoie des totaux par source. Les sources désactivées apparaissent sous la forme `skippedSyncDisabled: 1` plutôt que d'être absentes, afin que l'interface puisse afficher les deux lignes de façon cohérente.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Prévisualisation à blanc d'une suppression groupée des utilisateurs synchronisés par un partenaire

Renvoie le nombre et un échantillon des lignes user-access qui seraient supprimées de manière logique, ainsi qu'un confirmToken à renvoyer au point de terminaison d'exécution. Aucune donnée n'est modifiée. Les journaux d'accès ne sont jamais affectés.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Exécuter une suppression groupée des utilisateurs synchronisés par un partenaire (suppression logique)

Supprime de manière logique toutes les lignes user-access synchronisées par un partenaire comprises dans la portée. Exige le confirmToken renvoyé par la prévisualisation ; si l'ensemble réel a changé depuis la prévisualisation, le jeton ne correspond pas et la requête est refusée (409) pour que l'administrateur vérifie à nouveau. Les journaux d'accès sont conservés.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Activité récente de synchronisation User Access (journal de dépannage)

Renvoie les résultats de synchronisation les plus récents d'une installation (créé / ignoré / désactivé) avec leur motif, pour que les administrateurs puissent voir pourquoi un membre a été synchronisé ou non. Du plus récent au plus ancien.

Paramètres

facilityId `string` (obligatoire) limit `integer` (facultatif)

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"

{}

Lister les événements Door/Gate Access d'une installation

Renvoie les événements de déverrouillage mobiles, de forçage administrateur et de l'API Partner externe dans un seul flux antichronologique.

Paramètres

facilityId `string` (obligatoire) from `integer` (facultatif) to `integer` (facultatif) limit `integer` (facultatif)

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"

{}

Simuler une évaluation de géorepérage pour l'épingle du mode test administrateur

Corps de la requête

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 '{}'

{}

Obtenir l'état d'intégration et d'activation d'une installation

Alimente la page d'accueil « Get Started » de l'applet et la bannière de progression de la configuration. Renvoie le nombre actuel de portes et d'utilisateurs, les deux étapes principales dérivées (un utilisateur existe, une porte existe), les indicateurs facultatifs « reviewed » enregistrés, et si l'installation est activée (les deux étapes principales effectuées). La première fois qu'une installation est activée, l'horodatage activatedAt est enregistré.

Paramètres

facilityId `string` (obligatoire)

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"

{}

Mettre à jour les indicateurs facultatifs d'intégration « reviewed » d'une installation

Enregistre les indicateurs facultatifs de la liste de configuration cochés par un administrateur (règles d'accès, paramètres de synchronisation, géorepérage). Les étapes principales et l'activation sont dérivées en direct du nombre de données et ne peuvent pas être définies ici. Renvoie l'état d'intégration complet actualisé.

Paramètres

facilityId `string` (obligatoire)

Corps de la requête

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 '{}'

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

GET /clubs/{clubId}/lead-events

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

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

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"

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

GET /clubs/{clubId}/analytics/referrers

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

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

GET /clubs/{clubId}/analytics/socials

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

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

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"

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

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"

{}

Renvoie une réponse JSON contenant les données d'analyse de l'installation.

Paramètres

clubId `string` (facultatif) L'ID de l'installation dont récupérer les données d'analyse. fromDate `string` (facultatif) La date de début des données d'analyse à récupérer. toDate `string` (facultatif) La date de fin des données d'analyse à récupérer.

GET /clubs/{clubId}/analytics/traffic

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

{}

Génère un JWT (JSON Web Token) front-end temporaire pour les graphiques intégrables Google Analytics de la page 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"

{}

Renvoie les widgets de tableau de bord de 'The Training Camp' si l'installation compte des membres actifs.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie tous les jours fériés de l'installation non encore vérifiés.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Marquer comme vérifiés tous les jours fériés de l'installation non encore vérifiés.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie le rapport KPI au format CSV, ventilé mois par mois sur les 12 derniers mois. *NOTE* Cela crée un seul rapport pour TOUTES les installations du système. Ne l'exécutez pas plusieurs fois en parallèle, sous peine de surcharger GymMaster !

Paramètres

months `string` (facultatif) Nombre de mois (à partir de la date actuelle) à récupérer (12 par défaut)

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"

{}

Renvoie le ou les graphiques de chiffre d'affaires du MMS pour une installation donnée.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. range `string` (facultatif) Plage en jours (en remontant à partir de la date actuelle) à récupérer

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"

{}

Renvoie les données et analyses MMS (Member Management System) du tableau de bord pour une installation donnée. Les données incluent les statistiques GymMaster/Perfect Gym ainsi que d'autres indicateurs internes collectés par notre système.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder. range `string` (facultatif) Plage en jours (en remontant à partir de la date actuelle) à récupérer

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"

{}

Renvoie les données du widget Myzone du tableau de bord pour une installation donnée.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie un objet des services considérés comme hors ligne par un ou plusieurs de nos points de terminaison de page d'état ou de surveillance, configurés via l'outil interne '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"

{}

Renvoie les réservations d'entraînement à venir pour les 7 prochains jours.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez accéder.

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"

{}

Renvoie la liste historique des jours fériés d'une installation.

Paramètres

clubId `string` (facultatif) ID du club fromDate `string` (facultatif) Horodatage Unix de la date de début de la plage de jours fériés à renvoyer. toDate `string` (facultatif) Horodatage Unix de la date de fin de la plage de jours fériés à renvoyer.

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"

{}

Renvoie les automatisations d'appareils associées à l'installation.

Paramètres

club `string` (obligatoire) ID interne du club dont vous souhaitez répertorier les appareils.

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"

{}

Met à jour la configuration d'un écran ou appareil existant.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Ajoute ou associe un écran ou ordinateur physique à votre installation.

Paramètres

club `string` (obligatoire) ID interne du club auquel vous souhaitez ajouter l'appareil. body `string` (obligatoire) Objet JSON du nouvel écran à associer.

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"

{}

Demande à l'appareil de se connecter à un nouveau SSID selon les paramètres.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Met à jour la configuration d'un écran ou appareil existant.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Charge une URL ou page web sur l'écran d'un appareil donné.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Met à jour la configuration d'un écran ou appareil existant.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

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"

{}

Renomme un écran ou appareil. Enregistrement uniquement : contrairement au point de terminaison de mise à jour, rien n'est transmis à l'appareil ; il est donc aussi disponible pour les écrans exécutant une version logicielle en fin de vie.

Paramètres

club `string` (obligatoire) ID interne de l'installation à laquelle appartient l'appareil. body `string` (obligatoire) Objet JSON des paramètres de renommage.

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"

{}

Obtient les widgets et les liens vers les médias hors ligne d'une installation, selon la date fournie.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez changer le programme d'entraînement. date `string` (obligatoire) Date pour laquelle renvoyer les URL des widgets. Utilisez le format `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"

{}

Obtient les widgets et les liens vers les médias hors ligne d'une installation, selon la date fournie.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez changer le programme d'entraînement.

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"

{}

Change le programme d'entraînement d'une installation donnée.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez changer le programme d'entraînement. body `string` (obligatoire) Objet JSON du nouvel entraînement à appliquer.

POST /api/ics/loadprogram/{club}

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

{}

Récupère la configuration du programme d'un écran ou appareil existant.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez récupérer les données de programme.

GET /api/ics/programs/{club}

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

{}

Met à jour la configuration du programme d'un écran ou appareil existant.

Paramètres

club `string` (obligatoire) ID interne de l'installation dont vous souhaitez mettre à jour l'appareil. body `string` (obligatoire) Objet JSON des paramètres de mise à jour.

PUT /api/ics/programs/{club}

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

{}

Récupère les options de configuration du programme.

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 avec contexte RAG. N'a pas accès aux outils : uniquement un outil simple de requête/réponse API qui permet d'extraire directement des connaissances de la base de connaissances.

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation (détecté automatiquement s'il n'est pas fourni)

Corps de la requête

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 '{}'

{}

Supprimer les embeddings d'un article du magasin vectoriel et mettre à jour l'état de suivi des embeddings

Corps de la requête

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 '{}'

{}

Lister les enregistrements du suivi des embeddings par organisation et par statut

Paramètres

organisationId `string` (facultatif) ID de l'organisation (résolu automatiquement s'il est omis) status `string` (obligatoire) Statut à filtrer (l'une des valeurs in_queue, done, anomaly, fail, deleted) Limit `string` (facultatif) Nombre maximal d'éléments par page LastEvaluatedKey `string` (facultatif) JSON du LastEvaluatedKey DynamoDB pour la pagination

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"

{}

Lister les enregistrements du suivi des embeddings par organisation (filtre facultatif par type de ressource)

Paramètres

organisationId `string` (facultatif) ID de l'organisation (résolu automatiquement s'il est omis) resourceType `string` (facultatif) Type de ressource facultatif (par exemple "article"). S'il est fourni, filtre les enregistrements dont resourceTypeId commence par "{type}#". Limit `string` (facultatif) Nombre maximal d'éléments par page LastEvaluatedKey `string` (facultatif) JSON du LastEvaluatedKey DynamoDB pour la pagination

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"

{}

Initialiser la collection de base de données vectorielle de l'organisation

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation (détecté automatiquement s'il n'est pas fourni)

POST /api/llm/init-org

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

{}

Recherche sémantique dans la base de connaissances

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation (détecté automatiquement s'il n'est pas fourni)

Corps de la requête

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 '{}'

{}

Lancer le traitement en flux des articles en file d'attente pour l'embedding, avec suivi de la progression en temps réel

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation (détecté automatiquement s'il n'est pas fourni)

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"

{}

Insérer ou mettre à jour les embeddings d'un article dans la base de données vectorielle

Gère l'embedding d'un article selon son état actuel : - Si l'article n'est pas publié OU est privé : supprime les embeddings - Si l'article est publié ET public : recalcule les embeddings avec le contenu complet Exige toujours le corps complet de l'article.

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation (détecté automatiquement s'il n'est pas fourni)

Corps de la requête

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 '{}'

{}

Point de terminaison de test pour supprimer par lot les embeddings d'articles par organisation et statut facultatif

Paramètres

organisationId `string` (facultatif) ID de l'organisation (résolu automatiquement à partir du contexte utilisateur s'il est omis) status `string` (facultatif) Statut à filtrer (facultatif ; s'il est omis, supprime TOUS les articles de l'organisation quel que soit leur statut) hardDelete `string` (facultatif) Indique s'il faut supprimer définitivement les enregistrements de suivi des embeddings (true) ou les supprimer de manière logique en mettant à jour le statut (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"

{}

Transformer et découper du texte avec des statistiques détaillées

Point de terminaison de test qui transforme du texte et le découpe en segments, puis fournit des statistiques détaillées sur la répartition des segments (nombre de caractères, pourcentages et indicateurs de qualité) pour aider à évaluer l'efficacité du découpage.

Corps de la requête

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 '{}'

{}