Introduction

Il s'agit de l'API principale utilisée par les sites et systèmes publics. **Si vous êtes un développeur tiers et souhaitez utiliser cette API, contactez l'assistance Performance Hub pour faire ajouter vos adresses IP à la liste d'autorisation ; sinon, vos requêtes seront limitées et/ou bloquées si un même référent ou une même adresse IP envoie trop de requêtes.**

URL de base

https://uapi.gymsystems.co/

Authentification

L'API Universal utilise une authentification par clé API via les en-têtes HTTP.

Incluez votre clé API dans l'en-tête X-API-Key de chaque requête.

Manipulez vos clés API avec précaution : elles donnent un accès complet à votre compte ! N'exposez jamais ces clés dans des dépôts publics, des applications côté client ou tout autre endroit où elles pourraient être compromises.

L'API n'accepte que les connexions HTTPS sécurisées. Les requêtes HTTP non chiffrées sont rejetées, de même que toute requête sans identifiants d'authentification valides.

Exemple de requête

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

Formulaire de contact général

L'API utilisée pour les messages de « contact général » des sites web Example Club et d'autres services externes (comme le training camp, etc.).

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation dont vous souhaitez obtenir les données d'installation. Permet de ne renvoyer que les installations appartenant à la même organisation. leadForwarding `string` (facultatif) Faut-il transférer les e-mails vers un système de gestion des prospects (gymsales, gymleads, etc.) ? Remarque : la valeur `onlyForwardIfConfigured` transfère les prospects vers tout CRM, mais pas vers l'adresse e-mail principale de l'installation.

Corps de la requête

Corps du contact général

Point de terminaison

POST /api/v1/support/contact-submission

Exemple de requête

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

Réponse

{}

Essai gratuit

Génère une demande de page d'arrivée « essai gratuit » pour l'installation indiquée

Corps de la requête

Corps de l'essai gratuit

Point de terminaison

POST /api/v1/leads/free-trial

Exemple de requête

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

Réponse

{}

Réserver un entraînement

L'API utilisée pour le formulaire « réserver un entraînement » des sites web Example Club.

Corps de la requête

Corps de la réservation d'entraînement

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Inscriptions de prospects au Training Camp

Suit les inscriptions des utilisateurs qui manifestent leur intérêt pour le Training Camp depuis nos sites web principaux. Ces informations servent ensuite à orienter l'utilisateur vers l'application ou le site trainingcamp.com et à permettre aux installations d'inscrire le membre au training camp.

Corps de la requête

Corps de la page

Point de terminaison

POST /api/v1/leads/training-camp

Exemple de requête

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

Réponse

{}

Obtient les métadonnées d'une installation, ou de toutes les installations

Cette API renvoie soit les métadonnées utilisées pour afficher la page d'une installation donnée, soit celles de toutes les installations de la base de données.

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation dont vous souhaitez obtenir les données d'installation. Permet de ne renvoyer que les installations appartenant à la même organisation. club `string` (facultatif) L'ID de l'installation à obtenir. *NB* Vous pouvez l'omettre pour renvoyer TOUTES les installations dans un seul objet JSON.

Point de terminaison

GET /api/v1/club/data

Exemple de requête

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

Réponse

{}

Obtient les métadonnées d'une installation, ou de toutes les installations

Cette API renvoie soit les métadonnées utilisées pour afficher la page d'une installation donnée, soit celles de toutes les installations de la base de données.

Paramètres

organisationId `string` (facultatif) L'ID de l'organisation dont vous souhaitez obtenir les données d'installation. Permet de ne renvoyer que les installations appartenant à la même organisation. club `string` (facultatif) L'ID de l'installation à obtenir. *NB* Vous pouvez l'omettre pour renvoyer TOUTES les installations dans un seul objet JSON.

Point de terminaison

GET /api/v2/club/data

Exemple de requête

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

Réponse

{}

Rechercher des installations par ville et lat/lng

Effectuer une recherche des installations à proximité, d'après votre latitude, votre longitude et des termes de recherche (comme un quartier, une localité ou une ville)

Paramètres

