Einführung

Dies ist die zentrale API für öffentlich zugängliche Websites und Systeme. **Wenn Sie als Drittentwickler diese API nutzen möchten, wenden Sie sich bitte an den Performance Hub-Support, damit Ihre IP-Adressen auf die Positivliste gesetzt werden. Andernfalls werden Sie bei zu vielen Anfragen vom selben Referrer / derselben IP-Adresse gedrosselt und/oder blockiert.**

Basis-URL

https://uapi.gymsystems.co/

Authentifizierung

Die Universal API verwendet die Authentifizierung per API-Schlüssel über HTTP-Header.

Geben Sie Ihren API-Schlüssel bei jeder Anfrage im Header X-API-Key mit.

Gehen Sie sorgfältig mit Ihren API-Schlüsseln um – sie gewähren vollen Zugriff auf Ihr Konto! Legen Sie diese Schlüssel niemals in öffentlichen Repositorys, clientseitigen Anwendungen oder an anderen Stellen offen, an denen sie kompromittiert werden könnten.

Die API akzeptiert ausschließlich sichere HTTPS-Verbindungen. Einfache HTTP-Anfragen werden abgelehnt, ebenso alle Anfragen ohne gültige Anmeldedaten.

Beispielanfrage

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

Allgemeines Kontaktformular

Die API für 'allgemeine Kontaktnachrichten' von den Example Club-Websites und anderen nach außen gerichteten Diensten (etwa dem Training Camp usw.).

Parameter

organisationId `string` (optional) Die ID der Organisation, für die Sie Einrichtungsdaten abrufen möchten. Damit wird sichergestellt, dass nur Einrichtungen derselben Organisation zurückgegeben werden. leadForwarding `string` (optional) Sollen E-Mails an ein Lead-Management-System (gymsales, gymleads usw.) weitergeleitet werden? Hinweis: Mit `onlyForwardIfConfigured` werden Leads an jedes CRM weitergeleitet, aber nicht an die primäre E-Mail-Adresse der Einrichtung...

Anfragetext

Text des allgemeinen Kontaktformulars

Endpunkt

POST /api/v1/support/contact-submission

Beispielanfrage

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

Antwort

{}

Kostenloses Probetraining

Erzeugt eine Anfrage über die Landingpage für ein 'kostenloses Probetraining' für die angegebene Einrichtung

Anfragetext

Text der Anfrage für ein kostenloses Probetraining

Endpunkt

POST /api/v1/leads/free-trial

Beispielanfrage

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

Antwort

{}

Training buchen

Die API für das Formular 'Training buchen' auf den Example Club-Websites.

Anfragetext

Text der Trainingsbuchung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Lead-Übermittlungen für das Training Camp

Erfasst Übermittlungen, mit denen Benutzer auf unseren Hauptwebsites ihr Interesse am Training Camp anmelden. Diese Informationen werden anschließend verwendet, um den Benutzer an die App bzw. Website trainingcamp.com zu verweisen und damit Einrichtungen das Mitglied für das Training Camp anmelden können.

Anfragetext

Seitentext

Endpunkt

POST /api/v1/leads/training-camp

Beispielanfrage

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

Antwort

{}

Ruft die Metadaten einer einzelnen Einrichtung oder aller Einrichtungen ab

Diese API gibt entweder die Metadaten zurück, mit denen die Seite einer einzelnen Einrichtung dargestellt wird, oder alle Einrichtungen in der Datenbank.

Parameter

organisationId `string` (optional) Die ID der Organisation, für die Sie Einrichtungsdaten abrufen möchten. Damit wird sichergestellt, dass nur Einrichtungen derselben Organisation zurückgegeben werden. club `string` (optional) Die ID der gewünschten Einrichtung... *Hinweis* Sie können dies weglassen, wenn ALLE Einrichtungen als einzelnes JSON-Objekt zurückgegeben werden sollen.

Endpunkt

