Wprowadzenie

To podstawowe API używane przez publiczne witryny i systemy. **Jeśli jesteś zewnętrznym deweloperem i chcesz korzystać z tego API, skontaktuj się z pomocą techniczną Performance Hub, aby dodać Twoje adresy IP do listy dozwolonych; w przeciwnym razie przy zbyt wielu żądaniach z tego samego źródła odwołania / adresu IP zostaniesz objęty limitem lub zablokowany.**

Bazowy URL

https://uapi.gymsystems.co/

Uwierzytelnianie

Universal API używa uwierzytelniania kluczem API przekazywanym w nagłówkach HTTP.

Dołącz klucz API w nagłówku X-API-Key do każdego żądania.

Postępuj ostrożnie z kluczami API — zapewniają pełny dostęp do Twojego konta! Nigdy nie ujawniaj tych kluczy w publicznych repozytoriach, aplikacjach po stronie klienta ani w żadnym miejscu, w którym mogłyby zostać przejęte.

API akceptuje wyłącznie bezpieczne połączenia HTTPS. Żądania przesyłane zwykłym HTTP są odrzucane, podobnie jak wszystkie żądania bez prawidłowych danych uwierzytelniających.

Przykładowe żądanie

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

Ogólny formularz kontaktowy

API używane do wiadomości „kontakt ogólny” z witryn Example Club i innych usług dostępnych zewnętrznie (takich jak Training Camp itp.).

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji, dla której chcesz pobrać dane obiektów — gwarantuje, że zwracane są tylko obiekty należące do tej samej organizacji. leadForwarding `string` (opcjonalne) Czy przekazywać e-maile do systemu zarządzania potencjalnymi klientami (gymsales, gymleads itp.)? Uwaga: ustawienie `onlyForwardIfConfigured` przekazuje potencjalnych klientów do dowolnego systemu CRM, ale nie na główny adres e-mail obiektu...

Treść żądania

Treść ogólnego formularza kontaktowego

Punkt końcowy

POST /api/v1/support/contact-submission

Przykładowe żądanie

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

Odpowiedź

{}

Bezpłatny okres próbny

Generuje żądanie strony docelowej „bezpłatnego okresu próbnego” dla określonego obiektu

Treść żądania

Treść żądania bezpłatnego okresu próbnego

Punkt końcowy

POST /api/v1/leads/free-trial

Przykładowe żądanie

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

Odpowiedź

{}

Rezerwacja treningu

API używane przez formularz „rezerwacja treningu” w witrynach Example Club.

Treść żądania

Treść żądania rezerwacji treningu

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zgłoszenia potencjalnych klientów Training Camp

Śledzi zgłoszenia, w których użytkownik wyraża zainteresowanie Training Camp w naszych głównych witrynach — informacje te są następnie używane do skierowania użytkownika do aplikacji/witryny trainingcamp.com oraz przez obiekty do zapisania członka do Training Camp.

Treść żądania

Treść strony

Punkt końcowy

POST /api/v1/leads/training-camp

Przykładowe żądanie

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

Odpowiedź

{}

Pobiera metadane pojedynczego obiektu lub wszystkich obiektów

To API zwraca metadane obiektu używane do wyrenderowania strony pojedynczego obiektu albo wszystkie obiekty w bazie danych.

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji, dla której chcesz pobrać dane obiektów — gwarantuje, że zwracane są tylko obiekty należące do tej samej organizacji. club `string` (opcjonalne) Identyfikator obiektu, który chcesz pobrać... *UWAGA* Możesz go pominąć, jeśli chcesz zwrócić WSZYSTKIE obiekty jako jeden obiekt JSON.

Punkt końcowy

GET /api/v1/club/data

Przykładowe żądanie

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

Odpowiedź

{}

Pobiera metadane pojedynczego obiektu lub wszystkich obiektów

To API zwraca metadane obiektu używane do wyrenderowania strony pojedynczego obiektu albo wszystkie obiekty w bazie danych.

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji, dla której chcesz pobrać dane obiektów — gwarantuje, że zwracane są tylko obiekty należące do tej samej organizacji. club `string` (opcjonalne) Identyfikator obiektu, który chcesz pobrać... *UWAGA* Możesz go pominąć, jeśli chcesz zwrócić WSZYSTKIE obiekty jako jeden obiekt JSON.

Punkt końcowy

GET /api/v2/club/data

Przykładowe żądanie

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

Odpowiedź

{}

Wyszukaj obiekty według miasta i współrzędnych lat/lng