geogroup `string` (facultatif) Renvoie une liste « regroupée » des villes, États et pays où se trouvent les installations search `string` (facultatif) Le terme à rechercher, généralement une localité, une ville, un quartier ou un code postal limit `string` (facultatif) Nombre maximal de résultats origin `string` (facultatif) La latitude et la longitude à partir desquelles effectuer la recherche. Essentiel pour rechercher des localités ou quartiers portant le même nom dans différents pays ou villes où nous avons plusieurs installations, par exemple `Southbank Example City` ou `Southbank Example City 2` organisationId `string` (facultatif) L'ID de l'organisation selon lequel filtrer les installations. Permet de ne renvoyer que les installations appartenant à la même organisation.

Point de terminaison

GET /api/v1/club/geosearch

Exemple de requête

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

Réponse

{}

Liste les avis épinglés d'une installation

Cette API renvoie les avis épinglés de l'installation.

Paramètres

club `string` (facultatif) L'ID de l'installation à obtenir

Point de terminaison

GET /api/v2/club/reviews

Exemple de requête

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

Réponse

{}

Récupérer la configuration d'une application définie dans l'installation donnée

Récupérer la configuration d'une application définie dans l'installation donnée

Paramètres

clubID `string` (facultatif) L'ID de l'installation à obtenir appID `string` (facultatif) L'ID de l'application à obtenir

Point de terminaison

GET /api/v1/club/apps/config

Exemple de requête

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

Réponse

{}

Latitude et longitude d'après l'adresse IP de l'utilisateur

Renvoie la latitude et la longitude estimées de l'adresse IP d'un utilisateur d'après la base de données GeoIP de Maxmind.

Point de terminaison

GET /api/v1/geo/ip

Exemple de requête

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

Réponse

{}

Analyse une chaîne d'adresse et la renvoie sous forme d'objet.

Convertit la chaîne d'adresse en objet composé de la rue, de la ville, de l'État et du code postal.

Corps de la requête

Corps de la page

Point de terminaison

POST /api/v1/user/address-parser

Exemple de requête

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

Réponse

{}

Suit les e-mails soumis dans notre base de données centrale.

Suit les e-mails soumis aux différentes parties de notre site web _(par exemple les API internes, Mailchimp, Hubspot, etc.)_ et/ou à des API tierces dans notre table DynamoDB centrale, ce qui permet une analyse et un ciblage plus détaillés des membres de l'écosystème Example Club.

Corps de la requête

Corps de la page

Point de terminaison

POST /api/v1/analytics/track-email

Exemple de requête

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

Réponse

{}

Envoi de données vers Graylog

Envoie les données de divers services front-end vers notre système interne de gestion des journaux (Graylog).

Corps de la requête

Corps de la page

Point de terminaison

POST /api/v1/analytics/beacon

Exemple de requête

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

Réponse

{}

Vérifie si un ID de ceinture Myzone est enregistré auprès d'une installation

Renvoie true ou false selon qu'un ID de ceinture Myzone est associé ou non à l'ID d'installation donné.

Paramètres

club `string` (facultatif) L'ID de l'installation à interroger beltid `string` (facultatif) L'ID de la ceinture Myzone à rechercher

Point de terminaison

GET /api/v1/myzone/belt-registered

Exemple de requête

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

Réponse

{}

Récupérer la fréquence des passages de badge

Récupérer la liste des passages de badge des membres pendant une période donnée

Paramètres

start_date `string` (facultatif) La date de début de la période utilisée pour filtrer les visites des membres end_date `string` (facultatif) La date de fin de la période utilisée pour filtrer les visites des membres club `string` (facultatif) L'installation à laquelle le membre est abonné, pour filtrer l'installation où il a badgé email `string` (facultatif) L'e-mail utilisé pour le passage de badge

Point de terminaison

GET /api/v1/members/swipes/frequency

Exemple de requête

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

Réponse

{}

Webhook pour les événements d'arrivée GymMaster

Webhook pour les événements d'arrivée GymMaster

Point de terminaison

POST /api/v1/webhooks/gymmaster/checkin

Exemple de requête

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

Réponse

{}

Enregistrer / signaler l'ID d'un appareil