GET /api/v1/club/data

Beispielanfrage

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

Antwort

{}

Ruft die Metadaten einer einzelnen Einrichtung oder aller Einrichtungen ab

Diese API gibt entweder die Metadaten zurück, mit denen die Seite einer einzelnen Einrichtung dargestellt wird, oder alle Einrichtungen in der Datenbank.

Parameter

organisationId `string` (optional) Die ID der Organisation, für die Sie Einrichtungsdaten abrufen möchten. Damit wird sichergestellt, dass nur Einrichtungen derselben Organisation zurückgegeben werden. club `string` (optional) Die ID der gewünschten Einrichtung... *Hinweis* Sie können dies weglassen, wenn ALLE Einrichtungen als einzelnes JSON-Objekt zurückgegeben werden sollen.

Endpunkt

GET /api/v2/club/data

Beispielanfrage

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

Antwort

{}

Einrichtungen nach Stadt und Breiten-/Längengrad suchen

Sucht Einrichtungen in der Nähe anhand Ihres Breitengrads, Längengrads und Ihrer Suchbegriffe (z. B. Stadtteil, Ort oder Stadt)

Parameter

geogroup `string` (optional) Gibt eine Liste 'gruppierter' Städte/Bundesstaaten/Länder zurück, in denen sich Einrichtungen befinden search `string` (optional) Der Suchbegriff: In der Regel ein Ort, eine Stadt, ein Stadtteil oder eine Postleitzahl limit `string` (optional) Maximale Anzahl der Ergebnisse origin `string` (optional) Der Breiten- und Längengrad, von dem aus gesucht wird. Dies ist entscheidend bei der Suche nach Orten/Stadtteilen mit demselben Namen in verschiedenen Ländern/Städten, in denen es mehrere Einrichtungen gibt, z. B. `Southbank Example City` oder `Southbank Example City 2` organisationId `string` (optional) Die Organisations-ID, nach der Einrichtungen gefiltert werden. Damit wird sichergestellt, dass nur Einrichtungen derselben Organisation zurückgegeben werden.

Endpunkt

GET /api/v1/club/geosearch

Beispielanfrage

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

Antwort

{}

Listet die angehefteten Bewertungen einer einzelnen Einrichtung auf

Diese API gibt die angehefteten Bewertungen der Einrichtung zurück.

Parameter

club `string` (optional) Die ID der gewünschten Einrichtung

Endpunkt

GET /api/v2/club/reviews

Beispielanfrage

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

Antwort

{}

Konfiguration einer App in der angegebenen Einrichtung abrufen

Parameter

clubID `string` (optional) Die ID der gewünschten Einrichtung appID `string` (optional) Die ID der gewünschten App

Endpunkt

GET /api/v1/club/apps/config

Beispielanfrage

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

Antwort

{}

Breiten- und Längengrad anhand der IP-Adresse des Benutzers

Gibt den geschätzten Breiten- und Längengrad der IP-Adresse eines Benutzers anhand der GeoIP-Datenbank von Maxmind zurück.

Endpunkt

GET /api/v1/geo/ip

Beispielanfrage

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

Antwort

{}

Parst eine Adresszeichenfolge und gibt sie als Objekt zurück.

Wandelt die Adresszeichenfolge in ein Objekt aus Straße, Stadt, Bundesland und Postleitzahl um.

Anfragetext

Seitentext

Endpunkt

POST /api/v1/user/address-parser

Beispielanfrage

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

Antwort

{}

Erfasst übermittelte E-Mail-Adressen in unserer zentralen Datenbank.

Erfasst E-Mail-Adressen, die an die verschiedenen Bereiche unserer Website _(z. B. interne APIs, Mailchimp, Hubspot usw.)_ und/oder an APIs von Drittanbietern übermittelt werden, in unserer zentralen DynamoDB-Tabelle. So sind detailliertere Analysen und eine gezieltere Ansprache von Mitgliedern aus dem Example Club-Ökosystem möglich.