Wyszukaj pobliskie obiekty na podstawie szerokości i długości geograficznej oraz wyszukiwanych haseł (takich jak dzielnica, miejscowość lub miasto)

Parametry

geogroup `string` (opcjonalne) Zwraca listę „pogrupowanych” miast/stanów/krajów, w których znajdują się obiekty search `string` (opcjonalne) Wyszukiwane hasło — zwykle jest to: miejscowość, miasto, dzielnica lub kod pocztowy limit `string` (opcjonalne) Maksymalna liczba wyników origin `string` (opcjonalne) Szerokość i długość geograficzna, od których rozpoczyna się wyszukiwanie — ma to kluczowe znaczenie przy wyszukiwaniu miejscowości/dzielnic o tej samej nazwie, ale w różnych krajach/miastach, w których mamy wiele obiektów — np. `Southbank Example City` lub `Southbank Example City 2` organisationId `string` (opcjonalne) Identyfikator organizacji do filtrowania obiektów — gwarantuje, że zwracane są tylko obiekty należące do tej samej organizacji.

Punkt końcowy

GET /api/v1/club/geosearch

Przykładowe żądanie

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

Odpowiedź

{}

Wyświetla przypięte opinie pojedynczego obiektu

To API zwraca przypięte opinie obiektu.

Parametry

club `string` (opcjonalne) Identyfikator obiektu, który chcesz pobrać

Punkt końcowy

GET /api/v2/club/reviews

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz konfigurację aplikacji ustawioną w danym obiekcie

Parametry

clubID `string` (opcjonalne) Identyfikator obiektu, który chcesz pobrać appID `string` (opcjonalne) Identyfikator aplikacji, którą chcesz pobrać

Punkt końcowy

GET /api/v1/club/apps/config

Przykładowe żądanie

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

Odpowiedź

{}

Szerokość i długość geograficzna na podstawie adresu IP użytkownika

Zwraca szacowaną szerokość i długość geograficzną adresu IP użytkownika na podstawie bazy danych GeoIP firmy Maxmind.

Punkt końcowy

GET /api/v1/geo/ip

Przykładowe żądanie

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

Odpowiedź

{}

Analizuje ciąg adresu i zwraca go jako obiekt.

Przekształca ciąg adresu w obiekt złożony z ulicy, miasta, stanu i kodu pocztowego.

Treść żądania

Treść strony

Punkt końcowy

POST /api/v1/user/address-parser

Przykładowe żądanie

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

Odpowiedź

{}

Śledzi przesłane adresy e-mail w naszej centralnej bazie danych.

Śledzi w naszej centralnej tabeli DynamoDB adresy e-mail przesłane do różnych części naszej witryny _(np. wewnętrznych API, Mailchimp, Hubspot itp.)_ i/lub do API zewnętrznych firm, co umożliwia bardziej szczegółową analizę członków z ekosystemu Example Club i lepsze kierowanie do nich działań.

Treść żądania

Treść strony

Punkt końcowy

POST /api/v1/analytics/track-email

Przykładowe żądanie

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

Odpowiedź

{}

Przesyła dane do Graylog

Przesyła dane z różnych usług frontendowych do naszego wewnętrznego systemu zarządzania dziennikami (Graylog).

Treść żądania

Treść strony

Punkt końcowy

POST /api/v1/analytics/beacon

Przykładowe żądanie

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

Odpowiedź

{}

Sprawdza, czy identyfikator opaski Myzone jest zarejestrowany w obiekcie

Zwraca odpowiedź true lub false w zależności od tego, czy identyfikator opaski Myzone jest powiązany z podanym identyfikatorem obiektu.

Parametry

club `string` (opcjonalne) Identyfikator obiektu, którego dotyczy zapytanie beltid `string` (opcjonalne) Identyfikator opaski Myzone do wyszukania

Punkt końcowy

GET /api/v1/myzone/belt-registered

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz częstotliwość odbić kart przy wizytach

Pobierz listę odbić kart przez członków przy wizytach w określonym okresie

Parametry

start_date `string` (opcjonalne) Data początkowa okresu używana do filtrowania wizyt członków end_date `string` (opcjonalne) Data końcowa okresu używana do filtrowania wizyt członków club `string` (opcjonalne) Obiekt, w którym członek ma subskrypcję, służący do filtrowania, w którym obiekcie członek odbił kartę email `string` (opcjonalne) Adres e-mail użyty przy odbiciu karty

Punkt końcowy

GET /api/v1/members/swipes/frequency

Przykładowe żądanie

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

Odpowiedź

{}

Webhook zdarzeń zameldowania GymMaster

Punkt końcowy

POST /api/v1/webhooks/gymmaster/checkin