Enregistre dans la base de données l'UUID, l'adresse IP et l'ID d'écran (ID d'appareil) de l'ordinateur d'un écran Display Screens, ce qui permet d'associer l'appareil via Performance Hub.

Corps de la requête

Un objet JSON contenant des informations sur l'appareil, comme son adresse IP et son UUID, doit être envoyé à ce point de terminaison

Point de terminaison

POST /api/v1/devices/dashkiosk/register

Exemple de requête

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

Réponse

{}

Définit l'état d'un bouton d'alarme Duress

Définit à `true|false` l'état d'un bouton d'alarme Duress associé à une installation. Remarque : vous ne pouvez changer que l'état d'un bouton enregistré auprès d'une installation. Cela ne fonctionne pas pour les appareils pas encore configurés.

Corps de la requête

Objet JSON de l'état d'alarme du bouton Duress

Point de terminaison

POST /api/v1/devices/duress/setAlarmState

Exemple de requête

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

Réponse

{}

Renvoie les boutons d'alarme Duress associés à l'installation

Renvoie un tableau des boutons d'alarme Duress associés à une installation, dont surveiller les mises à jour.

Paramètres

clubID `string` (obligatoire) ID de l'installation à interroger

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Met à jour les métadonnées de l'appareil

Met à jour les métadonnées d'appareil associées à un UUID. Remarque : aucune authentification n'est requise pour envoyer des données à cette fonction ; les données ne doivent donc contenir aucune information sensible.

Corps de la requête

Un objet JSON contenant des informations sur l'appareil, comme les informations du système d'exploitation, les indicateurs Wi-Fi, etc., doit être envoyé à ce point de terminaison

Point de terminaison

POST /api/v1/devices/metadata/beacon

Exemple de requête

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

Réponse

{}

Renvoie des informations sur un écran d'après l'UUID de l'appareil.

Obtient la configuration d'un appareil d'après son UUID et renvoie des informations comme la séance associée à l'appareil et le contenu à afficher.

Paramètres

uuid `string` (obligatoire) UUID de l'appareil dont récupérer la configuration

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Renvoie les informations de configuration d'un appareil d'après son UUID.

Récupère la configuration d'un appareil dans plusieurs tables (Display Screens, appareils IoT, appareils de vidéosurveillance) à l'aide de l'UUID de l'appareil, et renvoie les détails de configuration pertinents au format JSON.

Paramètres

uuid `string` (obligatoire) UUID de l'appareil dont récupérer la configuration

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Enregistrer une balise BLE

Enregistre les informations d'une balise BLE dans notre base de données

Corps de la requête

Données de la balise BLE

Point de terminaison

POST /api/v1/devices/blebeacon/register

Exemple de requête

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

Réponse

{}

Liste les appareils de vidéosurveillance associés au ClubID

Liste les détails généraux des appareils de vidéosurveillance associés à un ClubID. Remarque : cette API ne renvoie que des informations génériques ou générales, comme les adresses IP locales des appareils et leur état en ligne ou hors ligne. L'API Performance Hub doit être utilisée pour les détails avancés des appareils.

Paramètres

clubID `string` (obligatoire) ID de l'installation à interroger

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Enregistrer un appareil de vidéosurveillance

Enregistre les informations d'un appareil de vidéosurveillance dans notre base de données

Corps de la requête

Données de l'appareil de vidéosurveillance

Point de terminaison

POST /api/v1/devices/cctv/register

Exemple de requête

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

Réponse

{}

Enregistrer un appareil AI Edge Processor

Enregistre les informations d'un appareil AI Edge Processor dans notre base de données

Corps de la requête

Données de l'appareil AI Edge Processor

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Génère une URL signée pour accepter les téléversements d'enregistrements de vidéosurveillance

Génère une URL S3 signée qui permet au client de téléverser directement un enregistrement de vidéosurveillance vers S3 pour post-traitement.

Corps de la requête

Métadonnées de l'appareil

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Indique à S3 que le téléversement en plusieurs parties est terminé

Indique à S3 que le téléversement en plusieurs parties a été terminé par le client

Corps de la requête

Métadonnées de l'appareil

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Envoyer une commande Sonos aux appareils Sonos de l'installation

Envoyer une commande Sonos aux appareils Sonos de l'installation

Paramètres

clubID `string` (obligatoire) ID de l'installation à interroger

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Récupérer les paramètres Contrôle audio de l'installation

Récupérer les paramètres Contrôle audio de l'installation

Paramètres

clubID `string` (obligatoire) ID de l'installation à interroger

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Créer un jeton d'accès temporaire

Créer un jeton d'accès temporaire

Point de terminaison

POST /api/v1/temporary-access/token

Exemple de requête

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

Réponse

{}

Récupérer les éléments de diffusion musicale en direct

Récupérer les éléments de diffusion musicale en direct

Point de terminaison

GET /api/v1/streams

Exemple de requête

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

Réponse

{}

Récupérer les données d'un élément de diffusion musicale en direct

Récupérer les données d'un élément de diffusion musicale en direct

Paramètres

id `string` (obligatoire) ID unique qui identifie un élément de flux

Point de terminaison

GET /api/v1/streams/{id}

Exemple de requête

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

Réponse

{}

Récupérer les éléments de FAQ

Récupérer les éléments de FAQ

Paramètres

location `string` (facultatif) L'emplacement où l'élément de FAQ doit apparaître, par exemple le site web principal (website_main). categories `string` (facultatif) Catégories de l'élément de FAQ. status `string` (facultatif) Le statut de l'élément

Point de terminaison

GET /api/v1/faqs

Exemple de requête

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

Réponse

{}

Récupérer les éléments de FAQ

Récupérer les éléments de FAQ

Paramètres

category `string` (obligatoire) Filtre de catégories

Point de terminaison

GET /api/v1/faqs/{category}

Exemple de requête

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

Réponse

{}

Récupérer les éléments de presse

Récupérer les éléments de presse

Paramètres

location `string` (facultatif) L'emplacement où l'élément de presse doit apparaître, par exemple le site web principal (website_main). status `string` (facultatif) Le statut de l'élément

Point de terminaison

GET /api/v1/press

Exemple de requête

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

Réponse

{}

Récupérer la correspondance des e-mails

Récupérer la correspondance des e-mails

Point de terminaison

GET /api/v1/email-mapping

Exemple de requête

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

Réponse

{}

Récupérer les codes de suivi personnalisés

Récupérer les codes de suivi personnalisés

Paramètres

clubID `string` (obligatoire) L'ID ou l'emplacement de l'installation, par exemple Milton

Point de terminaison

GET /api/v1/customtracking/{clubID}

Exemple de requête

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

Réponse

{}

Récupérer les éléments des pages d'arrivée

Récupérer les éléments des pages d'arrivée

Paramètres

region `string` (facultatif) La région à laquelle appartient une installation, par exemple AU, NZ, US club `string` (facultatif) ID de l'installation, identifiant unique de l'installation slug `string` (facultatif) La dernière partie de l'adresse URL, qui sert d'identifiant unique de la page

Point de terminaison

GET /api/v1/landing-pages

Exemple de requête

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

Réponse

{}

Formulaire de contact du site web Performance Hub

Reçoit les formulaires soumis depuis le site web Performance Hub (demandes de démonstration, demandes commerciales, commandes en accès anticipé) et envoie des e-mails de notification via SES.

Point de terminaison

POST /api/v1/performancehub/website-contact

Exemple de requête

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

Réponse

{}

Demander un code à usage unique Door/Gate Access

Envoie un code de vérification à usage unique au téléphone ou à l'e-mail fourni. Répond toujours 200 pour empêcher l'énumération des identifiants. Débit limité par identifiant et par adresse IP (fenêtre glissante Redis).

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Vérifier un code à usage unique Door/Gate Access et émettre des jetons

Vérifie le code à usage unique, résout les profils de personne associés dans toutes les installations, et renvoie un JWT de courte durée ainsi qu'un jeton d'actualisation opaque à rotation.

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Renouveler un jeton d'actualisation Door/Gate Access

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Révoquer un jeton d'actualisation Door/Gate Access

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Session Door/Gate Access actuelle

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Mettre à jour les champs de profil modifiables

Met à jour firstName / lastName sur chaque ligne ph-door-access-users correspondant à l'identifiant du JWT. L'e-mail et le téléphone ne peuvent pas être modifiés ici.

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Lister les installations de l'utilisateur Door/Gate Access

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Définir l'installation actuellement sélectionnée par l'utilisateur

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Lister les portes que l'utilisateur peut ouvrir dans une installation

Paramètres

facilityId `string` (facultatif) Identifiant de l'installation (clubID).

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Tentatives de déverrouillage récentes de l'utilisateur actuel

Point de terminaison

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

Exemple de requête

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

Réponse

{}

Déverrouiller une porte depuis l'application mobile Door/Gate Access

Contrôles stricts côté serveur avant la publication sur MQTT. Le serveur fait foi pour les règles permanentes, les Access Time Windows additives, les blocages explicites de porte, le mode maintenance et le géorepérage. L'état côté client ne sert qu'à l'expérience utilisateur.

Paramètres

doorId `string` (obligatoire) balenaUUID du contrôleur de porte.

Point de terminaison

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

Exemple de requête

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

Réponse

{}