Anfragetext

Seitentext

Endpunkt

POST /api/v1/analytics/track-email

Beispielanfrage

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

Antwort

{}

Sendet Daten an Graylog

Sendet Daten verschiedener Front-End-Dienste an unser internes Log-Management-System (Graylog).

Anfragetext

Seitentext

Endpunkt

POST /api/v1/analytics/beacon

Beispielanfrage

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

Antwort

{}

Prüft, ob eine Myzone Belt ID bei einer Einrichtung registriert ist

Gibt true oder false zurück, je nachdem, ob eine Myzone Belt ID der angegebenen club-ID zugeordnet ist.

Parameter

club `string` (optional) Die ID der abzufragenden Einrichtung beltid `string` (optional) Die ID des zu suchenden Myzone Belt

Endpunkt

GET /api/v1/myzone/belt-registered

Beispielanfrage

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

Antwort

{}

Häufigkeit der Besuchs-Check-ins abrufen

Liste der Besuchs-Check-ins von Mitgliedern in einem bestimmten Zeitraum abrufen

Parameter

start_date `string` (optional) Das Startdatum des Zeitraums, nach dem Mitgliederbesuche gefiltert werden end_date `string` (optional) Das Enddatum des Zeitraums, nach dem Mitgliederbesuche gefiltert werden club `string` (optional) Die Einrichtung, bei der das Mitglied angemeldet ist, um zu filtern, in welcher Einrichtung das Mitglied eingecheckt hat email `string` (optional) Die für den Besuchs-Check-in verwendete E-Mail-Adresse

Endpunkt

GET /api/v1/members/swipes/frequency

Beispielanfrage

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

Antwort

{}

Webhook für Check-in-Ereignisse aus GymMaster

Endpunkt

POST /api/v1/webhooks/gymmaster/checkin

Beispielanfrage

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

Antwort

{}

Geräte-ID registrieren/melden

Speichert UUID, IP-Adresse und Screen ID (Geräte-ID) eines Display Screens-Computers in der Datenbank, damit das Gerät über den Performance Hub zugeordnet werden kann.

Anfragetext

An diesen Endpunkt sollte ein JSON-Objekt mit Informationen zum Gerät gesendet werden, etwa seiner IP-Adresse und UUID

Endpunkt

POST /api/v1/devices/dashkiosk/register

Beispielanfrage

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

Antwort

{}

Legt den Zustand einer Notruftaste fest

Setzt den Zustand einer Notruftaste, die einer Einrichtung zugeordnet ist, auf `true|false`. Hinweis: Sie können nur den Zustand einer Taste ändern, die bei einer Einrichtung registriert ist. Für noch nicht eingerichtete Geräte funktioniert dies nicht.

Anfragetext

JSON-Objekt mit dem Alarmzustand der Notruftaste

Endpunkt

POST /api/v1/devices/duress/setAlarmState

Beispielanfrage

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

Antwort

{}

Gibt die der Einrichtung zugeordneten Notruftasten zurück

Gibt ein Array der einer Einrichtung zugeordneten Notruftasten zurück, die auf Aktualisierungen geprüft werden sollen.

Parameter

clubID `string` (erforderlich) ID der abzufragenden Einrichtung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Aktualisiert Gerätemetadaten

Aktualisiert die Gerätemetadaten für eine UUID. Hinweis: Für das Senden von Daten an diese Funktion ist keine Authentifizierung erforderlich, daher sollten die Daten keine sensiblen Informationen enthalten.

Anfragetext

An diesen Endpunkt sollte ein JSON-Objekt mit Informationen zum Gerät gesendet werden, etwa Betriebssysteminformationen, WLAN-Kennzahlen usw.

Endpunkt

POST /api/v1/devices/metadata/beacon

Beispielanfrage

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

Antwort

{}