Przykładowe żądanie

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

Odpowiedź

{}

Zarejestruj/zgłoś identyfikator urządzenia

Zapisuje w bazie danych UUID, adres IP i identyfikator ekranu (Device ID) komputera Display Screens, umożliwiając powiązanie urządzenia w Performance Hub.

Treść żądania

Do tego punktu końcowego należy wysłać obiekt JSON zawierający informacje o urządzeniu, takie jak jego adres IP i UUID

Punkt końcowy

POST /api/v1/devices/dashkiosk/register

Przykładowe żądanie

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

Odpowiedź

{}

Ustawia stan przycisku alarmowego

Ustawia stan przycisku alarmowego powiązanego z obiektem na `true|false`. Uwaga: można zmienić stan tylko przycisku zarejestrowanego w obiekcie. Nie działa to w przypadku urządzeń, które nie zostały jeszcze skonfigurowane.

Treść żądania

Obiekt JSON stanu alarmu przycisku alarmowego

Punkt końcowy

POST /api/v1/devices/duress/setAlarmState

Przykładowe żądanie

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

Odpowiedź

{}

Zwraca przyciski alarmowe powiązane z obiektem

Zwraca tablicę przycisków alarmowych powiązanych z obiektem, które mają być skanowane w poszukiwaniu aktualizacji.

Parametry

clubID `string` (wymagane) Identyfikator obiektu, którego dotyczy zapytanie

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Aktualizuje metadane urządzenia

Aktualizuje metadane urządzenia dla UUID. Uwaga: przesyłanie danych do tej funkcji nie wymaga uwierzytelniania, więc dane nie powinny zawierać żadnych informacji poufnych.

Treść żądania

Do tego punktu końcowego należy wysłać obiekt JSON zawierający informacje o urządzeniu, takie jak informacje o systemie operacyjnym, parametry Wi-Fi itp.

Punkt końcowy

POST /api/v1/devices/metadata/beacon

Przykładowe żądanie

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

Odpowiedź

{}

Zwraca informacje o ekranie na podstawie UUID urządzenia.

Pobiera konfigurację urządzenia na podstawie jego UUID i zwraca informacje, takie jak runda powiązana z urządzeniem i treści, które mają być wyświetlane.

Parametry

uuid `string` (wymagane) UUID urządzenia, dla którego pobierana jest konfiguracja

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zwraca informacje o konfiguracji urządzenia na podstawie UUID.

Pobiera konfigurację urządzenia z wielu tabel (Display Screens, urządzenia IoT, urządzenia CCTV) na podstawie UUID urządzenia i zwraca odpowiednie szczegóły konfiguracji w formacie JSON.

Parametry

uuid `string` (wymagane) UUID urządzenia, dla którego ma zostać pobrana konfiguracja

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zarejestruj urządzenie BLE Beacon

Zapisuje informacje o urządzeniu BLE Beacon w naszej bazie danych

Treść żądania

Dane urządzenia BLE Beacon

Punkt końcowy

POST /api/v1/devices/blebeacon/register

Przykładowe żądanie

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

Odpowiedź

{}

Wyświetla urządzenia CCTV powiązane z ClubID

Wyświetla ogólne szczegóły urządzeń CCTV powiązanych z ClubID — uwaga: przez to API zwracane są wyłącznie ogólne informacje, takie jak lokalne adresy IP urządzeń i to, czy są online|offline. Szczegółowe informacje o urządzeniach należy pobierać przez API Performance Hub.

Parametry

clubID `string` (wymagane) Identyfikator obiektu, którego dotyczy zapytanie

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zarejestruj urządzenie CCTV

Zapisuje informacje o urządzeniu CCTV w naszej bazie danych

Treść żądania

Dane urządzenia CCTV

Punkt końcowy

POST /api/v1/devices/cctv/register

Przykładowe żądanie

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

Odpowiedź

{}

Zarejestruj urządzenie AI Edge Processor

Zapisuje informacje o urządzeniu AI Edge Processor w naszej bazie danych

Treść żądania

Dane urządzenia AI Edge Processor

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Generuje podpisany adres URL do przyjmowania przesyłanych nagrań CCTV

Generuje podpisany adres URL S3, który pozwala klientowi przesłać nagranie CCTV bezpośrednio do S3 w celu dalszego przetwarzania.

Treść żądania

Metadane urządzenia

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Informuje S3, że przesyłanie wieloczęściowe zostało zakończone

Informuje S3, że klient zakończył przesyłanie wieloczęściowe

Treść żądania

