Wprowadzenie

Witamy w Performance Hub API. To API zarządza danymi klubu oraz kluczowymi systemami zintegrowanymi z klubem i jego systemami zewnętrznymi. Nie jest to API przeznaczone do publicznego użytku. Więcej informacji o korzystaniu z poszczególnych systemów Performance Hub obsługiwanych przez to API znajdziesz w odpowiedniej sekcji [dokumentacji Performance Hub](https://docs.performancehub.co) dotyczącej danego systemu.

https://portal.hub.gymsystems.co

Uwierzytelnianie

Dane uwierzytelniające zostaną przekazane po zatwierdzeniu integracji.

Zgłaszane przez urządzenie zdarzenie "zakończenie tury agenta" (wyzwalacz powiadomienia web push)

Wywoływane przez proces pomocniczy (sidecar) sparowanego urządzenia Agent AI (nigdy przez przeglądarki), gdy uruchomienie agenta zainicjowane w interfejsie webowym zakończy się i trwało dłużej niż próg powiadomień urządzenia. Uwierzytelniane krótkotrwałym tokenem JWT HS256 wydawanym dla każdego urządzenia (aud 'events'). Duplikaty są usuwane według kombinacji urządzenie+sesja+start, a liczba wywołań jest ograniczana dla każdego urządzenia; następnie powiadomienie trafia do subskrypcji push HTML5 użytkownika inicjującego, z bezpośrednim linkiem do rozmowy.

Treść żądania

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

{}

Powiadomienie push inicjowane przez agenta (umiejętność ph-notify)

Wywoływane przez proces pomocniczy (sidecar) sparowanego urządzenia Agent AI w imieniu agenta działającego na urządzeniu (umiejętność ph-notify) w celu wysłania dowolnego powiadomienia do przeglądarki i urządzeń mobilnych użytkownika. Uwierzytelniane krótkotrwałym tokenem JWT HS256 wydawanym dla każdego urządzenia (aud 'events'). Użytkownik docelowy musi mieć dostęp do urządzenia (zasady dostępu dla danego agenta); jeśli go nie podano, powiadomienie trafia do właściciela urządzenia. Liczba wywołań jest ograniczana dla każdego urządzenia, niezależnie od zdarzeń zakończenia tury.

Treść żądania

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

{}

Prześlij obraz powiadomienia (umiejętność ph-notify)

Przyjmuje surową treść obrazu ze sparowanego urządzenia (JWT z aud 'events') i zapisuje ją w publicznym zasobniku notify-media pod niemożliwym do odgadnięcia kluczem UUID. Obiekty są automatycznie usuwane po 7 dniach (cykl życia S3). Zwraca publiczny adres https do użycia jako `imageUrl` w /ai/events/agent-notify. Limit 5 MB; tylko png/jpeg/gif/webp.

Treść żądania

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

{}

Przekaźnik MCP urządzenia dla Connected Apps (zewnętrzne narzędzia SaaS)

Punkt końcowy MCP Streamable HTTP dla sparowanych urządzeń Agenta AI (serwer MCP "connected_apps" nasłuchujący na porcie :8790 kontenera pomocniczego urządzenia). Uwierzytelniany krótkotrwałym tokenem JWT HS256 dla każdego urządzenia (aud 'mcp' — to samo poświadczenie co /mcp) i dostępny tylko przy włączonej fladze Connected Apps AGENTA (połączenia są przypisane do urządzenia agenta, a nie do obiektu). Żądania są przekazywane strumieniowo do własnego serwera MCP sesji nadrzędnej platformy narzędzi agenta, a nagłówki sesji są wstrzykiwane po stronie serwera; poświadczenia nadrzędne nigdy nie trafiają na urządzenie. Nazwy narzędzi i oznaczenia marki dostawcy są w trakcie przesyłania zastępowane w obu kierunkach własną marką. Odpowiedź nadrzędna 401/410 (wygasła sesja) powoduje jednokrotne odtworzenie sesji i ponowienie próby.

POST /mcp/apps

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

{}

Przeszukaj dzienniki audytu API (dostęp do modułu IAM & Admin)

Przeszukuj i filtruj dzienniki dostępu do API przy użyciu zaawansowanych filtrów. Użytkownicy widzą tylko dzienniki organizacji, do których mają dostęp.

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji do weryfikacji ACL (wymagany)

Treść żądania

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

{}

Pobierz statystyki dzienników audytu z pamięci podręcznej Redis (dostęp do modułu IAM & Admin)

Pobiera zagregowane statystyki z pamięci podręcznej Redis, aby panel ładował się natychmiast

Parametry

timeWindow `string` (opcjonalne) Przedział czasu dla statystyk (domyślnie 12h)

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

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

{}

Pobierz statystyki dzienników audytu (dostęp do modułu IAM & Admin)

Pobiera zagregowane statystyki dla panelu. Zakres jest ograniczony do organizacji użytkownika.

Parametry

startTime `number` (opcjonalne) Czas rozpoczęcia (znacznik czasu Unix), domyślnie 24 godziny temu endTime `number` (opcjonalne) Czas zakończenia (znacznik czasu Unix), domyślnie teraz

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"

{}

Pobierz dane szeregów czasowych dzienników audytu (dostęp do modułu IAM & Admin)

Pobiera dane szeregów czasowych pogrupowane w przedziały do wizualizacji osi czasu żądań

Parametry

timeWindow `string` (opcjonalne) Przedział czasu dla danych szeregów czasowych: - 1h: ostatnia 1 godzina (bloki 10-minutowe) - 12h: ostatnie 12 godzin (bloki 10-minutowe) - 24h: ostatnie 24 godziny (bloki 10-minutowe) - 7d: ostatnie 7 dni (bloki 1-godzinne) - 14d: ostatnie 14 dni (bloki 1-godzinne)

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"

{}

Pobierz organizacje, do których dzienników audytu użytkownik ma dostęp (dostęp do modułu IAM & Admin)

Zwraca listę organizacji, których dzienniki audytu może przeglądać bieżący użytkownik

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"

{}

Pierwsze wywołanie tworzące nowy klub. Uwaga: tworzony jest tylko obiekt klubu typu 'template' — następnie wymagane jest drugie żądanie API, aby uzupełnić dane klubu, takie jak godziny otwarcia, lokalizacja, adresy URL w mediach społecznościowych itp.

Parametry

body `string` (wymagane) Obiekt JSON nowego klubu do dodania do systemu.

POST /api/admin/clubs/addclub

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

{}

Dodaje nowego użytkownika do systemu

Parametry

body `string` (wymagane) Obiekt JSON z danymi użytkownika do dodania lub zaktualizowania.

POST /api/users

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

{}

Wyświetla wszystkich użytkowników (konta Google Apps) z dostępem do systemu zaplecza i API

GET /api/admin/users/listusers

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

{}

Wyświetla klucze MCP użytkownika (zamaskowane). Użytkownicy mogą wyświetlać własne klucze.

Parametry

userId `string` (wymagane)

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"

{}

Tworzy nowy klucz API MCP dla użytkownika. Użytkownicy mogą tworzyć własne klucze.

Parametry

userId `string` (wymagane) body `object` (opcjonalne)

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"

Unieważnia lub usuwa klucz API MCP. Użytkownicy mogą usuwać własne klucze.

Parametry

userId `string` (wymagane) keyId `string` (wymagane)

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"

{}

Usuń rolę użytkownika

Parametry

userId `string` (opcjonalne) Adres e-mail użytkownika, któremu chcesz odebrać rolę. roleId `string` (opcjonalne) Identyfikator roli, którą chcesz odebrać użytkownikowi.

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"

{}

Aktualizuje dane profilu istniejącego użytkownika (firstName, lastName, phoneNumber)

Parametry

userId `string` (wymagane) Adres e-mail użytkownika body `object` (wymagane) Dane profilu użytkownika do zaktualizowania

PATCH /api/users/{userId}

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

{}

Utwórz lub zaktualizuj rolę użytkownika

Parametry

body `object` (opcjonalne)

PUT /api/users/{userId}/roles

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

{}

Usługi Live Services działające na urządzeniu Agent AI obiektu (selektor publikacji)

Pobiera przez tunel usługi Live Services wykryte przez mostek urządzenia na potrzeby selektora "Publish to Performance Hub" w aplecie. Wymaga modułu ph-ai-agent ORAZ dostępu 'open' do urządzenia (ten sam próg co sama publikacja). Każda usługa jest oznaczana wartością publishedAppId, jeśli dla jej portu istnieje już aplikacja Custom App.

Parametry

club `string` (wymagane) device `string` (wymagane)

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"

{}

Indeks nazw ikon MDI wbudowany w urządzenie Agent AI obiektu (selektor ikon)

Przekazuje przez tunel wbudowany indeks ikon MDI mostka urządzenia (GET /__services/icons/mdi/index.json). Selektor publikacji i edycji korzysta z katalogu dołączonego do apletu (ta sama przypięta wersja 7.4.47); pliki SVG opublikowanych aplikacji są pobierane z lokalnego pakietu @mdi/js serwera portalu. Ten sam próg dostępu co w selektorze usług (moduł ph-ai-agent + dostęp 'open' do urządzenia).

Parametry

club `string` (wymagane) device `string` (wymagane)

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"

{}

Pobierz partię plików SVG ikon MDI z urządzenia Agent AI obiektu (podglądy w selektorze)

Pobiera w jednym wywołaniu do 60 nazwanych glifów MDI z wbudowanego zestawu ikon urządzenia; są one oczyszczane po stronie serwera przy użyciu tej samej listy dozwolonych elementów, co zapisane ikony aplikacji. Używane przez selektor ikon do wyświetlania wyników wyszukiwania; dla nieznanych nazw zwracana jest wartość null.

Parametry

club `string` (wymagane) device `string` (wymagane)

Treść żądania

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

{}

Zakresy odbiorców, dla których wnioskujący może publikować z tego obiektu

Zakres odbiorców, których publikujący może wskazać w selektorze publikacji i edycji: obiekty objęte jego rolami ph-ai-agent (zakres wielu obiektów) oraz informacja, czy ma uprawnienia na poziomie organizacji wymagane dla odbiorców obejmujących całą markę lub całą organizację tego obiektu. Te same reguły są ponownie egzekwowane po stronie serwera przy publikacji i aktualizacji (validatePublishAudience) — ten punkt końcowy wpływa tylko na interfejs.

Parametry

club `string` (wymagane)

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"

{}

Autouzupełnianie użytkowników dla odbiorców aplikacji wskazanych imiennie

Przeszukuje WYŁĄCZNIE użytkowników, których wnioskujący już widzi — osoby, których role obejmują co najmniej jeden obiekt, region lub organizację objęte własnym dostępem ph-ai-agent wnioskującego. Minimalna długość zapytania (2 znaki) i limit 10 wyników sprawiają, że punkt końcowy nie nadaje się do masowego pobierania danych; ten sam zbiór osiągalnych użytkowników jest ponownie egzekwowany po stronie serwera przy zapisie odbiorców.

Parametry

club `string` (wymagane) q `string` (wymagane)

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"

{}

Opublikuj usługę Live Service urządzenia Agent AI jako aplikację Custom App w Performance Hub

Rejestruje aplikację webową hostowaną przez urządzenie Agent AI obiektu (usługę Live Service wykrytą przez mostek) jako pozycję "Custom Apps" w menu bocznym dla wybranych odbiorców. Wymaga modułu ph-ai-agent w tym obiekcie ORAZ dostępu 'open' do urządzenia; odbiorcy są ograniczeni zakresami ról publikującego (nie można publikować szerzej, niż sięga własny dostęp). Tożsamość usługi jest ustalana NA BIEŻĄCO z listy /__services urządzenia; schemat http/https nigdy nie jest zapisywany.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Opublikowane aplikacje Custom Apps widoczne w tym obiekcie

Zwraca aktywne opublikowane aplikacje, których odbiorcy obejmują ten obiekt, w formacie używanym przez menu boczne (appId, name, icon, description). Odbiorcy są ustalani na nowo przy każdym wywołaniu, więc zmiany dostępu działają natychmiast.

Parametry

club `string` (wymagane)

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"

{}

Opublikowane aplikacje zarządzane z tego obiektu (widok publikującego)

Pełne rekordy aplikacji, których obiektem MACIERZYSTYM jest ten klub, dla listy zarządzania "Published Apps" w aplecie. Każdy rekord jest oznaczony wartością canManage dla użytkownika wysyłającego żądanie (publikującego).

Parametry

club `string` (wymagane)

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"

{}

Wygeneruj token przeglądającego ograniczony do usługi dla opublikowanej aplikacji Custom App

Zwraca krótkotrwały podpisany URL i token, za pomocą których przeglądarka otwiera JEDNĄ opublikowaną aplikację bezpośrednio przez regionalną bramę przekaźnikową urządzenia. Token zawiera oświadczenie svc wskazujące port usługi, dzięki czemu brama ogranicza sesję do /__services/proxy// — czat i terminal agenta nigdy nie są za jego pomocą dostępne. Przeglądający potrzebują modułu custom-apps w obiekcie objętym odbiorcami aplikacji; NIE potrzebują modułu ph-ai-agent ani dostępu do agenta na danym urządzeniu.

Parametry

club `string` (wymagane) appId `string` (wymagane)

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"

{}

Osoba odpowiedzialna za wsparcie opublikowanej aplikacji Custom App (kontakt z właścicielem)

Kto zapewnia wsparcie dla tej aplikacji opublikowanej przez użytkownika: adres e-mail publikującego (a w razie jego braku właściciel agenta hostującego). Informacja jest wyświetlana na panelach offline i błędów u przeglądającego, aby prośby o wsparcie trafiały do właściciela aplikacji, a nie do Performance Hub — opublikowane aplikacje nie są objęte podstawowym wsparciem PH. Najpierw ponownie sprawdzani są odbiorcy aplikacji; przeglądający, którym aplikacji nigdy nie udostępniono, nie otrzymują żadnych informacji. Wstrzymane aplikacje również są obsługiwane (właściciele odpowiadają także na pytania "dlaczego jest wstrzymana?").

Parametry

club `string` (wymagane) appId `string` (wymagane)

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"

{}

Wyślij e-mailem prośbę o wsparcie do właściciela opublikowanej aplikacji Custom App

Wysyła wiadomość przeglądającego do osoby odpowiedzialnej za wsparcie aplikacji (publikującego, a w razie jego braku właściciela agenta) jako wiadomość e-mail z oznaczeniem marki — pole To zawiera właściciela, pole CC przeglądającego (jako potwierdzenie prośby), a Reply-To przeglądającego, aby właściciel odpowiadał bezpośrednio jemu. Opublikowane aplikacje są utrzymywane przez użytkowników, więc dzięki temu ich wsparcie nie trafia do kolejki Performance Hub. Odbiorcy są ponownie sprawdzani; jedna prośba na przeglądającego na aplikację co 15 minut (blokada w Redis, w razie awarii żądanie jest przepuszczane).

Parametry

club `string` (wymagane) appId `string` (wymagane)

Treść żądania

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

{}

Zaktualizuj opublikowaną aplikację Custom App (nazwa, ikona, opis, status, odbiorcy)

Tylko publikujący. Zmiany odbiorców są ponownie weryfikowane względem zakresów ról osoby EDYTUJĄCEJ, z tymi samymi ograniczeniami co przy publikacji. Status przełącza się między aktywnym a wstrzymanym (wstrzymane aplikacje znikają z menu i odmawiają generowania tokenów).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Cofnij publikację aplikacji Custom App (usunięcie nietrwałe)

Tylko publikujący. Nietrwale usuwa rekord z rejestru — aplikacja natychmiast znika z menu, a generowanie tokenów przeglądających jest odrzucane; już wydane sesje bramy wygasają wraz z tokenem.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przekaż własność opublikowanej aplikacji Custom App

Działa tak samo jak proces zmiany właściciela urządzenia Agent AI: bieżący publikujący lub właściciel konta (moduł rozliczeń) może przekazać aplikację innemu użytkownikowi, który odtąd nią zarządza. Nowy właściciel musi mieć dostęp do obiektu w klubie macierzystym aplikacji.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przygotowane eksporty umiejętności na urządzeniu Agent AI obiektu (selektor udostępniania)

Przekazuje przez tunel listę przygotowanych eksportów mostka urządzenia (GET /__skills/exports) dla selektora "Share a skill" w aplecie. Eksporty są przygotowywane przez działający na urządzeniu proces ph-skill-sharing sprawdzający bezpieczeństwo i przenośność; każdy wpis zawiera wynik skanowania po stronie urządzenia. Wymaga modułu ph-ai-agent ORAZ dostępu 'open' do urządzenia (ten sam próg co sama publikacja).

Parametry

club `string` (wymagane) device `string` (wymagane)

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"

{}

Opublikuj przygotowany eksport umiejętności jako NOWĄ udostępnioną umiejętność (wersja robocza)

Pobiera przez tunel wskazane archiwum tar przygotowanego eksportu z mostka urządzenia, rozpakowuje je w pamięci (przechodzenie po ścieżkach, dowiązania symboliczne i zbyt duże pliki są odrzucane), uruchamia deterministyczne skanowanie bezpieczeństwa w chmurze, tworzy manifest na podstawie frontmattera SKILL.md, zapisuje archiwum w prywatnym zasobniku umiejętności z adresowaniem według zawartości oraz tworzy rekord główny umiejętności i wersję ROBOCZĄ. Zablokowanie przez skanowanie NIE zapisuje niczego i zwraca wyniki. Odbiorcy są ograniczeni zakresami ról publikującego. Aby opublikować wersję roboczą, prześlij ją (POST submit).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Opublikuj przygotowany eksport jako NOWĄ WERSJĘ istniejącej udostępnionej umiejętności

Ten sam proces co przy publikacji, ale dla istniejącej umiejętności: nazwa w SKILL.md eksportu musi być zgodna z umiejętnością, wersja musi być nowa (wersji nie można zmieniać), a lista zmian jest wymagana. Tylko publikujący może dodawać wersje. Zablokowanie przez skanowanie zapisuje rekord wersji ze statusem 'rejected' (tylko raport, bez artefaktu), aby wyniki były widoczne w historii publikującego.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Pełny raport skanowania (+ przegląd LLM) dla jednej wersji umiejętności

Pełna lista wyników dla wersji — tylko dla publikującego i administratorów organizacji (przeglądy zatwierdzeń); instalujący widzą zamiast tego podsumowane liczby w szczegółach umiejętności.

Parametry

club `string` (wymagane) skillId `string` (wymagane) version `string` (wymagane)

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"

{}

Prześlij roboczą wersję umiejętności (opublikuj lub dodaj do kolejki zatwierdzeń)

Przekazuje wersję roboczą dalej zgodnie z zasadami nadzoru organizacji. Jeśli organizacja włączyła przegląd LLM, najpierw uruchamiany jest przegląd instrukcji (w miarę możliwości; werdykt 'fail' powoduje odrzucenie, a werdykt 'flag' wymusza kolejkę zatwierdzeń). Udostępnienia na poziomie obiektu są publikowane natychmiast, chyba że zasady nadzoru wymagają zatwierdzenia; udostępnienia w bibliotece organizacji (odbiorcy na poziomie marki lub organizacji) domyślnie wymagają zatwierdzenia. Publikacja ustawia latestVersion umiejętności — instalacje z zasadą 'auto' pobierają ją przy następnym przebiegu uzgadniania.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Wycofaj udostępnioną umiejętność (usuwa ją z biblioteki)

Tylko publikujący. Umiejętność natychmiast znika z biblioteki i nie można jej już instalować; ISTNIEJĄCE instalacje nadal działają — wycofanie dotyczy tylko listy, a nie jest wyłącznikiem awaryjnym.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Edytuj wpis udostępnionej umiejętności (nazwa wyświetlana, opis, ikona)

Tylko publikujący. Pola wyłącznie prezentacyjne — kanoniczna nazwa umiejętności stanowi jej tożsamość (manifesty, katalogi instalacji, dopasowywanie wersji) i nigdy się nie zmienia. Pusty ciąg przywraca polu wartość null (używana jest wtedy nazwa kanoniczna lub brak ikony). Ikony pochodzą z katalogu MDI (mdi:icon-name), w tym samym formacie co opublikowane aplikacje agenta.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przekaż własność udostępnionej umiejętności

Działa tak samo jak przekazywanie opublikowanych aplikacji: bieżący publikujący lub właściciel konta (moduł rozliczeń) może przekazać umiejętność innemu użytkownikowi, który odtąd zarządza jej wersjami i wpisem. Nowy właściciel musi mieć dostęp do obiektu w klubie macierzystym umiejętności.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Biblioteka umiejętności widoczna w tym obiekcie (filtrowana według odbiorców)

Aktywne umiejętności z co najmniej jedną opublikowaną wersją, których odbiorcy obejmują ten obiekt (lub wskazują przeglądającego), z podsumowaniem najnowszej opublikowanej wersji i zasięgiem wdrożenia w organizacji (liczba różnych obiektów, nigdy surowa liczba instalacji). Odbiorcy są ustalani na nowo przy każdym wywołaniu.

Parametry

club `string` (wymagane)

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"

{}

Szczegóły umiejętności (wersje, wymagania, podsumowanie skanowania, wdrożenie)

Pełne szczegóły jednej umiejętności z biblioteki: historia wersji z listami zmian i podsumowaniami skanowania (listy punktów końcowych dla każdej wersji służą do porównania skanów przy aktualizacji), wymagania zadeklarowane w manifeście, pochodzenie publikującego oraz wskaźnik wdrożenia w postaci liczby obiektów. Odbiorcy są ponownie sprawdzani — przeglądający, którym umiejętności nigdy nie udostępniono, nie otrzymują żadnych informacji (publikujący i administratorzy organizacji zawsze ją widzą).

Parametry

club `string` (wymagane) skillId `string` (wymagane)

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"

{}

Umiejętności opublikowane z tego obiektu (lista zarządzania publikującego)

Pełne rekordy umiejętności, których obiektem MACIERZYSTYM jest ten klub, każdy oznaczony wartością canManage dla użytkownika wysyłającego żądanie oraz podsumowaniem najnowszej wersji (łącznie z wersjami roboczymi i oczekującymi na zatwierdzenie — to widok roboczy publikującego).

Parametry

club `string` (wymagane)

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"

{}

Zainstaluj umiejętność z biblioteki na urządzeniu Agent AI obiektu

Podlega zasadom nadzoru: installSources organizacji musi na to zezwalać, odbiorcy umiejętności muszą obejmować ten obiekt (lub wskazywać wnioskującego), wersja musi być opublikowana, a wnioskujący musi spełniać poziom whoCanInstall dla urządzenia docelowego (właściciel / dozwolony użytkownik / administrator obiektu / administrator organizacji — zobacz zasady nadzoru). Zapisuje rekord cyklu życia instalacji (źródło prawdy) i od razu podejmuje próbę wysłania; zadanie cron uzgadniania gwarantuje dostarczenie, gdy urządzenie stanie się osiągalne.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zatwierdź oczekującą aktualizację umiejętności dla jednej instalacji

Ustawia desiredVersion instalacji na najnowszą opublikowaną wersję (ręczny krok w zasadach 'notify' i 'pinned' oraz ścieżka stosowana, gdy zasady nadzoru ustawiają updatePosture na 'approvalRequired'). Zachowuje bieżącą wersję jako cel jednokrokowego wycofania i usuwa blokadę aktualizacji ustawioną po wycofaniu (skipVersion). Ten sam poziom uprawnień whoCanInstall co przy instalacji.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przywróć poprzednią wersję zainstalowanej umiejętności

Ustawia desiredVersion na previousVersion z rekordu instalacji (zapisywaną przy każdej zmianie wersji) i pozwala, by standardowa ścieżka dostarczania ponownie ją zainstalowała. Jednokrokowe: wersje zamieniają się miejscami, więc dwukrotne wycofanie przywraca stan wyjściowy. Blokuje też aktualizacje (skipVersion = wersja, z której wycofano), aby zasady auto/notify nie cofały wycofania — blokada znika po opublikowaniu wersji ściśle nowszej, po update-approve lub po set-policy.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Odinstaluj umiejętność z urządzenia Agent AI obiektu

Oznacza rekord instalacji jako pending-uninstall i wysyła oczekiwany stan; rekord jest usuwany, gdy urządzenie potwierdzi usunięcie (odczyt zwrotny podczas uzgadniania). Ten sam poziom uprawnień whoCanInstall co przy instalacji.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Ustaw zasadę aktualizacji umiejętności dla jednej instalacji na urządzeniu

auto (uzgadnianie automatycznie stosuje nowe opublikowane wersje, chyba że updatePosture organizacji wymaga zatwierdzenia), notify (właściciel otrzymuje jedno powiadomienie o każdej nowej wersji i stosuje ją ręcznie) lub pinned (wersja nigdy się nie zmienia bez jawnego update-approve). Zmiana zasady usuwa blokadę aktualizacji ustawioną po wycofaniu (skipVersion). Ten sam poziom uprawnień whoCanInstall co przy instalacji.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Instalacje umiejętności na urządzeniu Agent AI obiektu (karta Skills)

Rekordy cyklu życia instalacji dla jednego urządzenia, każdy uzupełniony o pola wpisu umiejętności i informację, czy istnieje nowsza opublikowana wersja. Wymaga dostępu 'open' do urządzenia (karta Skills znajduje się w panelu agenta).

Parametry

club `string` (wymagane) device `string` (wymagane)

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"

{}

Wersje umiejętności oczekujące na zatwierdzenie w organizacji tego obiektu

Kolejka zatwierdzeń administratora organizacji: wszystkie wersje oczekujące na zatwierdzenie we wszystkich umiejętnościach organizacji, z wpisem umiejętności i podsumowaniami skanowania oraz przeglądu LLM. Tylko administratorzy organizacji.

Parametry

club `string` (wymagane)

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"

{}

Zatwierdź oczekującą wersję umiejętności (publikuje ją)

Tylko administratorzy organizacji. Wersja zostaje opublikowana, latestVersion umiejętności jest aktualizowana, a publikujący otrzymuje powiadomienie. Instalacje z zasadą 'auto' pobierają wersję przy następnym przebiegu uzgadniania.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Odrzuć oczekującą wersję umiejętności

Tylko administratorzy organizacji. Wersja zostaje odrzucona z podaniem powodu przez recenzenta, a publikujący otrzymuje powiadomienie — może poprawić wskazane problemy i przesłać nową wersję (wersji nie można zmieniać).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Obowiązujące zasady nadzoru nad umiejętnościami agenta w organizacji tego obiektu

Zapisane zasady organizacji nałożone na ustawienia domyślne platformy (organizacja bez zapisanego rekordu widzi same ustawienia domyślne). Tylko administratorzy organizacji.

Parametry

club `string` (wymagane)

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"

{}

Zaktualizuj zasady nadzoru nad umiejętnościami agenta w organizacji tego obiektu

Aktualizacja częściowa — zmieniają się tylko przekazane pola; pozostałe zachowują wartość zapisaną lub domyślną. Tylko administratorzy organizacji. Nadpisania dla poszczególnych urządzeń są przechowywane w rekordzie rejestracji i obsługiwane przez istniejące trasy konfiguracji urządzeń.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Pobierz dane środowiskowe obiektu

Zwraca bieżące warunki pogodowe, w tym godziny wschodu i zachodu słońca (z Open-Meteo), oraz temperaturę wewnątrz obiektu (z czujników Duress) dla wskazanego klubu. Przechowywane w pamięci podręcznej Redis przez 30 minut.

Parametry

clubId `string` (wymagane) Wewnętrzny identyfikator klubu lub obiektu

GET /api/clubs/{clubId}/environment

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

{}

Dodaje ogólne urządzenie IoT do klubu lub przypisuje je do niego.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie. body `string` (wymagane) Obiekt JSON nowego ekranu do przypisania.

POST /api/devices/addGenericDevice/{club}

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

{}

Usuń ekran i przywróć jego ustawienia fabryczne

Usuwa aktywne przypisanie ekranu do obiektu i trwale zleca przywrócenie ustawień fabrycznych. Wyłączony ekran wykona reset po następnym włączeniu i ponownym połączeniu, a następnie wróci do strony parowania HDMI. Historyczne dane rozliczeniowe są zachowywane.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przypisuje kontroler drzwi do obiektu.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Aktualizuje ustawienia kontrolera drzwi w obiekcie.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Wycofuje kontroler drzwi z eksploatacji w obiekcie.

Parametry

club `string` (wymagane)

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"

{}

Zwraca konfigurację przekaźników kontrolera drzwi.

Parametry

uuid `string` (wymagane)

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"

{}

Zwraca metadane urządzenia

Parametry

uuid `string` (wymagane) Unikalny identyfikator urządzenia

GET /api/devices/metadata/{uuid}

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

{}

Zwraca metadane urządzenia. Odpowiedź zawiera rekord metadanych na najwyższym poziomie (starszy format) oraz `detectedType` (camera | ai-edge-processor | door-controller | ph-ai-agent | null) i `online` (true, gdy aktualizacja nastąpiła w ciągu ostatnich 5 minut).

Parametry

deviceSerialNumber `string` (wymagane) Numer seryjny urządzenia

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"

{}

Zwraca dane Smart Club dla klubu.

Parametry

club_id `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie.

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"

{}

Zwraca wszystkie urządzenia przypisane do danego klubu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, którego urządzenia chcesz wyświetlić.

GET /api/devices/list/{club}

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

{}

Zwraca wszystkie wydania (wersje) aplikacji dla urządzeń balena.

GET /api/devices/listReleases

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

{}

Przenosi urządzenie do nowego obiektu (klubu) i aktualizuje powiązane systemy.

Parametry

club `string` (wymagane) Identyfikator obiektu źródłowego (klubu, w którym obecnie znajduje się urządzenie) body `object` (wymagane) Parametry przeniesienia

POST /api/devices/move/{club}

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

{}

Próbuje nawiązać połączenie z routerem obiektu, wybierając najlepsze urządzenie w klubie i wysyłając polecenie MQTT utworzenia tunelu.

Parametry

facilityID `string` (wymagane) Wewnętrzny identyfikator obiektu, z którego routerem próbujesz się połączyć.

GET /api/devices/openRouterWebpage/{facilityID}

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

{}

Katalog Cloud Agent (strefy, rozmiary, bieżące ceny sprzedaży)

Parametry

club `string` (wymagane)

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"

{}

Wycena Cloud Agent (oprogramowanie + hosting)

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

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

Uruchom Cloud Agent (dodanie do kolejki udostępniania + automatyczne przypisanie)

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"

Status zadania 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"

Całkowicie usuń Cloud Agent (maszyna wirtualna + balena + rejestracja)

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"

Rozstrzygnij wstrzymane usuwanie Cloud Agent (ponów kopię zapasową, usuń bez kopii zapasowej lub anuluj)

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"

Wyświetl Connected Apps agenta (pakiety i aplikacje z połączonymi kontami)

Zwraca stan Connected Apps agenta: flagę włączenia, podsumowania dla pakietów (Google Workspace, Microsoft 365) oraz wyselekcjonowany katalog aplikacji z połączonymi kontami każdej aplikacji (wiele kont — agent może mieć kilka kont dla jednej aplikacji, każde z opcjonalnym aliasem), ustalonymi na podstawie nadrzędnej sesji agenta.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

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"

{}

Pełny katalog sklepu Connected Apps dla agenta

Zwraca wszystkie aplikacje, które można połączyć (pełny katalog zestawów narzędzi z zarządzanym uwierzytelnianiem, przechowywany w pamięci podręcznej serwera przez ok. 12h), z poziomami wyróżnionych aplikacji i pakietów oraz połączonymi kontami agenta dla każdej aplikacji, a także podsumowania pakietów i oczekujące prośby agenta o połączenie — jeden ładunek dla sklepu z aplikacjami przeszukiwanego po stronie klienta.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

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"

{}

Odrzuć oczekującą prośbę agenta o połączenie

Oznacza oczekującą prośbę agenta o połączenie zestawu narzędzi jako odrzuconą (znika ona z sekcji "Requested by your agent" w sklepie). Operacja idempotentna — odrzucenie prośby, która nie oczekuje, nie ma żadnego skutku.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Włącz lub wyłącz Connected Apps dla agenta

Zapisuje przełącznik Connected Apps agenta i wysyła zmienną urządzenia Balena PH_APPS_MCP_ENABLED do tego jednego urządzenia (w miarę możliwości — ostateczną blokadą przekaźnika MCP jest flaga po stronie PH).

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Rozpocznij łączenie pojedynczej aplikacji z agentem (proces OAuth Connect Link)

Uruchamia hostowany proces Connect Link dla jednego zestawu narzędzi i zwraca adres URL, na który należy skierować użytkownika. Opcjonalny alias oznacza nowe konto (wiele kont — połączenie już połączonej aplikacji dodaje KOLEJNE konto, maksymalnie 10 na aplikację). Korzysta z tego samego łańcuchowego wywołania zwrotnego co łączenie pakietów (pakiet z jednym zestawem narzędzi), więc po zakończeniu użytkownik wraca na stronę apletu ph-ai-agent.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Dane przygotowania połączenia dla jednej aplikacji (tryb, pola danych uwierzytelniających, przewodnik konfiguracji)

Wszystko, czego okno połączenia potrzebuje przed rozpoczęciem połączenia: sposób łączenia aplikacji (oauth = hostowany proces wyrażania zgody, credentials = formularz w produkcie), pola danych uwierzytelniających do zebrania w trybie credentials oraz przewodnik konfiguracji w produkcie (napisany dla aplikacji priorytetowych, w pozostałych przypadkach generowany z metadanych pól aplikacji — nigdy link do zewnętrznej dokumentacji). Aplikacje z własnym OAuth zawierają też informację, czy aplikacja OAuth klienta jest już zarejestrowana dla TEGO agenta (byoConfigured), oraz adres URL przekierowania do zarejestrowania u dostawcy.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta. toolkit `string` (wymagane)

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"

{}

Połącz aplikację przy użyciu danych uwierzytelniających podanych przez użytkownika (klucz API itp., bez OAuth)

Tworzy połączone konto dla aplikacji w trybie credentials bezpośrednio z formularza w produkcie — bez hostowanego procesu wyrażania zgody. Pola danych uwierzytelniających pochodzą z ładunku connect-info aplikacji; należy podać wszystkie wymagane pola. Dane uwierzytelniające są weryfikowane u dostawcy, jeśli jest to obsługiwane (w miarę możliwości — niektóre aplikacje odrzucają błędny klucz dopiero przy pierwszym wywołaniu narzędzia przez agenta). Opcjonalny alias oznacza nowe konto (wiele kont — połączenie już połączonej aplikacji dodaje KOLEJNE konto).

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Zarejestruj własną aplikację OAuth klienta dla aplikacji BYO i rozpocznij proces jej łączenia

Dla aplikacji z własnym OAuth (Xero, Shopify...): przyjmuje identyfikator klienta i klucz tajny klienta aplikacji OAuth utworzonej przez klienta u dostawcy (zgodnie z przewodnikiem konfiguracji aplikacji), rejestruje ją dla TEGO agenta (klucz tajny jest przechowywany wyłącznie na nadrzędnej platformie integracji — nigdy w Performance Hub) i od razu uruchamia dla niej hostowany proces logowania. Zwraca adres URL zgody, na który należy skierować użytkownika, zgodnie z tym samym kontraktem co punkt końcowy połączenia. Ponowne przesłanie zastępuje zarejestrowaną aplikację agenta (np. po rotacji klucza tajnego) — istniejące połączone konta nadal działają.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Rozpocznij łączenie całego pakietu jednym kliknięciem dla agenta (łańcuch procesów Connect Link)

Uruchamia łańcuchowy proces łączenia dla całego pakietu (np. google-workspace). Zwrócony adres URL otwiera ekran zgody pierwszego zestawu narzędzi; każde zakończenie przekierowuje (302) bezpośrednio do procesu następnego zestawu narzędzi, a całość kończy się na stronie apletu ph-ai-agent. Elementy, które mają już połączone konto, są POMIJANE, więc ponowienie po błędzie w środku łańcucha kontynuuje od brakujących aplikacji zamiast tworzyć zduplikowane konta. Gdy wszystkie elementy są już połączone, cały łańcuch jest uruchamiany ponownie — to jawny proces "dodaj kolejne konto".

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Odłącz jedno połączone konto od agenta

Usuwa pojedyncze połączone konto (wiele kont — pozostałe konta tej samej aplikacji pozostają połączone). Przed usunięciem sprawdzane jest, czy konto należy do tego agenta; jeśli było to OSTATNIE konto aplikacji, zestaw narzędzi jest usuwany z połączonego zestawu agenta (sesja jest odtwarzana z opóźnieniem, aby zaktualizować listę narzędzi agenta).

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Zmień nazwę (alias) jednego z połączonych kont agenta

Ustawia wyświetlany alias pojedynczego połączonego konta. Aliasy są zwykle ustawiane automatycznie po OAuth (na podstawie zalogowanej tożsamości); ten punkt końcowy obsługuje ręczną zmianę nazwy w oknie szczegółów aplikacji. Pusty alias usuwa etykietę. Przed aktualizacją nadrzędną sprawdzane jest, czy konto należy do tego agenta.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta.

Treść żądania

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

{}

Włącz lub wyłącz wbudowaną usługę Performance Hub dla agenta

Włącza lub wyłącza dla tego agenta jedną stale dostępną usługę wbudowaną (Smart Search, Weather...). Usługi wbudowane nie wymagają połączenia ani OAuth — są dołączone do każdego agenta i domyślnie włączone; ten przełącznik zapisuje ustawienie dla danego agenta i od razu odtwarza nadrzędną sesję agenta, aby zaktualizować zestaw narzędzi. Osobny przełącznik "External apps" (trasa /enable) całkowicie wyłącza cały serwer MCP aplikacji — gdy jest wyłączony, usługi wbudowane również są niedostępne, niezależnie od ich indywidualnych przełączników.

Parametry

facilityId `string` (wymagane) deviceId `string` (wymagane) UUID balena urządzenia agenta. slug `string` (wymagane) Identyfikator slug usługi wbudowanej.

Treść żądania

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

{}

Przypisz urządzenie Agent AI do obiektu

Przypisanie oparte najpierw na metadanych. Wyszukuje urządzenie według numeru seryjnego w bieżących metadanych urządzeń, wymaga, aby było w sieci, a następnie w razie potrzeby tworzy rekord rejestracji, przydziela region przekaźnika Chisel, port tunelu i klucz tajny, rejestruje to miejsce w przekaźniku oraz wysyła konfigurację obiektu i tunelu do urządzenia przez Balena. Nowe urządzenia otrzymują też domyślne konto usługi MCP (włączone, ograniczone do tego obiektu, ze wszystkimi możliwościami); ponowne parowanie zachowuje istniejące uprawnienia MCP. Opcjonalne ustawienia zaawansowane zastępują wartości domyślne nadawane przy parowaniu — konfigurację kopii zapasowych, włączenie lub wyłączenie MCP, ograniczenie dostępu — a `restoreFrom` wypełnia nowe urządzenie danymi z kopii zapasowej w chmurze innego urządzenia obiektu (źródło aktywne lub wycofane z eksploatacji; dodaje do kolejki przywracanie między repozytoriami, zwracane jako `restoreRequest` do odpytywania o postęp).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Wyświetl urządzenia Agent AI obiektu

Zwraca urządzenia Agent AI obiektu z bieżącym stanem połączenia i tunelu (używane przez przełącznik urządzeń w aplecie).

Parametry

club `string` (wymagane)

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"

{}

Aktualizacja i stan połączenia urządzenia Agent AI

Zwraca informację, czy urządzenie jest w sieci, czy aktualizacja jest dostępna lub oczekuje, oraz oferowane wydanie (wersję przypiętą dla floty, gdy flota jest przypięta; najwyższą udaną, gdy flota śledzi najnowszą wersję).

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Bieżący stan i metryki urządzenia Agent AI

Zwraca wyselekcjonowaną migawkę dla paska metryk i panelu zarządzania w aplecie: pola tożsamości i rejestracji, dostępność i połączenie, wersje oprogramowania oraz najnowsze metryki heartbeat (CPU, temperatura, pamięć, pamięć masowa dla każdego punktu montowania, czas pracy, sieć). Spłaszcza sygnał metadanych urządzenia i status aktualizacji Balena; przy chwilowej awarii jednej z tych części może brakować.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Opis AI do raportu stanu urządzenia

Zwraca krótkie wyjaśnienie bieżących wykrytych problemów ze stanem, przeznaczone dla operatora. Fakty i kroki procedury zawsze znajdują się w device-status; ten dodatkowy akapit jest generowany w miarę możliwości i może mieć wartość null.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Wygeneruj token dostępu bezpośredniego do przekaźnika dla urządzenia Agent AI

Zwraca krótkotrwały podpisany URL, za pomocą którego przeglądarka łączy się BEZPOŚREDNIO z regionalną bramą przekaźnikową urządzenia (z pominięciem globalnego przeskoku przez PH/Sydney), oraz token HS256. PH pozostaje organem decyzyjnym (Google SSO i sprawdzanie modułu oraz obiektu odbywa się tutaj); brama przekaźnikowa weryfikuje token. Serwer pośredniczący /ai-agent-ui pozostaje rozwiązaniem zastępczym.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Wyślij wiadomość czatu do sesji urządzenia Agent AI (odpowiedź bezpośrednio z powiadomienia)

Przekaźnik po stronie serwera używany przez akcję odpowiedzi bezpośrednio z powiadomienia web push — service worker wysyła tu żądanie POST (to samo źródło, pliki cookie SSO), dzięki czemu odpowiedź działa bez otwartej karty Performance Hub. PH ustala cel przekaźnika urządzenia (tak samo jak serwer pośredniczący /ai-agent-ui), dodaje x-ph-user do przypisania tury (wynikowe powiadomienie o zakończeniu trafia z powrotem do tego użytkownika) i przekazuje żądanie do /api/chat/start urządzenia z identyfikatorem sesji.

Treść żądania

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

{}

Odczytaj ustawienia kontroli dostępu urządzenia Agent AI (właściciel)

Zwraca blok dostępu urządzenia (tryb, lista dozwolonych, widoczność, przełącznik PH Support) oraz oczekujące prośby o dostęp. Może go odczytać właściciel urządzenia; inni użytkownicy otrzymują 403.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Zaktualizuj ustawienia kontroli dostępu urządzenia Agent AI (właściciel)

Zapisuje tryb (org/restricted), listę dozwolonych dla trybu ograniczonego, widoczność listy (all/admins) i przełącznik "permit access from Performance Hub Support". Dozwolone dla właściciela urządzenia. Samego właściciela można zmienić tylko przez reallocate-owner. Zatwierdzone prośby o dostęp są trwałe — nadal zatwierdzeni wnioskujący są ponownie dołączani do zapisanej listy dozwolonych; usunięcie kogoś z przesłanej listy cofa zatwierdzenie (prośba zmienia się na odrzuconą; można poprosić ponownie).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zmień właściciela urządzenia Agent AI

Przekazuje własność urządzenia innemu użytkownikowi Performance Hub. Dostępne tylko dla właścicieli kont (dostęp do modułu rozliczeń SaaS) — rozwiązanie awaryjne, gdy właściciel agenta z ograniczonym dostępem odchodzi. Powiadomienie otrzymują zarówno poprzedni, jak i nowy właściciel (w aplikacji, push i e-mail).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Lista użytkowników obiektu dla selektorów listy dozwolonych i właściciela urządzenia Agent AI

Zwraca adres e-mail i imię oraz nazwisko (+ flagi isOrgAdmin) każdego użytkownika, którego rola daje dostęp do TEGO obiektu. Dostępne tylko dla właściciela urządzenia i osób mogących zmieniać właściciela (właściciel konta), aby zwykli użytkownicy nie mogli przeglądać bazy użytkowników.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Poproś o dostęp do urządzenia Agent AI z ograniczonym dostępem

Tworzy (lub ponownie otwiera) prośbę wnioskującego o dostęp do urządzenia z ograniczonym dostępem — operacja idempotentna dla pary użytkownik+urządzenie. Właściciel otrzymuje powiadomienie w aplikacji, przez web push i e-mailem, z bezpośrednim linkiem do modułu agenta.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zatwierdź lub odrzuć prośbę o dostęp do urządzenia Agent AI (właściciel)

Rozstrzygnięcie oczekującej prośby przez właściciela urządzenia. Zatwierdzenie dodaje wnioskującego do listy dozwolonych urządzenia; w obu przypadkach wnioskujący otrzymuje powiadomienie (w aplikacji, push i e-mail).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zezwól na aktualizację urządzenia Agent AI i zastosuj ją

Przypina urządzenie do oferowanego wydania (wersji przypiętej dla floty lub najwyższej udanej, gdy flota śledzi najnowszą wersję) i zwalnia blokadę aktualizacji, aby nadzorca balena ją zastosował. Stan na woluminie danych urządzenia jest zachowywany po aktualizacji.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zaplanuj aktualizację urządzenia Agent AI na później

Zapisuje zaplanowany czas instalacji w rejestracji urządzenia. Cykliczne zadanie zaplecza (co 5 minut) stosuje aktualizację (przypięcie + odblokowanie) po upływie zaplanowanego czasu. Nowy harmonogram zastępuje istniejący harmonogram urządzenia.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Anuluj zaplanowaną aktualizację urządzenia Agent AI

Usuwa oczekującą zaplanowaną instalację na urządzeniu (bez skutku, jeśli nic nie zaplanowano).

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Uruchom zdalne polecenie na urządzeniu Agent AI

Publikuje dozwolone polecenie MQTT (ponowne uruchomienie, restart kontenera, zablokowanie lub odblokowanie aktualizacji, zarządzanie Wi-Fi) do kontrolera urządzenia działającego na urządzeniu Agent AI. Urządzenie musi być przypisane do obiektu.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zaktualizuj konfigurację urządzenia Agent AI dotyczącą obiektu

Zapisuje ustawienia powiązanego Agenta AI, które może edytować operator: nazwę urządzenia, fizyczną lokalizację urządzenia i harmonogram ponownego uruchamiania. Harmonogram ponownego uruchamiania jest też przesyłany do urządzenia jako zmienna środowiskowa Balena REBOOT_DEVICE (godz. 2:00 czasu lokalnego), tak samo jak w przypadku Display Screens.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Obiekty, do których można przenieść Agenta AI z tego obiektu

Zwraca obiekty z tej samej organizacji, do których zalogowany użytkownik ma dostęp (z wyjątkiem bieżącego obiektu), na potrzeby selektora „Przenieś do innego obiektu”. Samo przeniesienie wykonuje POST /api/devices/move/:club, który po stronie serwera egzekwuje te same reguły dotyczące tej samej organizacji i dostępu do obiektu docelowego.

Parametry

club `string` (wymagane)

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"

{}

Zakres dostępu MCP, który wnioskujący może przyznać Agentom AI obiektu

Zwraca, co zalogowany użytkownik może przyznać kontu usługi MCP Agenta AI w organizacji tego obiektu: obiekty/regiony w ramach jego własnego dostępu, informację, czy może przyznać zakres całej organizacji, moduły, które posiada, oraz pełny katalog narzędzi MCP (dla zaawansowanej maski poszczególnych narzędzi). Interfejs korzysta z tego, aby użytkownicy widzieli wyłącznie opcje mieszczące się w ich własnych uprawnieniach; punkt końcowy POST mcp-access egzekwuje to samo ograniczenie po stronie serwera.

Parametry

club `string` (wymagane)

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"

{}

Pobierz konfigurację konta usługi MCP Agenta AI

Zwraca konfigurację dostępu MCP urządzenia (zakres, moduły, maska narzędzi, pola audytu).

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Skonfiguruj konto usługi MCP Agenta AI

Zapisuje konfigurację dostępu MCP urządzenia z ograniczeniem w chwili przyznania. Wnioskujący mogą przyznać wyłącznie obiekty/regiony w ramach własnego dostępu, zakres organizacji tylko wtedy, gdy mają rolę obejmującą całą organizację, oraz moduły, które sami posiadają w organizacji obiektu. Flaga włączenia jest też przesyłana do urządzenia jako zmienna środowiskowa Balena PH_MCP_ENABLED.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Pobierz konfigurację VPN Agenta AI (z ukrytymi danymi)

Zwraca flagę obsługi VPN urządzenia i listę połączeń. Treść profili i wartości poświadczeń nigdy nie są zwracane — tylko metadane z importu (serwery zdalne, trasy, DNS) oraz flagi informujące o zapisanych poświadczeniach. Bieżący stan poszczególnych połączeń pochodzi z punktu końcowego device-status (beacon metadata.vpn).

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Włącz lub wyłącz obsługę VPN Agenta AI

Włącza lub wyłącza funkcję VPN urządzenia. Przesyła zmienną urządzenia balena PH_VPN_ENABLED i powiadamia urządzenie (MQTT vpnConfigChanged); po wyłączeniu połączenia są zachowywane (tunele są zatrzymywane, a konfiguracja pozostaje do ponownego włączenia).

Parametry

club `string` (wymagane) uuid `string` (wymagane)

Treść żądania

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

{}

Zaimportuj profile OpenVPN do Agenta AI

Akceptuje przesyłane pliki zakodowane w base64 — pojedyncze pliki .ovpn/.conf, pakiety z wieloma plikami (konfiguracja + certyfikaty/klucze) oraz archiwa (.zip, eksporty Pritunl .tar/.tgz, .tblk Tunnelblick, .visc/.visz Viscosity). Profile są normalizowane do kanonicznej postaci inline; każdy profil staje się jednym połączeniem (importowanym jako rozłączone — wprowadź poświadczenia, a następnie połącz). Dla nieprzydatnych plików zwracane są błędy 400 ze wskazówkami.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

Treść żądania

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

{}

Zaktualizuj połączenie VPN Agenta AI (nazwa / poświadczenia / split DNS)

Aktualizuje zapisane połączenie. Pola poświadczeń są tylko do zapisu (pominięte = zachowaj zapisaną wartość; pusty ciąg = wyczyść). Zmiany poświadczeń lub split DNS zwiększają numer wersji połączenia, dzięki czemu aktywny tunel uruchamia się ponownie z nowymi wartościami.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

Treść żądania

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

{}

Usuń połączenie VPN Agenta AI

Usuwa połączenie z rejestracji i powiadamia urządzenie, które zamyka tunel i usuwa z pamięci podręcznej swój profil/poświadczenia.

Parametry

club `string` (wymagane) uuid `string` (wymagane) connectionId `string` (wymagane)

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"

{}

Połącz / rozłącz połączenie VPN Agenta AI

Model stanu docelowego — ustawia flagę włączenia połączenia w rejestracji i powiadamia urządzenie (MQTT vpnConfigChanged bez danych); urządzenie pobiera wiążący stan przez wywołanie universal-api uwierzytelnione tokenem JWT i uzgadnia swoje tunele. Pominięte powiadomienie zostanie wyrównane przy okresowej synchronizacji.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

Treść żądania

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

{}

Pobierz konfigurację i stan kopii zapasowej w chmurze Agenta AI

Zwraca ustawienia kopii zapasowej urządzenia (włączenie, okres przechowywania, region przechowywania), bieżący stan kopii zapasowych (ostatnia kopia, rozmiar, błędy), ustalony region automatyczny oraz dostępne regiony przechowywania do selektora. Hasło repozytorium restic nigdy nie jest zwracane.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Zaktualizuj konfigurację kopii zapasowej w chmurze Agenta AI

Zapisuje włączenie/okres przechowywania/region. Zmiana obowiązuje od następnego cogodzinnego cyklu kopii zapasowej urządzenia (urządzenie przed każdym uruchomieniem pobiera z PH kontekst uruchomienia), więc nie jest wymagane ponowne uruchomienie urządzenia.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Wyświetl źródła przywracania z kopii zapasowej do sparowania nowego Agenta AI

Widok całego obiektu dla opcji „przywróć z kopii zapasowej” w oknie dodawania agenta: każda rejestracja w obiekcie — aktywna ORAZ wycofana/zastąpiona — która nadal ma możliwe do odszyfrowania repozytorium kopii zapasowych i co najmniej jeden użyteczny punkt przywracania, wraz z najnowszymi migawkami. Zwraca także listy opcji konfiguracji kopii zapasowej (allowedRetentionDays, availableRegions), dzięki czemu okno nie potrzebuje UUID urządzenia do wypełnienia list wyboru.

Parametry

club `string` (wymagane)

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"

{}

Wyświetl punkty przywracania kopii zapasowej Agenta AI

Zwraca indeks migawek urządzenia (od najnowszych) z DynamoDB — bez odwołań do urządzenia ani repozytorium — oraz bieżący stan żądań ręcznej kopii zapasowej / przywracania do odpytywania w panelu. Nieaktualne żądania (nigdy nie podjęte lub bez sygnału postępu) są przedstawiane jako nieudane, dzięki czemu interfejs zawsze może wysłać nowe.

Parametry

club `string` (wymagane) uuid `string` (wymagane)

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"

{}

Zażądaj teraz ręcznej kopii zapasowej Agenta AI

Zapisuje żądanie ręcznego uruchomienia (z notatką użytkownika) w wierszu rejestracji i powiadamia urządzenie przez MQTT. Urządzenie pobiera zweryfikowane żądanie przez wywołanie run-context w universal-api uwierzytelnione tokenem JWT — nawet bez MQTT zostanie ono podjęte w następnym cyklu harmonogramu. Odrzucane, gdy trwa inna kopia zapasowa lub przywracanie.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przypnij lub odepnij punkt przywracania Agenta AI

Przypięte punkty przywracania są chronione przed usuwaniem w ramach okresu przechowywania — nocna konserwacja urządzenia otrzymuje identyfikatory przypiętych migawek przez wywołanie run-context i wyklucza je z restic forget — a ich wiersze indeksu nigdy nie wygasają (TTL). Odpięcie przywraca normalne zasady przechowywania.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przywróć Agenta AI z punktu przywracania kopii zapasowej

Zapisuje żądanie przywrócenia w wierszu rejestracji i powiadamia urządzenie. Pełne przywrócenie nadpisuje /data i /home/hermeswebui (urządzenie najpierw wykonuje automatyczną migawkę zabezpieczającą i zatrzymuje agenta na czas przywracania) i wymaga wpisania nazwy urządzenia jako potwierdzenia. Przekazanie `paths` wykonuje zamiast tego niezakłócające przywrócenie na poziomie plików tylko tych ścieżek. Opcjonalnie po zakończeniu przywracania danych przypina urządzenie z powrotem do wersji oprogramowania z migawki (zob. backup-restore-release).

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zastosuj wersję oprogramowania zapisaną przy zakończonym przywróceniu

Ostatni krok przywracania, w którym zażądano wersji oprogramowania z migawki: gdy urządzenie zgłosi zakończenie przywracania danych, przypina urządzenie do zapisanej wersji i odblokowuje aktualizacje (ten sam mechanizm co punkt końcowy aktualizacji). Wywoływane przez odpytywanie w panelu; idempotentne — zapisane przypięcie jest czyszczone po zastosowaniu.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Przeglądaj pliki w punkcie przywracania kopii zapasowej

Wyświetla jeden poziom katalogu migawki restic, obsługiwany w całości po stronie serwera z repozytorium Wasabi (działa, gdy urządzenie jest offline). Odczytywane są tylko metadane drzewa — przy wyświetlaniu list nie są pobierane żadne dane plików.

Parametry

club `string` (wymagane) uuid `string` (wymagane) takenAt `number` (wymagane) path `string` (opcjonalne)

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"

{}

Wyszukaj nazwy plików w punkcie przywracania kopii zapasowej

Wyszukiwanie nazw plików bez rozróżniania wielkości liter, od wskazanego katalogu w dół, obsługiwane po stronie serwera na podstawie metadanych drzewa restic (dane plików nie są odczytywane; działa, gdy urządzenie jest offline). Przesyła listę strumieniowo i zatrzymuje się po pierwszych 200 dopasowaniach.

Parametry

club `string` (wymagane) uuid `string` (wymagane) takenAt `number` (wymagane) q `string` (wymagane) path `string` (opcjonalne)

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"

{}

Co zmieniło się między dwoma punktami przywracania kopii zapasowej

Uruchamia po stronie serwera restic diff między dwiema migawkami urządzenia (tylko metadane drzewa) i zwraca listę dodanych/usuniętych/zmodyfikowanych plików (maksymalnie 500 zmian) oraz statystyki podsumowujące. Wyniki są buforowane — migawki są niezmienne.

Parametry

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

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"

{}

Historia wersji jednego pliku we wszystkich punktach przywracania

Jedno wywołanie restic find po stronie serwera we wszystkich migawkach w repozytorium urządzenia, zredukowane do UNIKALNYCH wersji (kolejne trafienia o identycznym rozmiarze i mtime są scalane) i połączone z wierszami indeksu migawek w celu uzyskania dat/rodzajów/notatek.

Parametry

club `string` (wymagane) uuid `string` (wymagane) path `string` (wymagane)

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"

{}

Przeszukaj według nazwy pliku wszystkie punkty przywracania kopii zapasowych urządzenia

Ścieżka odzyskiwania usuniętych plików: jedno wywołanie restic find po stronie serwera we WSZYSTKICH migawkach w repozytorium (bez rozróżniania wielkości liter, podciąg lub wzorzec glob), pogrupowane według ścieżki wraz z punktami przywracania, w których występuje każdy plik. Plik usunięty z urządzenia nadal można tu znaleźć, dopóki zawiera go którykolwiek punkt przywracania.

Parametry

club `string` (wymagane) uuid `string` (wymagane) q `string` (wymagane)

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"

{}

Pobierz pojedynczy plik z punktu przywracania kopii zapasowej

Przesyła jeden plik bezpośrednio z repozytorium restic do przeglądarki (jako załącznik). Katalogi są przesyłane jako archiwum tar. Rozmiar jest ograniczony; obsługa odbywa się po stronie serwera, więc działa, gdy urządzenie jest offline.

Parametry

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

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"

{}

Wycofaj Agenta AI z obiektu

Parametry

club `string` (wymagane)

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"

{}

Usuń Agenta AI z obiektu i przywróć ustawienia fabryczne sprzętu

Całkowicie odłącza urządzenie, aby można je było sparować w DOWOLNYM obiekcie, i usuwa wszystkie dane z NUC. Czyszczenie jest uzbrajane przez zmienną urządzenia balena PH_FACTORY_RESET (jednorazowy nonce) PRZED usunięciem zasobów w chmurze, dzięki czemu działa także wtedy, gdy urządzenie jest offline w chwili usunięcia — czyszczenie zostanie wykonane przy następnym połączeniu. Powiadomienie MQTT factoryReset sprawia, że urządzenie online jest czyszczone natychmiast. Usuwanie zasobów w chmurze odwołuje następnie wszystkie poświadczenia i uprawnienia, czyści powiązanie z obiektem w Balena (zmienne urządzenia + tag club) oraz clubID w metadanych, usuwa żądania dostępu i rekord DNS w sieci LAN. Kopie zapasowe w chmurze są ZACHOWYWANE: indeks migawek i hasło repozytorium pozostają w miękko usuniętej rejestracji i mogą służyć jako źródło przywracania podczas dodawania urządzenia zastępczego. Wymaga wpisania nazwy urządzenia jako potwierdzenia.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Zastąp uszkodzonego Agenta AI nowym NUC (odtwarzanie po awarii)

Jednorazowa wymiana urządzenia: kojarzy zastępczy NUC (miejsce tunelu, sekrety, zmienne balena, inicjalizacja kopii zapasowej), przenosi nazwę, lokalizację, harmonogram ponownego uruchamiania, ustawienia kopii zapasowej, blokadę dostępu i uprawnienie MCP starego urządzenia, przypisuje indeks migawek starego urządzenia do nowego (dzięki czemu cała historia kopii zapasowych pozostaje dostępna), wycofuje starą rejestrację (oznaczoną replacedBy / replacedFrom) i — o ile `restore` nie ma wartości false — kolejkuje pełne przywrócenie wybranego punktu przywracania z repozytorium kopii zapasowych STAREGO urządzenia na nowy sprzęt. Działa, gdy stare urządzenie jest uszkodzone/offline; wymaga wpisania nazwy starego urządzenia jako potwierdzenia. Tylko w ramach tego samego obiektu.

Parametry

club `string` (wymagane)

Treść żądania

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

{}

Rozwiązuje krótki link z kodu QR urządzenia Performance Hub do docelowego linku głębokiego, aby skaner Dodaj urządzenie mógł wykryć typ urządzenia. Obsługiwane są wyłącznie hosty performancehub.co.

Parametry

url `string` (wymagane) Zeskanowany krótki link

GET /api/devices/resolve-qr

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

{}

Testuje łączność z kontrolerem Unifi obiektu i poprawność poświadczeń.

Parametry

facilityID `string` (wymagane) Wewnętrzny identyfikator obiektu, dla którego chcesz przetestować łączność z 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"

{}

Aktualizuje ogólne urządzenie IoT powiązane z obiektem.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

PUT /api/devices/updateGenericDevice/{club}

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

{}

Zwraca liczbę oczekujących umów wymagających działania dla użytkownika i powiązanych z nim klubów

GET /api/agreements/agreements-outstanding

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

{}

Wyświetla wszystkie umowy dostępne dla klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. contracts-sort `string` (opcjonalne) Sortuj umowy według daty obowiązywania (date-effective) lub alfabetycznie (alphabetical). Domyślnie date-effective. contracts-acknowledgement `string` (opcjonalne) Filtruj umowy według wartości all, acknowledged lub unacknowledged. Domyślnie all. contracts-requirement `string` (opcjonalne) Filtruj umowy według wartości all, signature, checkbox, popup lub none. Domyślnie all. contracts-status `string` (opcjonalne) Filtruj umowy według wartości all, active lub archived. Domyślnie all.

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

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

{}

Podpisuje umowę na podstawie jej identyfikatora.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu podpisującego umowę. agreementid `string` (wymagane) Identyfikator podpisywanej umowy. body `string` (wymagane) Obiekt JSON zawierający umowę i parametry do dodania lub przesłania do systemu.

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"

{}

Podsumowanie Model Router obiektu (konfiguracja, saldo, wydatki).

Parametry

clubID `string` (wymagane) tz `string` (opcjonalne) Strefa czasowa IANA przeglądającego — używana zastępczo dla dziennych i miesięcznych okresów wydatków, gdy obiekt nie ma danych o strefie czasowej.

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"

{}

Katalog dostępnych modeli ze stanem włączenia dla obiektu (domyślnie wszystkie włączone).

Parametry

clubID `string` (wymagane)

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"

{}

Dostępne zabezpieczenia (guardrails) i gotowe szablony PH.

Parametry

clubID `string` (wymagane)

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"

{}

Połączone usługi Model Router. Obejmują sparowane urządzenia Agent AI, agentów zewnętrznych z jawnie określonym typem oraz usługę Workflow obiektu. Konfigurację edytuje się przez PATCH /keys/{keyHash}.

Parametry

clubID `string` (wymagane) tz `string` (opcjonalne) Strefa czasowa IANA przeglądającego — używana zastępczo dla dziennych i miesięcznych okresów wydatków, gdy obiekt nie ma danych o strefie czasowej.

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"

{}

Włącz Model Router dla obiektu i skonfiguruj jego dostęp do wnioskowania.

Parametry

clubID `string` (wymagane)

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"

{}

Aktualizuje plan, listę dozwolonych modeli, zabezpieczenia (guardrails), filtry treści (maskowanie lub blokowanie wyrażeniami regularnymi po stronie PH), limit wydatków i konfigurację automatycznego doładowania.

Parametry

clubID `string` (wymagane)

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"

{}

Resetuje do 0 licznik twardego limitu za cały okres (nowy punkt odniesienia na poziomie bieżących wydatków) i zapisuje zamknięty okres w historii.

Parametry

clubID `string` (wymagane)

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"

{}

Historia resetów twardego limitu (od najnowszych) — limit, wydana kwota i znaczniki czasu dla każdego zamkniętego okresu.

Parametry

clubID `string` (wymagane)

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"

{}

Tworzy nowy klucz API phk_ dla obiektu (tekst jawny jest zwracany tylko raz). Przyjmuje opcjonalne limity wydatków, listę dozwolonych modeli, zabezpieczenia (guardrails), filtry treści oraz limity szybkości rpmLimit/tpmLimit.

Parametry

clubID `string` (wymagane)

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"

Aktualizuje edytowalne pola klucza: etykietę, limity wydatków klucza, listę dozwolonych modeli, zabezpieczenia (guardrails), filtry treści oraz limity szybkości rpmLimit/tpmLimit (synchronizowane z kluczem).

Parametry

clubID `string` (wymagane) keyHash `string` (wymagane)

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"

{}

Dzienniki wnioskowania obiektu dla poszczególnych żądań (na żywo, tylko metadane).

Parametry

clubID `string` (wymagane) page `string` (opcjonalne) pageSize `string` (opcjonalne) status `string` (opcjonalne) model `string` (opcjonalne) provider `string` (opcjonalne) source `string` (opcjonalne) `key` lub `agent` keyHash `string` (opcjonalne) Filtruj do jednego klucza lub agenta według jego keyHash w PH. q `string` (opcjonalne) Wyszukiwanie pełnotekstowe według identyfikatora żądania, etykiety klucza lub agenta, modelu, dostawcy i użytkownika końcowego. minutes `string` (opcjonalne) Okres krótszy niż doba (np. Live=1440); zastępuje startDate/endDate. startTs `string` (opcjonalne) Początek okresu w sekundach epoki (powiększanie kliknięciem); zastępuje minuty i daty. endTs `string` (opcjonalne) Koniec okresu w sekundach epoki (powiększanie kliknięciem); zastępuje minuty i daty.

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"

{}

Histogram liczby żądań w czasie dla widoku Logs. Te same filtry co w trasie listy, ale z agregacją po stronie serwera w przedziały czasu (liczba sukcesów i błędów), dzięki czemu odpowiedź jest bardzo mała niezależnie od liczby wpisów. Wielkość przedziału jest dobierana automatycznie do zakresu.

Parametry

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

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"

{}

Przedziały analityki użycia i sumy dla poszczególnych modeli w wybranym zakresie (na żywo).

Parametry

clubID `string` (wymagane) range `string` (opcjonalne) 24h | 7 | 30 | 90 | year | all (ignorowane, jeśli podano startDate/endDate) startDate `string` (opcjonalne) endDate `string` (opcjonalne) groupBy `string` (opcjonalne) model (domyślnie) | key | source | provider | status — wymiar dla przedziałów i grup subgroupBy `string` (opcjonalne) opcjonalny drugi wymiar zagnieżdżony w każdej grupie (Explore) keyHash `string` (opcjonalne) filtr szczegółowy — ogranicza zakres do jednego klucza lub agenta model `string` (opcjonalne) filtr szczegółowy — ogranicza zakres do jednego modelu provider `string` (opcjonalne) source `string` (opcjonalne) compare `string` (opcjonalne) ustaw na "prev", aby zwrócić także groupsPrev (bezpośrednio poprzedzający okres o tej samej długości)

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"

{}

Kalendarz dziennej aktywności z ostatniego roku kroczącego (ok. 53 tygodnie, w stylu GitHub).

Parametry

clubID `string` (wymagane)

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"

{}

Obciąża zapisaną kartę rozliczeń SaaS, aby dodać przedpłacone środki Model Router.

Parametry

clubID `string` (wymagane) body `object` (opcjonalne)

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"

{}

Finalizuje doładowanie po zakończeniu uwierzytelniania 3DS w aplecie.

Parametry

clubID `string` (wymagane)

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"

{}

Podsumowanie zapisanej karty rozliczeń SaaS, którą obciążają doładowania i automatyczne doładowania.

Parametry

clubID `string` (wymagane)

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"

{}

Transakcje księgowe obiektu, od najnowszych. Opcjonalnie filtrowane według typu (np. `types=topup,adjustment` dla historii przepływów środków lub `types=charge-reconcile` z `from`/`to` dla potrąceń za użycie w danym miesiącu).

Parametry

clubID `string` (wymagane) limit `integer` (opcjonalne) Maksymalna liczba wierszy (domyślnie 50, maks. 200) types `string` (opcjonalne) Typy transakcji rozdzielone przecinkami (topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (opcjonalne) Tylko transakcje z createdAt >= from (sekundy Unix) to `integer` (opcjonalne) Tylko transakcje z createdAt <= to (sekundy 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"

{}

Różne miesiące `YYYY-MM` (UTC, od najnowszych) zawierające co najmniej jedną transakcję żądanych typów. Zasilają oparte na danych listy rozwijane filtrów roku i miesiąca, dzięki czemu interfejs proponuje tylko okresy, dla których istnieją dane.

Parametry

clubID `string` (wymagane) types `string` (opcjonalne) Typy transakcji rozdzielone przecinkami (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"

{}

Potwierdzenie płatności w formacie PDF z oznaczeniem marki dla pojedynczej transakcji Model Router.

Parametry

clubID `string` (wymagane) txId `string` (wymagane)

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"

{}

Pakiet potwierdzeń płatności w formacie PDF z oznaczeniem marki dla wybranych transakcji doładowania, jako plik ZIP. Każdy identyfikator musi dotyczyć doładowania należącego do obiektu — potrącenia za użycie i korekty administracyjne nie mają potwierdzeń i są odrzucane.

Parametry

clubID `string` (wymagane) ids `string` (wymagane) Identyfikatory transakcji rozdzielone przecinkami (maks. 50)

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

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

{}

Zestawienia potrąceń za użycie w obiekcie według miesięcy kalendarzowych (UTC), od najnowszych. Bieżący miesiąc jest zawsze uwzględniany i oznaczany jako `isCurrentMonth` (od początku miesiąca do dziś).

Parametry

clubID `string` (wymagane) months `integer` (opcjonalne) Okres wstecz w miesiącach (domyślnie 12, maks. 24; ignorowany, gdy ustawiono `year`) year `integer` (opcjonalne) Ogranicza zestawienia do jednego roku kalendarzowego UTC (np. 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"

{}

Miesięczne zestawienie użycia (Usage Statement) w formacie PDF z oznaczeniem marki — podsumowanie potrąceń za użycie w danym miesiącu (sumy dzienne i suma całkowita). Wyraźnie nie jest to faktura ani potwierdzenie; potrącenia za użycie nie pobierają płatności.

Parametry

clubID `string` (wymagane) month `string` (wymagane) Miesiąc kalendarzowy 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"

{}

Surowe pozycje potrąceń za użycie z danego miesiąca jako CSV (identyfikator transakcji, znacznik czasu UTC, kwota, saldo po transakcji, stan wydatków łącznych) — szczegółowy eksport zgodny z sumą zestawienia miesięcznego.

Parametry

clubID `string` (wymagane) month `string` (wymagane) Miesiąc kalendarzowy 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"

{}

Podsumowanie użycia i wydatków obiektu (dane na żywo oraz uzgodniona księga).

Parametry

clubID `string` (wymagane) tz `string` (opcjonalne) Strefa czasowa IANA przeglądającego — używana zastępczo dla dziennych i miesięcznych okresów wydatków, gdy obiekt nie ma danych o strefie czasowej.

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"

{}

Przypisuje urządzenie AI Edge Processor do klubu lub aktualizuje przypisanie

Parametry

body `string` (wymagane) Obiekt JSON do aktualizacji rejestracji urządzenia 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"

{}

Przypisuje urządzenie AI Edge Processor do klubu. Identyfikuje urządzenie najpierw na podstawie metadanych (pierwszeństwo ma bieżący sygnał heartbeat), uzupełnia rekord rejestracji, jeśli urządzenie nigdy nie zarejestrowało się samodzielnie, i usuwa nieaktualne rekordy rejestracji pozostawione przez ponownie skonfigurowany sprzęt.

Parametry

body `string` (wymagane) Obiekt JSON do aktualizacji rejestracji urządzenia 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"

{}

Zwraca listę rekordów przesłanych danych bbox w klubie

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Indeks wyszukiwania bazy danych kamer

Przekazuje publiczny indeks wyszukiwania bazy kamer z dokumentacji (producenci, serie, modele, aliasy) używany przez okno Find my camera podczas dodawania kamer sieciowych. Przechowywany w pamięci podręcznej serwera przez 12 godzin.

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"

{}

Szablony producentów w bazie danych kamer

Przekazuje szablony adresów URL RTSP i ustawienia domyślne jednego producenta z publicznej bazy kamer w dokumentacji. Identyfikator slug jest weryfikowany, aby zapobiec przechodzeniu po ścieżkach. Przechowywane w pamięci podręcznej serwera przez 12 godzin.

Parametry

slug `string` (wymagane) Identyfikator slug producenta (np. 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"

{}

Zwraca listę danych o zameldowaniach w obiekcie

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu lub obiektu, do którego chcesz uzyskać dostęp. startDate `string` (opcjonalne) Data początkowa w formacie YYYY-MM-DD endDate `string` (opcjonalne) Data końcowa w formacie YYYY-MM-DD timezone `string` (opcjonalne) Strefa czasowa do interpretacji dat (domyślnie Australia/Brisbane) nextToken `string` (opcjonalne) Token stronicowania do pobrania następnej strony

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"

{}

Pobierz konfigurację interfejsu telewizji przemysłowej (CCTV)

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

GET /api/cctv/config/:club

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

{}

Pobierz konfigurację dostarczania treści telewizji przemysłowej (CCTV)

Zwraca domenę treści, której klienci CCTV używają do pobierania zasobów multimedialnych. Domena jest określana przez zmienną środowiskową CONTENT_DOMAIN, a w razie jej braku używana jest wartość domyślna zależna od etapu (produkcja obsługuje /cctv, pozostałe etapy /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"

{}

Zmień konfigurację interfejsu telewizji przemysłowej (CCTV)

Parametry

body `object` (wymagane) Obiekt JSON nowego bloku konfiguracji do dodania do systemu.

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"

{}

Zwraca listę dostępnych regionów zasobników dla konfiguracji dostawcy pamięci masowej CCTV

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zresetuj kolekcję niezidentyfikowanych twarzy

Resetuje kolekcję niezidentyfikowanych osób CompreFace w obiekcie, usuwając wszystkie podmioty. Rekordy osób w DynamoDB, wykrycia twarzy i bloki osi czasu w OpenSearch NIE są zmieniane. Usuwane są tylko bazowe dane rozpoznawania twarzy. Nowe profile tymczasowe zostaną utworzone automatycznie, gdy system przetworzy nowe wykrycia z kamer.

Parametry

facilityId `string` (wymagane)

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"

{}

Pobierz informacje o kolekcji niezidentyfikowanych osób

Zwraca bieżącą liczbę podmiotów w kolekcji niezidentyfikowanych osób CompreFace w obiekcie.

Parametry

facilityId `string` (wymagane)

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"

{}

Dodaje kamerę sieciową (kamerę OEM/IP) przez adres URL strumienia (RTSP, HTTP, HTTPS)

Parametry

body `string` (wymagane) Obiekt JSON do dodania kamery sieciowej.

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"

{}

Zbiorczo dodaj kamery sieciowe do urządzenia Edge Processor

Rejestruje wiele kamer sieciowych RTSP/HTTP w jednym urządzeniu Edge Processor, a następnie jednorazowo wysyła FEED_CONFIG, aby urządzenie przeładowało konfigurację tylko raz.

Parametry

body `object` (wymagane)

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"

{}

Przypisuje urządzenie do klubu lub aktualizuje przypisanie

Parametry

body `string` (wymagane) Obiekt JSON do aktualizacji rejestracji urządzenia CCTV.

POST /api/cctv/devices

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

{}

Przypisuje urządzenie do klubu

Parametry

body `string` (wymagane) Obiekt JSON do aktualizacji rejestracji urządzenia 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"

{}

Wysyła żądanie MQTT do urządzenia o wskazanym UUID i oczekuje odpowiedzi (przez websocket) z dostępnymi możliwościami kamery.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego należy odpytywane urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Wyświetl rejestracje urządzeń

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

GET /api/cctv/devices/:club

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

{}

Usuwa kamerę sieciową, oznaczając ją jako usuniętą i usuwając ją z FEED_CONFIG urządzenia Edge Processor

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego należy urządzenie. balenaUUID `string` (wymagane) UUID kamery sieciowej do usunięcia.

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"

{}

Zapisuje skonfigurowane możliwości kamery i stosuje je na urządzeniu jako zmienną środowiskową (przez balena)

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego należy odpytywane urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Zapisuje maskę ruchu kamery (jeśli skonfigurowano) i stosuje ją na urządzeniu jako zmienną środowiskową (przez balena)

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego należy odpytywane urządzenie. body `string` (wymagane) Obiekt JSON maski kamery.

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"

{}

Wysyła do fizycznego urządzenia określone polecenie v4l2 (np. jasność lub kontrast)

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego należy odpytywane urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Przetestuj adres URL strumienia kamery sieciowej

Wysyła polecenie testowe do urządzenia Edge Processor, aby zweryfikować adres URL strumienia kamery za pomocą ffprobe

Treść żądania

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

{}

Trwale usuwa z bazy danych pojedynczy rekord wykrycia twarzy. Służy do usuwania błędnie dopasowanych lub nieprawidłowych wpisów śledzenia z dziennika aktywności osoby.

Parametry

club `string` (wymagane) fdID `string` (wymagane)

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"

{}

Zwraca listę danych o wykryciach twarzy danej osoby

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personID `string` (wymagane) Identyfikator osoby w systemie identyfikacji twarzy

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"

{}

Zwraca wykrycia twarzy odwołujące się do wskazanego wycinka obrazu osoby, wyszukiwane przez GSI personCropImage.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personCropImage `string` (wymagane) Adres URL wycinka obrazu osoby zapisany w rekordzie wykrycia twarzy. limit `string` (opcjonalne) Maksymalna liczba zwracanych wykryć. nextToken `string` (opcjonalne) Token stronicowania z poprzedniej odpowiedzi.

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"

{}

Zwraca listę danych o wykryciach twarzy w klubie, pogrupowanych według zakresu względem bieżącego czasu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca listę danych o wykryciach twarzy w klubie

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Przeszukaj bloki osi czasu wykryć twarzy w obiekcie za pomocą OpenSearch

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu do przeszukania timezone `string` (wymagane) Strefa czasowa IANA do konwersji dat (np. Pacific/Auckland) startDate `string` (opcjonalne) Filtr daty początkowej (YYYY-MM-DD), konwertowany na startUnix z użyciem strefy czasowej endDate `string` (opcjonalne) Filtr daty końcowej (YYYY-MM-DD), konwertowany na endUnix z użyciem strefy czasowej personId `string` (opcjonalne) Filtruj według identyfikatora osoby query `string` (opcjonalne) Wyszukiwanie pełnotekstowe (np. imię i nazwisko osoby) limit `string` (opcjonalne) Wyniki na stronę (domyślnie 20, maks. 100) filters `string` (opcjonalne) Obiekt filtrów zakodowany w JSON (np. {"matchType":"identified"}) sortBy `string` (opcjonalne) Pole sortowania (startUnix, endUnix, created). Domyślnie endUnix. page `string` (opcjonalne) Numer strony przy stronicowaniu (domyślnie 1) sortOrder `string` (opcjonalne) Kierunek sortowania (asc lub desc). Domyślnie 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"

{}

Zwraca listę raportów dotyczących obiektu klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Uruchamia generowanie mapy cieplnej na żądanie. Wywołuje tę samą logikę Starter, której używa zaplanowane zadanie cron, ale pozwala wskazać konkretny obiekt, datę i godzinę oraz zestaw okresów. Wywołane bez treści działa identycznie jak zadanie cron — skanuje wszystkie kwalifikujące się obiekty i dodaje do kolejki każde urządzenie.

Treść żądania

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

{}

Ustala lokalizację złożonego pliku PNG mapy cieplnej z okna kroczącego dla jednego urządzenia. Zwraca tylko metadane JSON — bajty PNG znajdują się w domenie treści, a interfejs tworzy adres URL jako: `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` Kolejność ustalania: 1. Trafienie w indeksie DynamoDB `composed#…` → natychmiastowy zwrot (~10 ms). 2. Wasabi HEAD na deterministycznym kluczu pamięci podręcznej. Przy trafieniu zapisywany jest uzupełniający rekord indeksu i następuje zwrot. 3. Zastępczy nieaktualny wynik: istnieje dowolny złożony rekord dla tej krotki (urządzenie, zakres, godzina), nawet z innej daty. Zwracany natychmiast z `cache: 'HIT-STALE'`, aby interfejs mógł *coś* wyświetlić. Nowe składanie jest uruchamiane asynchronicznie. 4. Ścieżka zimna: nie istnieje żaden rekord. Lambda składająca jest dodawana do kolejki przez `InvocationType: 'Event'`, a punkt końcowy zwraca `202 { cache: 'PENDING' }`. Interfejs odpytuje, aż pojawi się rekord (zwykle 3-5 sekund). Obsługa bieżącego dnia: gdy `endDate` to lokalne "dziś" obiektu, punkt końcowy zwraca zamiast tego wczorajszy PNG — dzisiejsze wycinki są nadal zapisywane przez zadanie cron Starter, a nowe złożenie byłoby niekompletne. Odpowiedź powtarza żądane `endDate` i zawiera `endDateUsed` (= wczoraj). Wartości wyliczenia `cache`: - `HIT` — zwrócono z indeksu DDB dla żądanej daty. - `HIT-FALLBACK` — zażądano dnia dzisiejszego; zwrócono wczorajszy rekord indeksu. - `HIT-BACKFILL` — brak w DDB, ale Wasabi miało PNG; rekord został właśnie zapisany. - `HIT-FALLBACK-BACKFILL` — uzupełnienie przy zastępczym wyniku z wczoraj. - `HIT-STALE` — brak rekordu dla żądanej daty, ale istnieje rekord z innej daty dla tej krotki; zwrócono natychmiast, a nowe składanie dodano do kolejki w tle. - `PENDING` — brak jakiegokolwiek rekordu; składanie dodano do kolejki. Interfejs powinien odpytywać. Odpowiedź to `202 Accepted`, bez `filePath`.

Parametry

facilityId `string` (wymagane) deviceUUID `string` (wymagane) Urządzenie, dla którego wykonywane jest składanie. Złożenia są tworzone dla każdego urządzenia osobno. hour `integer` (wymagane) Godzina dnia 0–23, dla której wykonywane jest składanie w całym okresie wstecz. endDate `string` (opcjonalne) Ostatnia data w okresie (YYYY-MM-DD). Domyślnie dziś (strefa czasowa obiektu). range `string` (opcjonalne) Okres wstecz. Musi być jednym z dozwolonych zakresów. nocache `integer` (opcjonalne) Ustaw na `1`, aby pominąć warstwy pamięci podręcznej DDB i HEAD oraz wymusić nowe składanie.

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"

{}

Ustala, dla których godzin dnia istnieją rekordy wycinków `1h` dla urządzenia w kroczącym okresie wstecz. Interfejs używa tego do wypełnienia selektora godzin obok selektora daty i zakresu przed wywołaniem punktu końcowego składania (`/api/cctv/heatmaps/hourly/...`). Przykład: `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` Wewnętrznie: jedno zapytanie zakresowe DynamoDB na `cctvheatmaps` (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`), pogrupowane według godzin. Zwraca jeden wpis na każdą godzinę z co najmniej jednym wycinkiem, w tym reprezentatywny obraz referencyjny JPEG (z najnowszego dnia w okresie — obraz referencyjny jest wspólny dla urządzenia i dnia).

Parametry

facilityId `string` (wymagane) deviceUUID `string` (wymagane) Urządzenie do odpytania. Wycinki godzinowe są tworzone dla każdego urządzenia osobno. endDate `string` (opcjonalne) Ostatnia data w okresie (YYYY-MM-DD). Domyślnie dziś (strefa czasowa obiektu). range `string` (opcjonalne) Okres wstecz. Musi być jednym z dozwolonych zakresów.

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"

{}

Odpytuje wstępnie wygenerowane rekordy map cieplnych obiektu. **Wszystkie rekordy dla typu okresu:** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **Zakres dat — jeden typ okresu:** - `/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` **Zakres dat — wszystkie pasujące typy okresów (pomiń periodType):** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` Zwraca rekordy roczne, półroczne, kwartalne itd. aż do 6h, które pokrywają się z podanym zakresem. **Punkt w czasie — wszystkie 9 typów okresów dla jednego urządzenia:** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` Zwraca do 9 rekordów (1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h).

Parametry

facilityId `string` (wymagane) Identyfikator obiektu. deviceUUID `string` (opcjonalne) Odpytuje wskazane urządzenie. Jeśli go nie podano, odpytywane są wszystkie urządzenia (GSI). periodType `string` (opcjonalne) Filtruje do jednego typu okresu. Jeśli pominięto go przy from/to, odpytywane są wszystkie typy. from `string` (opcjonalne) Data początkowa (yyyy-mm-dd). Musi być używana razem z `to`. to `string` (opcjonalne) Data końcowa (yyyy-mm-dd). Musi być używana razem z `from`. date `string` (opcjonalne) Wyszukiwanie dla punktu w czasie (yyyy-mm-dd lub yyyy-mm-ddTHH:mm). Wymaga deviceUUID. Zwraca jeden rekord na każdy typ okresu.

GET /api/cctv/heatmaps/{facilityId}

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

{}

Pobierz miniaturę transmisji na żywo z urządzenia

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu. deviceId `string` (wymagane) Wewnętrzny identyfikator urządzenia 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"

{}

Powiadom system CCTV, że zamierzasz oglądać transmisję na żywo

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu. deviceId `string` (wymagane) Wewnętrzny identyfikator urządzenia 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"

{}

Zatwierdź dopasowanie krzyżowe

Ustawia status dopasowania na potwierdzony i zapisuje osobę weryfikującą.

Parametry

club `string` (wymagane) matchId `string` (wymagane)

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"

{}

Pobierz pojedyncze dopasowanie krzyżowe ze szczegółami wizyt

Zwraca rekord dopasowania wraz z podziałem czasu na poszczególne wizyty.

Parametry

club `string` (wymagane) matchId `string` (wymagane)

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"

{}

Ręcznie powiąż niedopasowaną osobę z członkiem

Powiązuje personId z CCTV z określonym członkiem i ustawia dopasowanie jako potwierdzone.

Parametry

club `string` (wymagane) matchId `string` (wymagane)

Treść żądania

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

{}

Wyświetl dopasowania krzyżowe obiektu

Zwraca stronicowane dopasowania filtrowane według statusu.

Parametry

club `string` (wymagane) status `string` (opcjonalne) limit `integer` (opcjonalne) nextToken `string` (opcjonalne)

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"

{}

Odrzuć dopasowanie krzyżowe

Ustawia status dopasowania na odrzucony i zapisuje osobę weryfikującą.

Parametry

club `string` (wymagane) matchId `string` (wymagane)

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"

{}

Pobierz zbiorcze liczby dopasowań krzyżowych

Zwraca liczby dopasowań w obiekcie pogrupowane według statusu.

Parametry

club `string` (wymagane) Identyfikator obiektu

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"

{}

Usuń powiązanie automatycznie wyuczonego dopasowania profilu

Przywraca powiązanemu dopasowaniu status odrzuconego i czyści autoLearnedFrom w rekordzie członka.

Parametry

club `string` (wymagane) matchId `string` (wymagane)

Treść żądania

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

{}

Odczytuje status trwającej operacji "upsert identified person" (obejmuje tworzenie i edycję). Odczytuje rekord bezpośrednio z tabeli `people-ops` należącej do cctv-rekognition-api, bez pośrednictwa Lambdy. Używane przez interfejs CCTV do odpytywania o postęp po POST /api/cctv/people/{facility}/identified. Ścieżka leży obok `/cctv/people/...` (nie jest w niej zagnieżdżona), aby router express nie dopasował błędnie `operationId` jako `:personID` w `/cctv/people/:club/:personID`. Zobacz kolejność wzorców w createAPIRouter. Zwraca wartość zastępczą `pending`, dopóki Lambda upsertIdentifiedPerson nie zapisze pierwszego wpisu etapu (okno zimnego startu). Mechanizm odpytywania w interfejsie traktuje wartość zastępczą i pending identycznie, dzięki czemu kontrakt pozostaje stabilny dla wywołujących.

Parametry

operationId `string` (wymagane)

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"

{}

Dodaje obraz twarzy (z istniejącego wykrycia śledzenia) do podmiotu rozpoznawania CompreFace danej osoby i zapisuje odwołanie w tabeli zdjęć tymczasowych. NIE przesyła obrazu do Wasabi — już się tam znajduje jako przechwycone wykrycie twarzy.

Parametry

club `string` (wymagane) personID `string` (wymagane) body `string` (wymagane)

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"

{}

Dodaj zdjęcia tymczasowe do rekordu osoby

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personID `string` (wymagane) Identyfikator rekordu osoby body `string` (wymagane) Obiekt JSON nowego bloku konfiguracji do dodania do systemu.

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"

{}

Odpytaj o zdjęcia tymczasowe osoby

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personID `string` (wymagane) Identyfikator rekordu osoby

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"

{}

Trwale usuwa rekord zdjęcia tymczasowego z CCTVShadowPhotosTable i usuwa odpowiadającą mu twarz z CompreFace (jeśli zapisano faceId).

Parametry

club `string` (wymagane) personID `string` (wymagane) id `string` (wymagane) Identyfikator rekordu zdjęcia tymczasowego (klucz główny)

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"

{}

Usuwa odwołania i powiązane rekordy rozpoznawania według personID

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personID `string` (wymagane) Unikalny identyfikator osoby w 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"

{}

Zwraca rekord osoby w klubie

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. personID `string` (wymagane) Identyfikator osoby w bazie danych.

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"

{}

Pobierz strefy dostępu dopasowane do profilu członkostwa osoby

Ustala typ członka, tagi i plany członkostwa osoby, a następnie zwraca rzeczywiste strefy dostępu (origin=membership-plan, niewchłonięte) dopasowane według reguł uwzględniania i wykluczania. accessRestriction każdej strefy jest ograniczane do reguł, które pasowały do osoby. Kamery stref podrzędnych są scalane ze strefami nadrzędnymi.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu personID `string` (wymagane) Identyfikator osoby z tabeli osób 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"

{}

Zwraca bieżący status zadania scalania, w tym wyniki dla poszczególnych źródeł. Odpytuj ten punkt końcowy co 3-5 sekund, dopóki status to IN_PROGRESS.

Parametry

club `string` (wymagane) mergeJobID `string` (wymagane)

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"

{}

Uruchamia w tle scalanie wielu profili niezidentyfikowanych osób w jeden profil docelowy. Natychmiast odpowiada kodem 202 z mergeJobID. Postęp sprawdzaj, odpytując /merge-status/:mergeJobID.

Parametry

club `string` (wymagane) body `string` (wymagane)

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"

Dodaj twarz do kolekcji czarnej listy obiektu

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu

Treść żądania

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

{}

Tworzy lub aktualizuje zidentyfikowaną osobę w obiekcie — tworzy nowy rekord albo aktualizuje istniejący. Przekazuje żądanie do Lambdy upsertIdentifiedPerson, która zapisuje rekord osoby, przesyła przekazane zdjęcie do Wasabi i ponownie indeksuje twarz w CompreFace. Gdy `isNewRecord` ma wartość true (domyślnie), Lambda wykonuje gałąź tworzenia (cctvPeople.save), a `personID` jest generowany, jeśli go nie podano. Gdy `isNewRecord` ma wartość false, Lambda wykonuje gałąź aktualizacji (cctvPeople.update) — `personID` jest wymagany i musi wskazywać istniejący rekord.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

Aktualizuje zestaw opcjonalnych pól partnera synchronizowanych z tabelą osób CCTV obiektu.

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu

Treść żądania

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

{}

Zwraca listę danych osób w klubie

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

GET /api/cctv/people/:club

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

{}

Wyszukuje osoby w obiekcie na podstawie obrazu twarzy. Wywołuje Lambdę imageFaceSearch z cctv-rekognition-api, przekazując przesłany obraz base64 i identyfikator obiektu ze ścieżki. Zwraca uszeregowane dopasowania oraz podsumowanie atrybutów DeepFace.

Parametry

club `string` (wymagane) Identyfikator obiektu lub klubu body `string` (wymagane)

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"

{}

Wyszukaj osoby w obiekcie za pomocą OpenSearch

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu do przeszukania query `string` (opcjonalne) Wyszukiwane hasło (np. imię i nazwisko) page `string` (opcjonalne) Numer strony (domyślnie 1) limit `string` (opcjonalne) Wyniki na stronę (domyślnie 20, maks. 100) filters `string` (opcjonalne) Obiekt filtrów zakodowany w JSON (np. {"membershipStatus":"active"}) sortBy `string` (opcjonalne) Pole sortowania (created, lastName, firstName, membershipUpdatedOn). Domyślnie created. sortOrder `string` (opcjonalne) Kierunek sortowania (asc lub desc). Domyślnie 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"

{}

Aktualizuje elementy wykrycia twarzy o nowy personID i powiązuje rekordy rozpoznawania

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. body `string` (wymagane) Obiekt JSON nowego bloku konfiguracji do dodania do systemu.

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"

{}

Zwraca obiekt ze wszystkimi dostępnymi filtrami danych nagrań CCTV klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Strumieniuj nagranie.

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"

{}

Zaktualizuj informacje o nagraniu.

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"

{}

Zwraca podsumowanie danych nagrań CCTV klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca listę danych nagrań CCTV klubu na podstawie zakresu względem bieżącego czasu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca listę danych nagrań CCTV klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

GET /api/cctv/recordings/:club

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

{}

Nagrania są automatycznie usuwane po określonym czasie; użyj tej funkcji, aby je zachować

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Przeszukaj migawki raportów obiektu w zakresie dat

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu startDate `string` (wymagane) Filtr daty początkowej (YYYY-MM-DD) endDate `string` (wymagane) Filtr daty końcowej (YYYY-MM-DD) deviceIds `string` (opcjonalne) Rozdzielona przecinkami lista identyfikatorów kamer lub urządzeń do filtrowania view `string` (opcjonalne) Alternatywny widok raportu do obliczenia (przekazywany do Lambdy raportu)

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"

{}

Wyszukiwanie wektorowe w zaindeksowanych materiałach CCTV obiektu. Odpowiada strumieniem text/event-stream przekazywanym z Lambdy searchAnything, dzięki czemu klient może wyświetlać postęp, gdy zimny kontener ładuje koder. Zdarzenia to `status`, a następnie `result` albo `error`. Są trzy sposoby wyszukiwania, w tym dwa przy tej metodzie. Wyślij `query`, aby wyszukiwać według dowolnego tekstu. Wyślij `seedIndex` + `seedKey`, aby wyszukiwać według przykładu — "więcej podobnych" — przy użyciu wektora rekordu, który jest już w indeksie; w ten sposób można znaleźć więcej wyników podobnych do tego, który przegląda użytkownik. Aby wyszukiwać według obrazu, który ma użytkownik, wyślij zamiast tego bajty metodą `POST` na tę samą ścieżkę. Wyślij słowa razem z obrazem, aby zawęzić jedno drugim: **tekst filtruje, obraz szereguje**. Kandydaci pochodzą z przykładu, słowa decydują, którzy z nich pozostaną, a podobieństwo wizualne decyduje o kolejności — dzięki temu wyniki nadal przypominają obraz, a słowa odrzucają te, które nie pasują. Obie metody nigdy nie są łączone w jeden wektor, dlatego `queryKind` pozostaje `similar` przy wyszukiwaniu łączonym; to obecność `query` w wyniku wskazuje, że zastosowano filtr tekstowy. Wyszukiwania łączone dość często nie zwracają niczego — traktuj to jako osobny wynik: `perIndex..textGated` liczy kandydatów, którzy pasowali do obrazu, ale nie do słów, więc pustą stronę można wyjaśnić jako "usuń słowa", a nie "spróbuj innego obrazu". Wyszukiwanie według przykładu bez słów nie ładuje kodera, więc nigdy nie ponosi kosztu zimnego startu; dodanie słów eliminuje tę zaletę. W obu przypadkach domyślnie przeszukiwane są wszystkie indeksy: wektory wycinków, nagrań i timelapse'ów współdzielą jedną przestrzeń, więc wycinek osoby może znaleźć pasujące nagrania. Wyniki wyszukiwania według przykładu są znacznie wyższe niż wyniki tekstowe (porównanie obrazu z obrazem nie pokonuje różnicy modalności) i są filtrowane przez osobny, jeszcze nieskalibrowany próg — `result.queryKind` wskazuje, w jakiej skali jest wynik, a wyników z jednej skali nigdy nie należy porównywać z drugą. Domyślnie przeszukuje wszystkie indeksy i zwraca jedną scaloną listę posortowaną według wyniku; każde trafienie zawiera `index` i `kind`, aby wywołujący mógł odróżnić trafienie obrazu od trafienia wideo (to drugie zawiera dodatkowo `offsetMs`). Indeksy bez tabeli dla danego obiektu są zgłaszane w `skipped` zamiast powodować błąd. Trafienia poniżej skalibrowanego progu trafności danego indeksu są odrzucane, więc zapytanie bez rzeczywistego dopasowania zwraca pustą listę zamiast pewnie brzmiących, bezsensownych wyników; `perIndex` informuje, co wniósł każdy indeks i dlaczego. Wyniki można zawęzić według czasu przechwycenia i kamery. Używaj `cameraId` zamiast `camera`: to balenaUUID kamery, jedyna wartość zapisywana identycznie w każdym indeksie, więc jeden filtr zawęża je wszystkie. Filtr, którego indeks nie może obsłużyć, jest zgłaszany w `perIndex..filtersIgnored`, a ten indeks jest przeszukiwany bez zawężenia, zamiast zostać pominięty. Trafienia nagrań to **jedno na klip, a nie jedno na dopasowaną klatkę**: klatki są próbkowane co 2 s, więc obiekt, który pozostaje dłużej w kadrze, pasuje do dziesięciu niemal identycznych klatek tego samego nagrania. Każdy klip zwraca najlepszą klatkę oraz `matchCount` i `offsetsMs` z listą wszystkich pasujących momentów w klipie, których można bezpośrednio użyć jako punktów przewijania. Wycinki osób nigdy nie są scalane, ponieważ dwa wycinki jednej osoby to dwa odrębne zaobserwowania.

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu do przeszukania query `string` (opcjonalne) Dowolny opis tekstowy tego, czego szukasz. Wymagany, chyba że wysłano warm=1 lub przykład. W połączeniu z przykładem przestaje być podstawą szeregowania i staje się filtrem kandydatów przykładu, odrzucając tych, których wynik tekstowy jest niższy niż próg trafności indeksu. seedIndex `string` (opcjonalne) Wyszukiwanie według przykładu zamiast tekstu: indeks, w którym znajduje się rekord przykładu (person-crops, recording-frames, timelapse-frames). Jest to `index` trafienia klikniętego przez użytkownika. Musi być wysłany razem z seedKey. seedKey `string` (opcjonalne) `key` rekordu przykładu, przepisany dosłownie z trafienia. Przykład jest wykluczany z własnych wyników — w przypadku nagrania oznacza to cały klip, ponieważ jego pozostałe klatki dzielą 2 s i są niemal identyczne. seedFrameId `string` (opcjonalne) Wymagane, gdy seedIndex to recording-frames: ten indeks przechowuje jeden rekord na każdą próbkowaną klatkę, a wszystkie mają wspólny klucz klipu, więc sam klucz wskazuje klip, a nie moment. Wyślij `frameId` trafienia. Starsze rekordy go nie mają — wyślij wtedy seedOffsetMs. seedOffsetMs `string` (opcjonalne) Zastępczy identyfikator klatki dla przykładów z recording-frames, których rekord powstał przed wprowadzeniem `frame_id`. Wyślij `offsetMs` trafienia. Ignorowany, gdy podano seedFrameId. warm `string` (opcjonalne) Rozgrzewa kontener Lambda bez uruchamiania wyszukiwania. Wywołaj to przy ładowaniu strony. warmTarget `string` (opcjonalne) Który koder ładuje `warm`: `text` (domyślnie), `image` lub `both`. Moduł wizyjny zajmuje 355 MB wobec 283 MB modułu tekstowego, więc jego rozgrzewanie jest opcjonalne — żądaj `image` dopiero wtedy, gdy użytkownik rzeczywiście przygotował obraz, a nie przy ładowaniu strony. index `string` (opcjonalne) Rozdzielone przecinkami zbiory danych do przeszukania: person-crops, recording-frames, timelapse-frames. Wyniki są scalane w jedną listę posortowaną według wyniku. Domyślnie przeszukiwane są wszystkie trzy; przekaż jawną listę, aby zawęzić wyszukiwanie. timelapse-frames obejmuje kamery, które niczego nie nagrywają, a jedynie tworzą jedną klatkę na minutę; jego próg trafności nie jest jeszcze skalibrowany. model `string` (opcjonalne) Koder używany do zapytania. Musi być zgodny z koderem, którym zaindeksowano zbiór danych. limit `string` (opcjonalne) Liczba wyników zwracanych na indeks (domyślnie 50, maks. 100) — nie jest to suma, więc przeszukanie wszystkich trzech indeksów może zwrócić do trzech razy więcej. W przypadku nagrań liczone są klipy, a nie dopasowane klatki. from `string` (opcjonalne) Dopasowuj tylko materiały przechwycone w tym czasie lub później, w milisekundach od początku epoki. Jest to czas przechwycenia, a nie przesłania. to `string` (opcjonalne) Dopasowuj tylko materiały przechwycone przed tym czasem (z wyłączeniem), w milisekundach od początku epoki. cameraId `string` (opcjonalne) Rozdzielone przecinkami identyfikatory balenaUUID kamer, do których ma zostać zawężone wyszukiwanie — pole `balenaUUID` każdego wpisu zwracanego przez /api/cctv/recordings/filters/:club. Zalecany filtr kamer: każdy indeks przechowuje tę samą wartość, więc jeden filtr zawęża je wszystkie. Zawiera ją tylko część wycinków, dla których udało się połączyć dane z wykryciem twarzy (obecnie ok. 1%), więc zawężanie wycinków według kamery zwróci niewiele wyników lub żadnych, dopóki nie zostanie uruchomione uzupełnianie wycinków; nagrania mają pełne dane i są filtrowane dokładnie. camera `string` (opcjonalne) Rozdzielone przecinkami nazwy kamer, do których ma zostać zawężone wyszukiwanie. W praktyce dotyczy tylko nagrań: person-crops przechowuje pustą nazwę kamery w każdym rekordzie, więc dowolna wartość wyklucza wszystkie wycinki. Używaj raczej cameraId. cameraGroup `string` (opcjonalne) Rozdzielone przecinkami grupy kamer, do których ma zostać zawężone wyszukiwanie. Wypełnione we wszystkich nagraniach, ale tylko w ok. 1% wycinków, z tej samej przyczyny co cameraId. minScore `string` (opcjonalne) Zastępuje próg kosinusowy indeksu, który odfiltrowuje szum. Pomiń w środowisku produkcyjnym; każdy indeks ma skalibrowaną wartość domyślną (oraz osobną, nieskalibrowaną dla wyszukiwań według przykładu). Przekaż 0, aby zobaczyć niefiltrowanych najbliższych sąsiadów podczas debugowania trafności.

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"

{}

Wyszukiwanie według obrazu, który ma użytkownik, a nie według słów lub wyniku widocznego już na ekranie. Pod każdym innym względem identyczne z GET — te same parametry zapytania, ten sam strumień zdarzeń, ten sam kształt wyniku — dlatego opisano tu tylko różnice. Wyślij **oryginalne bajty pliku** jako treść żądania z nagłówkiem Content-Type `image/*`. Nie zmieniaj wcześniej rozmiaru obrazu, nie przycinaj go ani nie koduj ponownie w przeglądarce: serwer odtwarza bardzo konkretną zmianę rozmiaru (ściśnięcie do 256x256 z dwuliniowym jądrem z antyaliasingiem), przy której zbudowano zaindeksowane wektory, a skalowanie w elemencie canvas używa innej. Zmierzono, że taka zamiana daje odległość kosinusową ok. 0,93 od prawidłowej odpowiedzi, czyli większą niż między dwoma naprawdę różnymi obrazami — wyniki wracają więc uszeregowane wiarygodnie, ale błędnie, bez żadnego komunikatu o błędzie. Limit wynosi 4 MB i wynika z ograniczeń transportu, a nie jakości: bajty są przesyłane w ładunku wywołania Lambdy, ograniczonym do 6 MB, a kodowanie base64 zwiększa ich objętość o jedną trzecią. Wyniki są obliczane przez porównanie obrazu z obrazem, więc `queryKind` ma wartość `image`, a wyniki są w tej samej, znacznie wyższej skali co wyszukiwanie według przykładu — nigdy nie są porównywalne z wynikami tekstowymi. Należy spodziewać się, że będą nieco *niższe* niż w równoważnym wyszukiwaniu według przykładu: wektor przykładu zapisało samo urządzenie, a przesłany obraz jest tu ponownie kodowany przez inny silnik, co przesuwa go o kilka setnych względem miejsca, w którym umieściłoby go urządzenie. Pomiary pokazują, że mimo to wyniki mają równą jakość; po prostu nie jest to identyczny zestaw. Dodanie `query` filtruje wyniki według tych słów, dokładnie tak jak w przypadku przykładu. Wysłanie przykładu *i* obrazu jest odrzucane: oba są podstawą szeregowania, więc taka para nie ma sensu. To najdroższe żądanie obsługiwane przez ten punkt końcowy. Przesłany obraz ładuje moduł wizyjny, a dodanie słów ładuje też moduł tekstowy — oba w zimnym kontenerze. Wywołanie `warm=1&warmTarget=image`, gdy użytkownik przygotuje obraz, usuwa ten koszt ze ścieżki krytycznej.

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu do przeszukania body `string` (wymagane) Surowe, niezmienione bajty obrazu, maksymalnie 4 MB query `string` (opcjonalne) Opcjonalne słowa zawężające wyniki wyszukiwania obrazem; odrzucane są dopasowania, których wynik tekstowy jest niższy niż próg trafności indeksu.

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"

{}

Zwraca szczegóły pamięci masowej i inne dane metryk CCTV klubu

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"

{}

Zwraca listę rekordów przesłanych timelapse'ów klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

GET /api/cctv/timelapse/:club

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

{}

Wyświetl działania użytkowników wykonane na nagraniach w interfejsie CCTV

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zarejestruj działanie użytkownika wykonane na nagraniach w interfejsie CCTV

Parametry

body `string` (wymagane) Obiekt JSON nowego bloku konfiguracji do dodania do systemu.

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"

{}

Pobierz token użytkownika dla interfejsu CCTV

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Wygeneruj token dostępu tymczasowego lub gościnnego

Parametry

club `string` (wymagane) Unikalny identyfikator klubu. body `string` (wymagane) Obiekt JSON ze szczegółami tokenu do wydania.

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

Zwraca listę rekordów tokenów dostępu tymczasowego lub gościnnego

Parametry

club `string` (wymagane) Unikalny identyfikator klubu.

GET /api/cctv/token/{club}

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

{}

Pobierz token dostępu na podstawie identyfikatora dostępu

Parametry

accessID `string` (wymagane) Identyfikator rekordu tokenu w bazie danych.

POST /guest/cctv/token/:accessID

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

{}

Usuń godziny dostępu do obiektu

Parametry

facilityId `string` (wymagane) body `object` (wymagane) Obiekt JSON z nowymi godzinami dostępu.

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"

{}

Zwraca listę godzin dostępu do obiektu

Parametry

facilityId `string` (wymagane)

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"

{}

Aktualizuje lub tworzy godziny dostępu do obiektu

Parametry

facilityId `string` (wymagane) body `object` (wymagane) Obiekt JSON z nowymi godzinami dostępu.

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"

{}

Usuń strefę dostępu obiektu

Parametry

facilityId `string` (wymagane) body `object` (wymagane) Obiekt JSON nowej strefy dostępu.

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"

{}

Zwraca listę stref dostępu obiektu

Parametry

facilityId `string` (wymagane)

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"

{}

Aktualizuje lub tworzy strefę dostępu obiektu

Parametry

facilityId `string` (wymagane) body `object` (wymagane) Obiekt JSON nowej strefy dostępu.

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"

{}

Zwraca sumę wszystkich identyfikatorów modułów administracyjnych ze wszystkich marek i obiektów organizacji, wypełnioną jako obiekty modułów.

Parametry

organisationId `string` (wymagane) Identyfikator organizacji

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"

{}

Zwraca listę wszystkich organizacji

Parametry

includeBrands `string` (opcjonalne) Uwzględnij marki powiązane z organizacją includeFacilities `string` (opcjonalne) Uwzględnij obiekty powiązane z organizacją includeRegions `string` (opcjonalne) Uwzględnij regiony powiązane z organizacją

GET /api/organisations

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

{}

Proste narzędzie AI analizujące treść zgłoszenia do wsparcia i tworzące sugestie na podstawie dostępnych tematów oraz proponowanych tematów wyszukiwania Algolia.

Parametry

messageBody `string` (wymagane) Treść wiadomości do wysłania topicData `string` (wymagane) Obiekt lub tablica JSON z topicData zwróconymi z osTicket (system zgłoszeń i wsparcia) facilityId `string` (opcjonalne) Wewnętrzny identyfikator klubu potrzebny do ustalenia właściwego indeksu Algolia do przeszukania.

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"

{}

Proste API do generowania obrazów

Parametry

type `string` (wymagane) Typ obrazu do wygenerowania name `string` (wymagane) Nazwa obrazu maxSize `string` (opcjonalne) Opcjonalny maksymalny rozmiar odpowiedzi, np. 200KB, 1MB lub zwykła liczba bajtów. Obraz jest zmniejszany lub kompresowany, aby się zmieścić.

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"

{}

Proste zapytanie LLM

Lekki punkt końcowy do prostych, bezstanowych zapytań LLM. Korzysta z taniego modelu bez rozumowania (gpt-4o-mini) ze ścisłymi limitami tokenów. Bez historii rozmowy, bez narzędzi, bez strumieniowania — tylko prompt na wejściu i tekst na wyjściu.

Treść żądania

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

{}

Zwraca konfigurację Algolia, w tym nazwę indeksu, identyfikator aplikacji i klucz API.

Parametry

facilityId `string` (wymagane)

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"

{}

Inicjuje indeks Algolia materiałów marketingowych do druku

Parametry

organisationId `string` (wymagane)

PUT /api/algolia/index

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

{}

Wyszukaj materiały marketingowe do druku

Treść żądania

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

{}

Wyszukaj materiały marketingowe do druku

Parametry

club `string` (opcjonalne) Identyfikator klubu searchTerms `string` (opcjonalne) Wyszukiwane hasła algoliaArgs `object` (opcjonalne) Dodatkowe argumenty wyszukiwania Algolia

GET /algolia/search-marketing-print

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

{}

Zbiorczo zaktualizuj obiekty materiałów marketingowych do druku dla wybranego klubu

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"

{}

Pobiera z Algolia zasoby materiałów marketingowych do druku.

Parametry

organisationId `string` (wymagane) search `string` (opcjonalne) limit `string` (opcjonalne) brand `string` (opcjonalne) tag `string` (opcjonalne)

GET /api/algolia/marketing/assets

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

{}

Inicjuje indeks Algolia materiałów marketingowych do druku z konfiguracją obiektu.

Parametry

organisationId `string` (wymagane)

POST /api/algolia/marketing/assets

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

{}

Przeszukuje wskazany indeks Algolia na podstawie wyszukiwanych haseł, klubu lub ustawień regionalnych. Wyszukiwanie można dodatkowo dostosować za pomocą dodatkowych argumentów Algolia.

Parametry

searchTerms `string` (wymagane) Hasła do wyszukania w indeksie Algolia. club `string` (opcjonalne) Wewnętrzny identyfikator klubu wysyłającego żądanie. Jeśli zostanie podany, wyniki wyszukiwania będą filtrowane według regionu powiązanego z klubem. locale `string` (opcjonalne) Ustawienia regionalne używane do ustalenia regionu, jeśli nie podano klubu. Pobierane z navigator.languages. algoliaArgs `string` (opcjonalne) Dodatkowe lub niestandardowe argumenty przekazywane do żądania wyszukiwania 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"

{}

Wyświetla wszystkie ogłoszenia

GET /api/announcements/list

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

{}

Przesyła zasób do PUBLICZNEGO ZASOBNIKA S3 (przez Upload API), który następnie przetwarza i optymalizuje plik, generuje miniatury itp. *Uwaga: zasoby będą publicznie dostępne*

Parametry

file `string` (opcjonalne) Nazwa pliku lub zasobu do przesłania.

POST /api/asset-upload

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

{}

Zwraca status przesyłania na podstawie podanego UUID rekordu przesyłania

Parametry

uuid `string` (wymagane) UUID rekordu przesyłania

GET /api/asset-upload/:uuid

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

{}

Wyślij polecenie do systemu Sonos w klubie

Parametry

body `object` (wymagane) Obiekt JSON z poleceniem i danymi wejściowymi do wysłania do 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"

{}

Pobierz konfigurację interfejsu Audio Control

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zmień konfigurację interfejsu Audio Control

Parametry

body `object` (wymagane) Obiekt JSON nowego bloku konfiguracji do dodania do systemu.

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"

{}

Pobiera ustawienia marki dla wybranego regionu

Parametry

brandId `string` (opcjonalne) Identyfikator marki regionCode `string` (opcjonalne) Kod ISO regionu, dla którego mają zostać pobrane ustawienia

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"

{}

Aktualizuje wiele ustawień marki dla wybranego regionu

Parametry

brandId `string` (opcjonalne) Identyfikator marki do zaktualizowania regionCode `string` (opcjonalne) Kod ISO regionu, dla którego mają zostać zaktualizowane ustawienia acceptFreeTrialBookingsVisibility `string` (opcjonalne) customTrackingCodeVisibility `string` (opcjonalne) displayDataSources `string` (opcjonalne) displayDefaultDataSource `string` (opcjonalne) displayDefaultUI `string` (opcjonalne) displayUIOptions `string` (opcjonalne) defaultAboutBusiness `string` (opcjonalne) defaultAboutBusinessFacebook `string` (opcjonalne) facilityCoverImage `string` (opcjonalne) digitalProfileSettingsVisibility `string` (opcjonalne) facilityHoursVisibility `string` (opcjonalne) facilityLocationVisibility `string` (opcjonalne) facilityPaymentMethods `string` (opcjonalne) facilityPrimaryLogo `string` (opcjonalne) facilityStatusVisibility `string` (opcjonalne) landingPagesVisibility `string` (opcjonalne) lineChatIntegrationVisibility `string` (opcjonalne) whatsAppIntegrationVisibility `string` (opcjonalne) defaultWhatsAppMessage `string` (opcjonalne) socialUrlsVisibility `string` (opcjonalne) yextApiKey `string` (opcjonalne) Klucz API używany przez integrację Yext dla tej marki i regionu. Uwzględniany tylko wtedy, gdy `directorySyncMode` ma wartość `yext`. directorySyncMode `string` (opcjonalne) Mechanizm synchronizacji używany dla obiektów tej marki i regionu. Jeśli nie podano, domyślnie `yext` — dla zgodności wstecznej z markami utworzonymi przed wdrożeniem Directory Publishers. websiteUrl `string` (opcjonalne) androidAppUrl `string` (opcjonalne) iosAppUrl `string` (opcjonalne) featuredMessageDescription `string` (opcjonalne) yextCategoryIds `string` (opcjonalne) Starszy klucz zapisu — w rzeczywistości są to identyfikatory kategorii Google Business Profile (np. gcid:gym). Prefiks "yext" pochodzi sprzed wycofania Yext; zachowano go dla zgodności wstecznej z istniejącymi rekordami w bazie danych. customInputFields `string` (opcjonalne) customInputFieldsToRemove `string` (opcjonalne)

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"

{}

Pobiera ustawienia marki dla wybranego obiektu

Parametry

facilityId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane ustawienia marki

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"

{}

Tworzy nową markę

Parametry

name `string` (wymagane) Nazwa marki organisationId `string` (wymagane) Identyfikator organizacji, do której należy marka redirectDashboard `string` (opcjonalne) Adres URL, na który użytkownik zostanie przekierowany po zalogowaniu zamiast domyślnego panelu

POST /api/brands

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

{}

Zwraca listę wszystkich marek

GET /api/brands

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

{}

Zwraca obiekt marki

Parametry

brandId `string` (wymagane) Identyfikator marki do pobrania includeOrganisation `boolean` (opcjonalne) Czy dołączyć dane organizacji do odpowiedzi

GET /api/brands/{brandId}

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

{}

Aktualizuje markę według identyfikatora

Parametry

brandId `string` (opcjonalne) Identyfikator marki do zaktualizowania name `string` (wymagane) Nazwa marki brandOrganisationId `string` (opcjonalne) Identyfikator organizacji, do której należy marka redirectDashboard `string` (opcjonalne) Adres URL, na który użytkownik zostanie przekierowany po zalogowaniu zamiast domyślnego panelu yextApiKey `string` (opcjonalne) Klucz API używany do dostępu do Yext API dla tej marki customMenuLayout `object` (opcjonalne) Drzewo układu menu bocznego dla marki (sekcje / grupy / pozycje z odwołaniami do modułów systemowych lub niestandardowych adresów URL). Może je ustawić tylko administrator organizacji, do której należy ta marka.

PUT /api/brands/{brandId}

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

{}

Wyświetl obiekty marki

Zwraca uproszczoną listę obiektów (identyfikator, nazwa, kod ISO regionu) należących do marki. Służy do wypełniania selektorów wyboru obiektów w konfiguracji marki.

Parametry

brandId `string` (wymagane) Identyfikator marki, dla której mają zostać wyświetlone obiekty

GET /api/brands/{brandId}/facilities

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

{}

Zwraca listę wszystkich marek powiązanych z organizacją klubu.

GET /api/clubs/{club}/brands

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

{}

Zwraca listę wszystkich typów kalendarzy

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"

{}

Usuń baner panelu

Nietrwale usuwa baner panelu należący do marki.

Parametry

brandId `string` (wymagane) Identyfikator marki, do której należy baner bannerId `string` (wymagane) Identyfikator banera do usunięcia

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"

{}

Wyświetl banery panelu dla marki

Zwraca wszystkie (nieusunięte) banery panelu skonfigurowane dla marki, na potrzeby zarządzania przez administratora.

Parametry

brandId `string` (wymagane) Identyfikator marki, dla której mają zostać wyświetlone banery

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"

{}

Utwórz lub zaktualizuj baner panelu

Tworzy nowy baner panelu dla marki lub aktualizuje istniejący, gdy w treści przekazano `bannerId`. Banery można planować (początek i koniec w sekundach Unix, null = bez ograniczenia) i kierować do całej marki, wybranych regionów (kody ISO) lub wybranych obiektów.

Parametry

brandId `string` (wymagane) Identyfikator marki, do której należy baner

Treść żądania

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

{}

Pobierz aktywne banery Panelu dla obiektu

Ustala banery Panelu, które powinny być obecnie wyświetlane dla obiektu, na podstawie marki obiektu, regionu (kod kraju ISO) oraz flagi włączenia, okna harmonogramu i kierowania każdego banera. Używane przez interfejsy Panelu.

Parametry

facilityId `string` (wymagane) Identyfikator obiektu, dla którego mają zostać ustalone banery

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"

{}

Zwraca zasób KYC klubu.

Parametry

clubId `string` (wymagane) Identyfikator klubu. key `string` (wymagane) Klucz zasobu 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"

{}

Zwraca informacje KYC klubu.

GET /api/clubs/{clubId}/kyc

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

{}

Aktualizuje informacje KYC klubu.

Parametry

clubId `string` (wymagane) Identyfikator klubu do zaktualizowania. body `object` (wymagane)

PUT /api/clubs/{clubId}/kyc

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

{}

Przesyła zasób KYC klubu.

Parametry

clubId `string` (wymagane) Identyfikator klubu. file `string` (wymagane) Plik do przesłania.

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"

{}

Zwraca ustawienia preferencji klubu.

GET /api/club/preferences/:club

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

{}

Tworzy lub aktualizuje wpis preferencji klubu.

Treść żądania

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

{}

Zwraca listę członków z umową.

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"

{}

Zwraca listę członków z umową.

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"

{}

Zwraca listę użytkowników należących do wskazanego klubu

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp

GET /api/clubs/{club}/members

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

{}

Zwraca informację, czy klub jest otwarty w podanym dniu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. date `string` (wymagane) Data do sprawdzenia w formacie 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"

{}

Zwraca wszystkie metadane klubu wyświetlane w witrynach Example Club.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Aktualizuje metadane klubu nowymi danymi przekazanymi z interfejsu. Pola nieobecne w treści żądania są zachowywane (bez SET i bez REMOVE). Pola wysłane jako `null` lub pusty ciąg są czyszczone. Przekaż `updateAll: false`, aby użyć dedykowanej ścieżki częściowego scalania; w obu przypadkach wywołujący nigdy nie muszą wysyłać pól, które do nich nie należą.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. body `string` (wymagane) Obiekt JSON z danymi klubu do zaktualizowania.

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"

{}

dodaj nowy rekord niestandardowego śledzenia

Parametry

club `string` (wymagane) identyfikator klubu body `string` (wymagane) Tablica elementów niestandardowego śledzenia.

POST /api/clubs/{club}/customtracking

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

{}

Zwraca niestandardowe śledzenie dla wybranego klubu

GET /api/clubs/customtracking/:clubID

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

{}

Zaktualizuj wpisy niestandardowego śledzenia

Parametry

club `string` (wymagane) identyfikator klubu body `string` (wymagane) Obiekt JSON z danymi klubu do zaktualizowania.

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"

{}

Zwraca domyślny obraz witryny klubu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Wyświetl drzwi dostępne w obiekcie

Parametry

body `object` (wymagane) Obiekt JSON z danymi klubu do zaktualizowania.

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"

{}

Odblokuj wybrane drzwi w obiekcie

Parametry

body `object` (wymagane) Obiekt JSON z danymi klubu do zaktualizowania.

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"

{}

Zwraca wszystkie integracje i szczegóły konfiguracji wskazanego klubu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Aktualizuje metadane klubu nowymi danymi przekazanymi z interfejsu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. body `object` (wymagane) Obiekt JSON z danymi klubu do zaktualizowania.

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"

{}

Zwraca wartość logiczną określającą, czy klub znajduje się w kraju europejskim

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. date `string` (wymagane) Data do sprawdzenia w formacie 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"

{}

Zwraca ogólną listę wszystkich klubów w bazie danych.

GET /api/clubs/listclubs

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

{}

Zwraca informację, czy klub jest otwarty w podanym dniu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. date `string` (wymagane) Data do sprawdzenia w formacie 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"

{}

Pobierz opinie o klubie z DynamoDB.

Parametry

club `string` (wymagane) Identyfikator klubu

GET /api/clubs/{club}/reviews

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

{}

Pobierz ustawienia opinii o klubie z DynamoDB.

Parametry

facilityId `string` (wymagane) identyfikator obiektu

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"

{}

Zaktualizuj ustawienia opinii o klubie w DynamoDB.

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Ponownie włącz automatyczną publikację w ustawieniach opinii.

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Publikuje opinię

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. review `string` (wymagane) Wewnętrzny identyfikator opinii do opublikowania.

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"

{}

Ponownie włącz automatyczną publikację w ustawieniach opinii.

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Publikuje odpowiedź na opinię za pośrednictwem serwisu, z którego pochodzi (Google itp.).

Parametry

club `string` (wymagane) Identyfikator obiektu reviewId `string` (wymagane) Identyfikator opinii w PH (wyszukiwany w tabeli club-social-reviews) body `string` (wymagane)

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"

{}

Cofa publikację opinii

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. review `string` (wymagane) Wewnętrzny identyfikator opinii, której publikację chcesz cofnąć.

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"

{}

Zwraca z bazy danych PH listę właścicieli należących do wskazanego klubu

Parametry

clubID `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp

GET /api/clubs/{clubID}/owners

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

{}

Zwraca wszystkie plany członkostwa obiektu.

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu

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"

{}

Aktualizuje rekord planu członkostwa.

Parametry

facilityId `string` (wymagane) Wewnętrzny identyfikator obiektu body `object` (wymagane) Obiekt JSON z danymi planu członkostwa do zaktualizowania.

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"

{}

Ponownie włącz automatyczną publikację w ustawieniach opinii.

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Ponownie włącz automatyczną publikację w ustawieniach opinii.

Parametry

club `string` (wymagane) Identyfikator klubu

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"

{}

Zwraca listę wszystkich dostępnych walut

GET /api/currencies

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

{}

Zwraca lokalizację geograficzną na podstawie adresu IP.

Parametry

ip `string` (wymagane) Adres IP do sprawdzenia

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"

{}

Zwraca lokalizację geograficzną bieżącego użytkownika na podstawie jego adresu 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"

{}

Zwraca wyłącznie publiczny adres IP klienta wysyłającego żądanie (bez geolokalizacji i bez wywołań API zewnętrznych firm). Używane przez aplet Agenta AI do porównania publicznego adresu IP przeglądarki z adresem WAN IP zgłaszanym przez urządzenie w celu wykrycia tej samej sieci.

GET /api/geo/client-ip

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

{}

Parser numerów telefonów.

Parametry

body `string` (wymagane) Obiekt JSON z numerem, który chcesz przeanalizować.

POST /api/phone/parser

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

{}

Zwraca urządzenie zegara głównego

Parametry

club_id `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie.

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"

{}

Zwraca główne urządzenie Sonos

Parametry

club_id `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie.

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"

{}

pobierz powiadomienia Duress o niskim poziomie baterii dla wskazanego klubu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca dane analizy sieci

Parametry

club_id `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie.

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"

{}

wyślij powiadomienia Duress o niskim poziomie baterii dla wskazanego klubu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca dane testów szybkości urządzeń dla każdego typu urządzenia

Parametry

club_id `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie.

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"

{}

Pobierz statystyki wizytówek obiektu. Domyślnie zwraca zagregowane dzienne sumy ze wszystkich wydawców, a pojedynczego wydawcę, gdy podano `publisherId`.

Parametry

facilityId `string` (wymagane) publisherId `string` (opcjonalne) startDate `string` (wymagane) endDate `string` (wymagane)

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"

{}

Pobierz zagregowane statystyki wizytówek marki ze wszystkich wydawców.

Parametry

brandId `string` (wymagane) startDate `string` (wymagane) endDate `string` (wymagane)

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"

{}

Najczęstsze słowa kluczowe wyszukiwania (z podziałem na zawierające nazwę marki i bez niej) dla obiektu, obecnie pobierane z Google Business Profile.

Parametry

facilityId `string` (wymagane) publisherId `string` (opcjonalne) Domyślnie "google" — obecnie obsługiwany jest tylko Google. startDate `string` (wymagane) endDate `string` (wymagane) limit `string` (opcjonalne)

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"

{}

Najczęstsze słowa kluczowe wyszukiwania dla marki, zagregowane ze wszystkich obiektów.

Parametry

brandId `string` (wymagane) startDate `string` (wymagane) endDate `string` (wymagane) limit `string` (opcjonalne)

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"

{}

Wyświetl pytania i odpowiedzi dla obiektu.

Parametry

facilityId `string` (wymagane)

GET /api/facilities/{facilityId}/qna

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

{}

Odpowiedz na pytanie.

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"

{}

Usuń odpowiedź.

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"

{}

Zwraca wydawców włączonych dla organizacji obiektu wraz ze stanem ich połączenia.

Parametry

facilityId `string` (wymagane) organisationId `string` (wymagane)

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"

{}

Pobierz wspólne ustawienia Door/Gate Access dla obiektu

Parametry

facilityId `string` (wymagane)

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"

{}

Zaktualizuj wspólne ustawienia Door/Gate Access dla obiektu

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Pobierz Access Policies dla obiektu

Istniejąca konfiguracja dostępu jest przy pierwszym odczycie automatycznie przekształcana w równoważne, egzekwowane zasady.

Parametry

facilityId `string` (wymagane)

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"

{}

Zastąp Access Policies z optymistyczną kontrolą wersji

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Utwórz zasadę dostępu (Access Policy)

Parametry

facilityId `string` (wymagane)

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"

{}

Zaktualizuj jedną zasadę dostępu (Access Policy)

Parametry

facilityId `string` (wymagane) policyId `string` (wymagane)

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"

{}

Usuń jedną zasadę dostępu (Access Policy)

Parametry

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

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"

{}

Zduplikuj zasadę dostępu (Access Policy) z nowym stałym identyfikatorem

Parametry

facilityId `string` (wymagane) policyId `string` (wymagane)

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"

{}

Policz użytkowników i drzwi objętych wszystkimi Access Policies

Parametry

facilityId `string` (wymagane)

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"

{}

Policz użytkowników i drzwi objętych zasadą dostępu (Access Policy)

Parametry

facilityId `string` (wymagane) policyId `string` (wymagane)

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"

{}

Wyświetl typy osób, statusy i tagi dla obiektu

Zwraca unikalne wartości typu osoby, statusu członkostwa i tagów występujące w wierszach User Access obiektu (ph-door-access-users), pochodzące z synchronizacji z partnerem i wpisów ręcznych. Aplet door-gate-access używa ich do wypełniania list rozwijanych reguł dostępu. Tagi są sumą zsynchronizowanych `tags` i administracyjnych `customTags`, zgodnie z mechanizmem oceny reguł.

Parametry

facilityId `string` (wymagane)

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"

{}

Wyświetl kontrolery drzwi w obiekcie wraz z obowiązującymi regułami Door/Gate Access

Parametry

facilityId `string` (wymagane)

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"

{}

Zapisz nadpisania dla poszczególnych drzwi, ikonę i konfigurację po stronie urządzenia

Jedno miejsce zapisu wszystkiego, co aplet administracyjny DGA edytuje dla drzwi: - `accessRulesOverride` / `geofenceOverride` — przekaż `null`, aby wyczyścić i wrócić do ustawienia domyślnego obiektu. - `icon` — stały klucz przesyłany w API (zob. services/door-access/door-icons.js); nieznane wartości zwracają 400. - `holdTimeSeconds` (1–30), `maintenanceMode` (`off` / `force-open` / `force-closed`), `doorLocation` (dowolny tekst, ≤64 znaki), `playNotificationSoundOnRelayToggle` (wartość logiczna), `autoUnlockSchedule` (tygodniowa siatka okien). Kiedyś były to pola dostępne tylko w Device Management, ale aplet zapisuje je teraz bezpośrednio, dzięki czemu administratorzy nie muszą opuszczać panelu drzwi przy codziennych zmianach konfiguracji. Gdy zmieniane jest którekolwiek z pól po stronie urządzenia, trasa przesyła też odpowiednie zmienne środowiskowe Balena (`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`) i wysyła polecenie MQTT `unlockUpdates`, aby urządzenie przejęło nową konfigurację bez czekania na następne odświeżenie zmiennych Balena. Działanie typu best effort — odpowiedź ma kod 200 nawet wtedy, gdy Balena jest chwilowo nieosiągalna.

Parametry

facilityId `string` (wymagane) doorId `string` (wymagane)

Treść żądania

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

{}

Lekkie sprawdzenie stanu Balena na potrzeby komunikatu o ponownym uruchomieniu w panelu drzwi

Panel apletu DGA pobiera te dane z opóźnieniem, gdy administrator otwiera drzwi, aby wyświetlić właściwy komunikat „zapisanie spowoduje ponowne uruchomienie kontrolera”: domyślny wariant „kilka sekund” lub mocniejszy wariant „kilka minut”, gdy oczekuje również aktualizacja wersji. Zwraca płaską migawkę uzyskaną z `balena.models.device.get()`. W razie błędu zwraca `data: null` (zamiast błędu 5xx), dzięki czemu awaria Balena pogarsza jedynie treść komunikatu, zamiast blokować otwarcie panelu.

Parametry

facilityId `string` (wymagane) doorId `string` (wymagane)

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"

{}

Nadpisanie administracyjne — odblokuj drzwi z apletu

Krótko przełącza przekaźnik, używając bieżącego `holdTimeSeconds` drzwi, zapisując wiersz audytu `admin-override` w ph-door-app-access-events, aby działanie można było przypisać w Rejestrach dostępu. Zawsze kończy się powodzeniem niezależnie od `maintenanceMode === 'force-closed'` — to awaryjne obejście dla administratora. Zwraca 200, gdy tylko publikacja MQTT zostanie wysłana; na stany potwierdzone / nieudane / timed_out nie czeka się tutaj (starszy przepływ /api/devices/door-controllers + /api/ics/devices/command również nie czeka na wynik).

Parametry

facilityId `string` (wymagane) doorId `string` (wymagane)

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"

{}

Odtwórz na kontrolerze drzwi sygnał dźwiękowy ułatwiający lokalizację

Publikuje polecenie MQTT `beep`, aby kontroler wyemitował trzy sygnały średniej długości (każdy ok. 500 ms, przerwa ok. 350 ms, łącznie ok. 2 s). Używane przez administratorów do fizycznego zlokalizowania kontrolera drzwi na miejscu. Starszy przycisk w Device Management używa ok. 30-sekundowej serii krótkich sygnałów, ale sterownik brzęczyka w oprogramowaniu układowym niezawodnie emituje tylko pierwszy z nich, dlatego aplet wysyła krótszy, bardziej niezawodny wzorzec. Brak wiersza audytu — działanie diagnostyczne bez wpływu na kontrolę dostępu.

Parametry

facilityId `string` (wymagane) doorId `string` (wymagane)

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"

{}

Zdalnie uruchom ponownie kontroler drzwi

Publikuje to samo polecenie MQTT `rebootDevice` bez oczekiwania na wynik, które wysyła starszy przycisk „Remotely Reboot Device” w Device Management, ale chronione modułem `door-gate-access`, dzięki czemu administratorzy DGA mogą ponownie uruchomić kontroler z sekcji Advanced panelu drzwi bez osobnego uprawnienia `device-management`. Zwraca 200, gdy tylko publikacja zostanie wysłana; urządzenie przechodzi w tryb offline na czas ponownego uruchamiania.

Parametry

facilityId `string` (wymagane) doorId `string` (wymagane)

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"

{}

Wyświetl wiersze User Access w obiekcie

Zwraca wszystkie nieusunięte wiersze dostępu użytkowników w obiekcie. Obsługuje filtry po stronie klienta (source, search, accessEnabled, hasGrants). Obliczanie `hideExcluded` po stronie serwera z fazy 4 zostanie dodane po wdrożeniu hybrydowego mechanizmu oceny uprawnień; na razie parametr jest akceptowany, ale zwracany jest pełny zestaw.

Parametry

facilityId `string` (wymagane) search `string` (opcjonalne) source `string` (opcjonalne) accessEnabled `string` (opcjonalne) hasGrants `string` (opcjonalne) hideExcluded `boolean` (opcjonalne) Gdy true, ukrywani są zsynchronizowani użytkownicy (source != manual), którzy nie mogą przejść przez żadne drzwi w żadnym czasie w tym obiekcie. Odpowiedź zawiera obiekt `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"

{}

Ręcznie utwórz wiersz User Access w obiekcie

Tworzy nowy wiersz z `source: 'manual'`. Zwraca 409 z `existingUserId`, jeśli podany telefon lub e-mail jest już przypisany do wiersza w tym obiekcie.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

Pobierz pojedynczy wiersz User Access

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Częściowa aktualizacja wiersza User Access

Edytuje dowolny podzbiór pól tożsamości / autoryzacji. Przekaż `null`, aby wyczyścić pole opcjonalne. Zwraca 409, jeśli nowy telefon lub e-mail koliduje z innym wierszem w tym samym obiekcie. `appMessage` przyjmuje tę samą strukturę co komunikat dla całego obiektu w PUT /api/door-access/rules/{facilityId} — treść, ważność, opcjonalny link, opcjonalny harmonogram rozpoczęcia/zakończenia. Aplikacja mobilna wyświetla ten komunikat na pulpicie tylko wskazanemu użytkownikowi.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

Treść żądania

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

{}

Miękko usuń wiersz User Access

Oznacza wiersz jako `deleted: true` i wyłącza dostęp. Powiązanie dziennika audytu z userId jest zachowywane; administratorzy mogą ręcznie ponownie włączyć dostęp.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Przypisanie dostępu do poszczególnych drzwi dla użytkownika

Dla każdych drzwi zwraca bieżącą deterministyczną autoryzację (`allowedNow`, `allowedVia`, `deniedReason`) oraz skonfigurowane ścieżki dla Access Policies, stałych uprawnień, harmonogramów zasad, administracyjnych uprawnień z oknami czasowymi i aktualnych zmapowanych okien ze źródeł partnerów. Zwraca też bieżącą/następną dostępność i aktualność źródeł. Ustawienia drzwi blockAllAccess i tryb konserwacji są oceniane przed wszystkimi ścieżkami zezwalającymi.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Zbiorczo utwórz wiersze User Access z importu CSV

Tworzy wiele wierszy `source: 'manual'` w jednym żądaniu, korzystając z tej samej walidacji, normalizacji telefonu/e-maila, sprawdzania kolizji w obrębie obiektu, automatycznych wiadomości i (opcjonalnie) logiki zaproszeń co pojedyncze tworzenie. Wiersze są przetwarzane w kolejności, więc późniejszy wiersz kolidujący z wcześniej utworzonym jest zgłaszany jako duplikat. Uprawnienia są podawane jako już ustalone identyfikatory drzwi/grup (klient zamienia nazwy na identyfikatory). Uprawnienia z oknami czasowymi są celowo odrzucane w trybie zbiorczym i należy je dodać po imporcie przez punkt końcowy zastępowania dla poszczególnych użytkowników. Nigdy nie zgłasza wyjątku dla pojedynczego wiersza; wynik każdego wiersza jest raportowany osobno.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Zastąp uprawnienia autoryzacji hybrydowej w wierszu User Access

Interfejs hybrydowego mechanizmu oceny z fazy 3. Uprawnienia działają obok reguł tagów obiektu — użytkownik uzyskuje dostęp, gdy w chwili odblokowania pasuje którekolwiek z nich.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

Treść żądania

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

{}

Zastąp dodatkowe uprawnienia Access Time Window w wierszu User Access

Zastępuje tylko `timeWindowGrants`; stałe `grants` i `sourceTimeWindows` z integracji pozostają bez zmian. Każdy element wymaga zakresu (`facilityWide`, `doors` lub `groups`) oraz bezwzględnego lub tygodniowego `window`. Wysłanie pustej tablicy jawnie czyści wszystkie okna administracyjne.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

Treść żądania

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

{}

Zablokuj wiersz User Access przed aktualizacjami z synchronizacji źródła

Ustawia `decoupledFromSource: true`, czyści wszystkie `sourceTimeWindows` należące do integracji i sprawia, że synchronizacja (cron + strumienie) rejestruje i pomija ten wiersz, dopóki administrator nie wyczyści flagi przez /recouple.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Ponownie połącz wiersz User Access z aktualizacjami z synchronizacji źródła

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Odwołaj wszystkie tokeny odświeżania aplikacji Door/Gate Access użytkownika

Odwołuje na podstawie zapisanego telefonu/e-maila użytkownika (tabela tokenów odświeżania ma klucz `sha256(plaintext)`; indeksy GSI byMobilePhone / byEmail pozwalają rozesłać usuwanie z poziomu jednego użytkownika). Inni użytkownicy z tym samym telefonem/e-mailem w innym obiekcie również zostaliby wylogowani.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Wyślij (ponownie) użytkownikowi e-mail z zaproszeniem do aplikacji Door/Gate Access

Wymusza wysłanie e-maila z zaproszeniem do pobrania aplikacji na zapisany adres e-mail użytkownika (tylko e-mail, bez SMS). Pomija warunki kwalifikacji i zabezpieczenia przed ponownym wysłaniem stosowane w automatycznej synchronizacji — to jawne działanie administratora. Zwraca 400, jeśli użytkownik nie ma zapisanego adresu e-mail.

Parametry

facilityId `string` (wymagane) userId `string` (wymagane)

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"

{}

Podgląd odbiorców zbiorczej wysyłki zaproszeń do aplikacji

Wyznacza zbiór użytkowników, którzy otrzymaliby e-mail z zaproszeniem do aplikacji. Pulę bazową stanowi każdy nieusunięty użytkownik z adresem e-mail, który nigdy nie korzystał z aplikacji (puste `appLastSeenAt`). Domyślnie pula jest zawężana do użytkowników, którzy obecnie mają dostęp (dopasowanie reguły lub uprawnienie) i nigdy nie zostali zaproszeni; `includeAlreadyInvited` i `includeNoAccess` ją poszerzają. Żadne e-maile nie są wysyłane — zwracane są liczby, niewielka próbka i identyfikatory userId kandydatów dla punktu końcowego wykonania.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Wyślij e-maile z zaproszeniem do aplikacji do grupy użytkowników

Wysyła e-mail z zaproszeniem do pobrania aplikacji do każdego z podanych userId (maks. 50 na żądanie; klient dzieli pełną listę kandydatów z podglądu na partie). Każdy użytkownik jest ponownie weryfikowany w chwili wysyłki — wiersze, które już nie istnieją, nie mają adresu e-mail lub od czasu podglądu skorzystały z aplikacji, są pomijane, a nie oznaczane jako nieudane. Wyniki dla poszczególnych użytkowników są raportowane osobno, aby klient mógł podsumować wysłane / nieudane / pominięte.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Wyświetl grupy drzwi w obiekcie

Parametry

facilityId `string` (wymagane)

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"

{}

Utwórz grupę drzwi

Parametry

facilityId `string` (wymagane)

Treść żądania

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

Pobierz pojedynczą grupę drzwi

Parametry

facilityId `string` (wymagane) groupId `string` (wymagane)

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"

{}

Zaktualizuj grupę drzwi

Parametry

facilityId `string` (wymagane) groupId `string` (wymagane)

Treść żądania

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

{}

Miękko usuń grupę drzwi

Parametry

facilityId `string` (wymagane) groupId `string` (wymagane)

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"

{}

Wyświetl integracje partnerów skonfigurowane w obiekcie

Zwraca integracje partnerów obiektu (id, nazwa, logo, włączenie), łącząc ph-facility-partner-config z katalogiem ph-partners. Ograniczone do modułu door-gate-access (dzięki czemu administratorzy bez dostępu do external-integrations nadal mogą wyświetlać oznaczenia partnerów i listę synchronizacji dla poszczególnych partnerów).

Parametry

facilityId `string` (wymagane)

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"

{}

Odczytaj konfigurację synchronizacji User Access dla obiektu

Parametry

facilityId `string` (wymagane)

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"

{}

Zaktualizuj konfigurację synchronizacji User Access dla obiektu

Akceptowane są tylko pola kontrolowane przez administratora (`enabled`, `requireIdentifier` oraz mapa partnerów `partners`); `lastRunAt` i `lastRunCounts` zapisuje sam mechanizm synchronizacji. `partner.partners` to mapa włączenia poszczególnych partnerów z kluczem partnerId (zasada rezygnacji): gdy główne `partner.enabled` jest włączone, partner jest synchronizowany, chyba że ma tu jawny wpis `{ enabled: false }`.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Odczytaj konfigurację automatycznych wiadomości do poszczególnych użytkowników dla obiektu

Parametry

facilityId `string` (wymagane)

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"

{}

Zaktualizuj konfigurację automatycznych wiadomości do poszczególnych użytkowników dla obiektu

Zapisuje reguły, a następnie natychmiast ponownie ocenia każdy wiersz User Access w obiekcie, aby istniejący użytkownicy od razu otrzymali lub utracili automatyczną wiadomość. Wiadomości ręczne i odłączone wiersze pozostają bez zmian.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Stan ponownej oceny automatycznych wiadomości wykonywanej w tle

Parametry

facilityId `string` (wymagane)

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"

{}

Uruchom na żądanie synchronizację User Access dla obiektu

Synchronicznie przetwarza każde włączone źródło (partner / cctv) w obiekcie i ujednolica wiersze ph-door-access-users za pomocą kaskady deduplikacji. Zwraca liczby dla poszczególnych źródeł. Wyłączone źródła są pokazywane jako `skippedSyncDisabled: 1`, a nie pomijane, aby interfejs mógł spójnie wyświetlić oba wiersze.

Parametry

facilityId `string` (wymagane)

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"

{}

Podgląd próbny zbiorczego usunięcia danych synchronizowanych z partnerem

Zwraca liczbę i próbkę wierszy dostępu użytkowników, które zostałyby miękko usunięte, oraz confirmToken, który należy odesłać do punktu końcowego wykonania. Żadne dane nie są modyfikowane. Rejestry dostępu nigdy nie są zmieniane.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Wykonaj zbiorcze usunięcie danych synchronizowanych z partnerem (usunięcie miękkie)

Miękko usuwa każdy wiersz dostępu użytkownika synchronizowany z partnerem w zakresie. Wymaga confirmToken zwróconego przez podgląd; jeśli bieżący zbiór zmienił się od czasu podglądu, token nie będzie pasował i żądanie zostanie odrzucone (409), aby administrator ponownie je przejrzał. Rejestry dostępu są zachowywane.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Ostatnia aktywność synchronizacji User Access (dziennik rozwiązywania problemów)

Zwraca najnowsze wyniki synchronizacji dla obiektu (utworzone / pominięte / wyłączone) wraz z przyczyną, aby administratorzy widzieli, dlaczego członek został lub nie został zsynchronizowany. Od najnowszych.

Parametry

facilityId `string` (wymagane) limit `integer` (opcjonalne)

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"

{}

Wyświetl zdarzenia Door/Gate Access dla obiektu

Zwraca zdarzenia odblokowania z aplikacji mobilnej, nadpisania administracyjnego i zewnętrznego Partner API w jednym strumieniu w odwrotnej kolejności chronologicznej.

Parametry

facilityId `string` (wymagane) from `integer` (opcjonalne) to `integer` (opcjonalne) limit `integer` (opcjonalne)

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"

{}

Próbna ocena geofencingu dla pinezki trybu testowego administratora

Treść żądania

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

{}

Pobierz stan wdrożenia / aktywacji obiektu

Steruje stroną startową „Get Started” apletu i banerem postępu konfiguracji. Zwraca bieżące liczby drzwi i użytkowników, dwa wyliczane kroki podstawowe (istnieje użytkownik, istnieją drzwi), zapisane opcjonalne flagi „reviewed” oraz informację, czy obiekt jest aktywowany (oba kroki podstawowe wykonane). Gdy obiekt zostaje aktywowany po raz pierwszy, zapisywany jest znacznik czasu activatedAt.

Parametry

facilityId `string` (wymagane)

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"

{}

Zaktualizuj opcjonalne flagi wdrożenia „reviewed” dla obiektu

Zapisuje opcjonalne flagi listy kontrolnej konfiguracji zaznaczane przez administratora (reguły dostępu, ustawienia synchronizacji, geofencing). Kroki podstawowe i aktywacja są wyliczane na bieżąco z liczby danych i nie można ich tu ustawić. Zwraca pełny odświeżony stan wdrożenia.

Parametry

facilityId `string` (wymagane)

Treść żądania

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

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

GET /clubs/{clubId}/lead-events

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

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

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"

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

GET /clubs/{clubId}/analytics/referrers

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

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

GET /clubs/{clubId}/analytics/socials

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

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

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"

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

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"

{}

Zwraca odpowiedź JSON z danymi analitycznymi obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator obiektu, dla którego mają zostać pobrane dane analityczne. fromDate `string` (opcjonalne) Data początkowa pobieranych danych analitycznych. toDate `string` (opcjonalne) Data końcowa pobieranych danych analitycznych.

GET /clubs/{clubId}/analytics/traffic

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

{}

Generuje tymczasowy token JWT (JSON Web Token) dla interfejsu, na potrzeby osadzanych wykresów Google Analytics na stronie „analytics”.

GET /api/ga/onetimetoken

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

{}

Zwraca widżety Panelu z „The Training Camp”, jeśli obiekt ma aktywnych członków.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca wszystkie nieprzejrzane dni świąteczne obiektu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Oznacz wszystkie nieprzejrzane dni świąteczne obiektu jako przejrzane.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca raport KPI w formacie CSV, z podziałem na poszczególne miesiące z ostatnich 12 miesięcy. *UWAGA* Tworzy jeden raport dla WSZYSTKICH obiektów w systemie — nie uruchamiaj go wielokrotnie równolegle, bo przeciążysz GymMaster!

Parametry

months `string` (opcjonalne) Liczba miesięcy (od bieżącej daty) do pobrania (domyślnie 12)

GET /api/reporting/gymmaster/all-clubs-kpi-report

curl -X GET https://portal.hub.gymsystems.co/api/reporting/gymmaster/all-clubs-kpi-report \
  -H "x-api-key: YOUR_API_KEY"

{}

Zwraca wykresy przychodów z MMS dla danego obiektu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. range `string` (opcjonalne) Zakres w dniach (licząc wstecz od bieżącej daty), który chcemy pobrać

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"

{}

Zwraca dane/analizy MMS (Member Management System) dla Panelu danego obiektu. Dane obejmują statystyki GymMaster/Perfect Gym oraz inne wewnętrzne wskaźniki zbierane przez nasz system.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp. range `string` (opcjonalne) Zakres w dniach (licząc wstecz od bieżącej daty), który chcemy pobrać

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"

{}

Zwraca dane widżetu Myzone na Panelu dla danego obiektu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca obiekt z usługami uznanymi za niedostępne przez co najmniej jeden z naszych punktów końcowych strony stanu/monitorowania — konfigurowanych w wewnętrznym narzędziu „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"

{}

Zwraca nadchodzące rezerwacje treningów na najbliższe 7 dni.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz uzyskać dostęp.

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"

{}

Zwraca listę historycznych dni świątecznych obiektu.

Parametry

clubId `string` (opcjonalne) Identyfikator klubu fromDate `string` (opcjonalne) Uniksowy znacznik czasu daty początkowej zakresu zwracanych dni świątecznych. toDate `string` (opcjonalne) Uniksowy znacznik czasu daty końcowej zakresu zwracanych dni świątecznych.

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"

{}

Zwraca automatyzacje urządzeń powiązane z obiektem.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, którego urządzenia chcesz wyświetlić.

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"

{}

Aktualizuje konfigurację urządzenia dla istniejącego ekranu/urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Dodaje/kojarzy fizyczny ekran lub komputer z Twoim obiektem.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator klubu, do którego chcesz dodać urządzenie. body `string` (wymagane) Obiekt JSON nowego ekranu do przypisania.

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"

{}

Nakazuje urządzeniu połączenie z nowym identyfikatorem SSID na podstawie parametrów.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Aktualizuje konfigurację urządzenia dla istniejącego ekranu/urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Wczytuje adres URL/stronę internetową na ekranie określonego urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Aktualizuje konfigurację urządzenia dla istniejącego ekranu/urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

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"

{}

Zmienia nazwę ekranu/urządzenia. Dotyczy tylko rejestracji — w przeciwieństwie do punktu końcowego aktualizacji nic nie jest przesyłane do urządzenia, dlatego jest dostępne również dla ekranów z oprogramowaniem, którego wsparcie się zakończyło.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, do którego należy urządzenie. body `string` (wymagane) Obiekt JSON z parametrami zmiany nazwy.

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"

{}

Pobiera widżety i linki do multimediów offline dla obiektu na podstawie podanej daty.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, dla którego chcesz zmienić program treści szablonowych. date `string` (wymagane) Data, dla której mają zostać zwrócone adresy URL widżetów — użyj formatu `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"

{}

Pobiera widżety i linki do multimediów offline dla obiektu na podstawie podanej daty.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, dla którego chcesz zmienić program treści szablonowych.

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"

{}

Zmienia program treści szablonowych dla danego obiektu.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, dla którego chcesz zmienić program treści szablonowych. body `string` (wymagane) Obiekt JSON z nowym programem treści szablonowych.

POST /api/ics/loadprogram/{club}

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

{}

Pobiera konfigurację programu dla istniejącego ekranu/urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, którego dane programu chcesz pobrać.

GET /api/ics/programs/{club}

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

{}

Aktualizuje konfigurację programu dla istniejącego ekranu/urządzenia.

Parametry

club `string` (wymagane) Wewnętrzny identyfikator obiektu, w którym chcesz zaktualizować urządzenie. body `string` (wymagane) Obiekt JSON z parametrami aktualizacji.

PUT /api/ics/programs/{club}

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

{}

Pobiera opcje konfiguracji programu.

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"

{}

Czat z kontekstem RAG — nie ma dostępu do narzędzi, tylko do prostego narzędzia żądanie|odpowiedź API, które pozwala bezpośrednio pobierać wiedzę z bazy wiedzy.

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (zostanie wykryty automatycznie, jeśli nie zostanie podany)

Treść żądania

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

{}

Usuń osadzenia artykułu z magazynu wektorów i zaktualizuj stan śledzenia osadzeń

Treść żądania

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

{}

Wyświetl rekordy śledzenia osadzeń według organizacji i stanu

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (ustalany automatycznie, jeśli zostanie pominięty) status `string` (wymagane) Stan, według którego filtrować (jeden z: in_queue, done, anomaly, fail, deleted) Limit `string` (opcjonalne) Maksymalna liczba elementów na stronę LastEvaluatedKey `string` (opcjonalne) JSON z LastEvaluatedKey DynamoDB do paginacji

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"

{}

Wyświetl rekordy śledzenia osadzeń według organizacji (opcjonalnie z filtrem typu zasobu)

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (ustalany automatycznie, jeśli zostanie pominięty) resourceType `string` (opcjonalne) Opcjonalny typ zasobu (np. "article"). Jeśli zostanie podany, filtruje rekordy, w których resourceTypeId zaczyna się od "{type}#". Limit `string` (opcjonalne) Maksymalna liczba elementów na stronę LastEvaluatedKey `string` (opcjonalne) JSON z LastEvaluatedKey DynamoDB do paginacji

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"

{}

Zainicjuj kolekcję bazy danych wektorów organizacji

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (zostanie wykryty automatycznie, jeśli nie zostanie podany)

POST /api/llm/init-org

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

{}

Wyszukiwanie semantyczne w bazie wiedzy

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (zostanie wykryty automatycznie, jeśli nie zostanie podany)

Treść żądania

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

{}

Rozpocznij strumieniowe przetwarzanie artykułów oczekujących w kolejce na osadzenie, z aktualizacjami postępu w czasie rzeczywistym

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (zostanie wykryty automatycznie, jeśli nie zostanie podany)

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"

{}

Wstaw lub zaktualizuj osadzenia artykułu w bazie danych wektorów

Obsługuje osadzanie artykułu na podstawie jego bieżącego stanu: - Jeśli artykuł jest nieopublikowany LUB prywatny: usuwa osadzenia - Jeśli artykuł jest opublikowany I publiczny: ponownie osadza pełną treść Zawsze wymaga pełnej treści artykułu.

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (zostanie wykryty automatycznie, jeśli nie zostanie podany)

Treść żądania

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

{}

Testowy punkt końcowy do zbiorczego usuwania osadzeń artykułów według organizacji i opcjonalnie stanu

Parametry

organisationId `string` (opcjonalne) Identyfikator organizacji (ustalany automatycznie z kontekstu użytkownika, jeśli zostanie pominięty) status `string` (opcjonalne) Stan, według którego filtrować (opcjonalny — jeśli zostanie pominięty, usuwane są WSZYSTKIE artykuły organizacji niezależnie od stanu) hardDelete `string` (opcjonalne) Czy trwale usunąć rekordy śledzenia osadzeń (true), czy usunąć je miękko przez aktualizację stanu (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"

{}

Przekształć tekst i podziel go na fragmenty ze szczegółowymi statystykami

Testowy punkt końcowy, który przekształca tekst i dzieli go na fragmenty, a następnie podaje szczegółowe statystyki rozkładu fragmentów, w tym liczby znaków, wartości procentowe i wskaźniki jakości, ułatwiające ocenę skuteczności podziału.

Treść żądania

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

{}