Gibt Informationen zu einem Display anhand der Geräte-UUID zurück.

Ruft die Konfiguration eines Geräts anhand seiner UUID ab und gibt Informationen zurück, etwa welche Runde dem Gerät zugeordnet ist und welche Inhalte angezeigt werden sollen.

Parameter

uuid `string` (erforderlich) UUID des Geräts, für das die Konfiguration abgerufen wird

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Gibt Konfigurationsinformationen für ein Gerät anhand der UUID zurück.

Ruft die Konfiguration eines Geräts anhand seiner UUID aus mehreren Tabellen (Display Screens, IoT-Geräte, Videoüberwachungsgeräte) ab und gibt die relevanten Konfigurationsdetails als JSON zurück.

Parameter

uuid `string` (erforderlich) UUID des Geräts, für das die Konfiguration abgerufen werden soll

Endpunkt

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

Beispielanfrage

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

Antwort

{}

BLE-Beacon-Gerät registrieren

Speichert die Informationen eines BLE-Beacon-Geräts in unserer Datenbank

Anfragetext

Daten des BLE-Beacon-Geräts

Endpunkt

POST /api/v1/devices/blebeacon/register

Beispielanfrage

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

Antwort

{}

Listet die der ClubID zugeordneten Videoüberwachungsgeräte auf

Listet allgemeine Details der einer ClubID zugeordneten Videoüberwachungsgeräte auf. Hinweis: Über diese API werden nur allgemeine Informationen zurückgegeben, etwa die lokalen IP-Adressen der Geräte und ob sie online|offline sind. Für detaillierte Gerätedaten muss die Performance Hub API verwendet werden.

Parameter

clubID `string` (erforderlich) ID der abzufragenden Einrichtung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Videoüberwachungsgerät registrieren

Speichert die Informationen eines Videoüberwachungsgeräts in unserer Datenbank

Anfragetext

Daten des Videoüberwachungsgeräts

Endpunkt

POST /api/v1/devices/cctv/register

Beispielanfrage

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

Antwort

{}

AI Edge Processor-Gerät registrieren

Speichert die Informationen eines AI Edge Processor-Geräts in unserer Datenbank

Anfragetext

Daten des AI Edge Processor-Geräts

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Erzeugt eine signierte URL zum Annehmen von Uploads von Videoüberwachungsaufnahmen

Erzeugt eine signierte S3-URL, mit der der Client eine Videoüberwachungsaufnahme zur Nachbearbeitung direkt in S3 hochladen kann.

Anfragetext

Gerätemetadaten

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Teilt S3 mit, dass der mehrteilige Upload abgeschlossen ist

Teilt S3 mit, dass der Client den mehrteiligen Upload abgeschlossen hat

Anfragetext

Gerätemetadaten

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Sonos-Befehl an die Sonos-Geräte der Einrichtung senden

Parameter

clubID `string` (erforderlich) ID der abzufragenden Einrichtung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Audiosteuerung-Einstellungen der Einrichtung abrufen

Parameter

clubID `string` (erforderlich) ID der abzufragenden Einrichtung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Temporäres Zugriffstoken erstellen

Endpunkt

POST /api/v1/temporary-access/token

Beispielanfrage

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

Antwort

{}

Elemente des Musik-Livestreams abrufen

Endpunkt

GET /api/v1/streams

Beispielanfrage

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

Antwort

{}

Daten eines Musik-Livestream-Elements abrufen

Parameter

id `string` (erforderlich) Eindeutige ID, die ein Stream-Element identifiziert

Endpunkt

GET /api/v1/streams/{id}

Beispielanfrage

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

Antwort

{}

FAQ-Einträge abrufen

Parameter

location `string` (optional) Der Ort, an dem der FAQ-Eintrag erscheinen soll, z. B. die Hauptwebsite (website_main). categories `string` (optional) Kategorien des FAQ-Eintrags. status `string` (optional) Der Status des Eintrags