Metadane urządzenia

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Wyślij polecenie Sonos do urządzeń Sonos w obiekcie

Parametry

clubID `string` (wymagane) Identyfikator obiektu, którego dotyczy zapytanie

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz ustawienia Audio Control obiektu

Parametry

clubID `string` (wymagane) Identyfikator obiektu, którego dotyczy zapytanie

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Utwórz tymczasowy token dostępu

Punkt końcowy

POST /api/v1/temporary-access/token

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz elementy transmisji muzyki na żywo

Punkt końcowy

GET /api/v1/streams

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz dane elementu transmisji muzyki na żywo

Parametry

id `string` (wymagane) Unikalny identyfikator elementu strumienia

Punkt końcowy

GET /api/v1/streams/{id}

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz elementy FAQ

Parametry

location `string` (opcjonalne) Miejsce, w którym ma się pojawić element FAQ, np. główna witryna (website_main). categories `string` (opcjonalne) Kategorie elementu FAQ. status `string` (opcjonalne) Stan elementu

Punkt końcowy

GET /api/v1/faqs

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz elementy FAQ

Parametry

category `string` (wymagane) Filtr kategorii

Punkt końcowy

GET /api/v1/faqs/{category}

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz elementy prasowe

Parametry

location `string` (opcjonalne) Miejsce, w którym ma się pojawić element prasowy, np. główna witryna (website_main). status `string` (opcjonalne) Stan elementu

Punkt końcowy

GET /api/v1/press

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz mapowanie adresów e-mail

Punkt końcowy

GET /api/v1/email-mapping

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz niestandardowe kody śledzenia

Parametry

clubID `string` (wymagane) Identyfikator lub lokalizacja obiektu, np. Milton

Punkt końcowy

GET /api/v1/customtracking/{clubID}

Przykładowe żądanie

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

Odpowiedź

{}

Pobierz elementy stron docelowych

Parametry

region `string` (opcjonalne) Region, do którego należy obiekt, np. AU, NZ, US club `string` (opcjonalne) Identyfikator obiektu (Club ID), unikalny identyfikator obiektu slug `string` (opcjonalne) Ostatnia część adresu URL, która służy jako unikalny identyfikator strony

Punkt końcowy

GET /api/v1/landing-pages

Przykładowe żądanie

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

Odpowiedź

{}

Formularz kontaktowy witryny Performance Hub

Odbiera zgłoszenia formularzy z witryny Performance Hub (prośby o demonstrację, zapytania handlowe, zamówienia wczesnego dostępu) i wysyła e-maile z powiadomieniami przez SES.

Punkt końcowy

POST /api/v1/performancehub/website-contact

Przykładowe żądanie

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

Odpowiedź

{}

Zażądaj kodu OTP Door/Gate Access

Wysyła jednorazowy kod weryfikacyjny na podany numer telefonu lub adres e-mail. Zawsze odpowiada kodem 200, aby uniemożliwić wyliczanie identyfikatorów. Liczba żądań jest ograniczona dla każdego identyfikatora i adresu IP (okno przesuwne w Redis).

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zweryfikuj kod OTP Door/Gate Access i wydaj tokeny

Weryfikuje kod OTP, ustala powiązane profile osób we wszystkich obiektach i zwraca krótkotrwały token JWT oraz nieprzezroczysty, rotowany token odświeżania.

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Rotuj token odświeżania Door/Gate Access

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Odwołaj token odświeżania Door/Gate Access

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Bieżąca sesja Door/Gate Access

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Zaktualizuj edytowalne pola profilu

Aktualizuje firstName / lastName w każdym wierszu ph-door-access-users pasującym do identyfikatora z tokenu JWT. Adresu e-mail i telefonu nie można tu zmienić.

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Wyświetl obiekty użytkownika Door/Gate Access

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Ustaw obiekt obecnie wybrany przez użytkownika

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Wyświetl drzwi, które użytkownik może otworzyć w obiekcie

Parametry

facilityId `string` (opcjonalne) Identyfikator obiektu (clubID).

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Ostatnie próby odblokowania bieżącego użytkownika

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}

Odblokuj drzwi z aplikacji mobilnej Door/Gate Access

Ścisłe kontrole po stronie serwera przed publikacją do MQTT. Serwer jest źródłem prawdy dla reguł stałych, dodatkowych Access Time Windows, jawnych blokad drzwi, trybu konserwacji i geofencingu. Stan klienta służy wyłącznie do obsługi interfejsu.

Parametry

doorId `string` (wymagane) balenaUUID kontrolera drzwi.

Punkt końcowy

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

Przykładowe żądanie

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

Odpowiedź

{}