Endpunkt

GET /api/v1/faqs

Beispielanfrage

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

Antwort

{}

FAQ-Einträge abrufen

Parameter

category `string` (erforderlich) Kategorienfilter

Endpunkt

GET /api/v1/faqs/{category}

Beispielanfrage

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

Antwort

{}

Presseeinträge abrufen

Parameter

location `string` (optional) Der Ort, an dem der Presseeintrag erscheinen soll, z. B. die Hauptwebsite (website_main). status `string` (optional) Der Status des Eintrags

Endpunkt

GET /api/v1/press

Beispielanfrage

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

Antwort

{}

E-Mail-Zuordnung abrufen

Endpunkt

GET /api/v1/email-mapping

Beispielanfrage

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

Antwort

{}

Benutzerdefinierte Tracking-Codes abrufen

Parameter

clubID `string` (erforderlich) Die club-ID oder der Standort der Einrichtung, z. B. Milton

Endpunkt

GET /api/v1/customtracking/{clubID}

Beispielanfrage

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

Antwort

{}

Landingpage-Einträge abrufen

Parameter

region `string` (optional) Die Region, zu der eine Einrichtung gehört, z. B. AU, NZ, US club `string` (optional) club-ID, eindeutige Kennung der Einrichtung slug `string` (optional) Der letzte Teil der URL-Adresse, der als eindeutige Kennung der Seite dient

Endpunkt

GET /api/v1/landing-pages

Beispielanfrage

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

Antwort

{}

Kontaktformular der Performance Hub-Website

Empfängt Formularübermittlungen von der Performance Hub-Website (Demo-Anfragen, Vertriebsanfragen, Early-Access-Bestellungen) und sendet Benachrichtigungs-E-Mails über SES.

Endpunkt

POST /api/v1/performancehub/website-contact

Beispielanfrage

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

Antwort

{}

Door/Gate Access-OTP anfordern

Sendet einen einmaligen Bestätigungscode an die angegebene Telefonnummer oder E-Mail-Adresse. Antwortet immer mit 200, um das Ausspähen von Kennungen zu verhindern. Begrenzung der Anfragerate pro Kennung und pro IP-Adresse (gleitendes Zeitfenster in Redis).

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Door/Gate Access-OTP verifizieren und Tokens ausstellen

Verifiziert das OTP, ermittelt die verknüpften Personenprofile über alle Einrichtungen hinweg und gibt ein kurzlebiges JWT sowie ein opakes, rotierendes Refresh-Token zurück.

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Door/Gate Access-Refresh-Token rotieren

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Door/Gate Access-Refresh-Token widerrufen

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Aktuelle Door/Gate Access-Sitzung

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Bearbeitbare Profilfelder aktualisieren

Aktualisiert firstName / lastName in jeder ph-door-access-users-Zeile, die der JWT-Kennung entspricht. E-Mail-Adresse und Telefonnummer können hier nicht geändert werden.

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Einrichtungen des Door/Gate Access-Benutzers auflisten

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Aktuell ausgewählte Einrichtung des Benutzers festlegen

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Türen auflisten, die der Benutzer in einer Einrichtung öffnen kann

Parameter

facilityId `string` (optional) Kennung der Einrichtung (clubID).

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Letzte Entriegelungsversuche des aktuellen Benutzers

Endpunkt

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

Beispielanfrage

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

Antwort

{}

Tür über die mobile Door/Gate Access-App entriegeln

Strenge serverseitige Prüfungen vor der Veröffentlichung über MQTT. Der Server ist die maßgebliche Quelle für dauerhafte Regeln, zusätzliche Access Time Windows, ausdrückliche Türsperren, den Wartungsmodus und den Geofence. Der Client-Zustand dient nur der Benutzerführung.

Parameter

doorId `string` (erforderlich) balenaUUID des Türcontrollers.

Endpunkt

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

Beispielanfrage

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

Antwort

{}