Введение

Добро пожаловать в Performance Hub API. Этот API управляет данными клуба и ключевыми системами, интегрированными с вашим клубом и его внешними системами, и не является общедоступным API. Подробнее об использовании различных систем Performance Hub, которые поддерживает этот API, см. соответствующий раздел [документации Performance Hub](https://docs.performancehub.co) для нужной вам системы.

https://portal.hub.gymsystems.co

Аутентификация

Данные для аутентификации будут предоставлены после одобрения вашей интеграции.

Событие устройства «ход агента завершён» (триггер веб-push-уведомления)

Вызывается sidecar-процессом сопряжённого устройства ИИ-агента (никогда не браузерами), когда запуск агента, инициированный из веб-интерфейса, завершается и длится дольше порога уведомлений устройства. Аутентификация выполняется кратковременным HS256 JWT устройства (aud 'events'). Дубликаты устраняются по сочетанию устройство+сеанс+начало, частота ограничивается для каждого устройства, затем уведомление доставляется в HTML5 push-подписки инициировавшего пользователя с прямой ссылкой на беседу.

Тело запроса

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

{}

Push-уведомление, инициированное агентом (навык ph-notify)

Вызывается sidecar-процессом сопряжённого устройства ИИ-агента от имени агента на устройстве (навык ph-notify), чтобы отправить произвольное уведомление в браузер и на мобильные устройства пользователя. Аутентификация выполняется кратковременным HS256 JWT устройства (aud 'events'). Целевой пользователь должен иметь доступ к устройству (политика доступа для каждого агента); если пользователь не указан, уведомление получает владелец устройства. Частота ограничивается для каждого устройства отдельно от событий завершения хода.

Тело запроса

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

{}

Загрузка изображения для уведомления (навык ph-notify)

Принимает необработанное тело изображения от сопряжённого устройства (JWT с aud 'events') и сохраняет его в общедоступном бакете notify-media под неугадываемым ключом UUID. Объекты автоматически удаляются через 7 дней (жизненный цикл S3). Возвращает общедоступный https URL для использования в качестве `imageUrl` в /ai/events/agent-notify. Ограничение 5 МБ; только png/jpeg/gif/webp.

Тело запроса

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

{}

Ретранслятор MCP устройства для Connected Apps (внешние SaaS-инструменты)

Эндпоинт MCP Streamable HTTP для подключённых устройств ИИ-агента (сервер MCP "connected_apps" на прослушивателе :8790 вспомогательного контейнера устройства). Аутентификация выполняется краткосрочным JWT HS256 для каждого устройства (aud 'mcp' — те же учётные данные, что и для /mcp), а доступ зависит от флага включения Connected Apps у АГЕНТА (подключения относятся к устройству агента, а не к объекту). Запросы передаются потоком на собственный сервер MCP сеанса агента на вышестоящей платформе инструментов, а заголовки сеанса добавляются на стороне сервера; вышестоящие учётные данные никогда не попадают на устройство. Названия инструментов и брендинг поставщика при передаче заменяются в обе стороны. При ответе 401/410 от вышестоящего сервера (сеанс истёк) сеанс один раз создаётся заново и запрос повторяется.

POST /mcp/apps

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

{}

Поиск в журналах аудита API (доступ через модуль IAM & Admin)

Поиск и фильтрация журналов доступа к API с расширенными возможностями фильтрации. Пользователи видят журналы только тех организаций, к которым у них есть доступ.

Параметры

organisationId `string` (необязательно) ID организации для проверки ACL (обязательно)

Тело запроса

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

{}

Получение кешированной статистики журналов аудита из Redis (доступ через модуль IAM & Admin)

Получение агрегированной статистики из кеша Redis для мгновенной загрузки панели

Параметры

timeWindow `string` (необязательно) Временной интервал для статистики (по умолчанию 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"

{}

Получение статистики журналов аудита (доступ через модуль IAM & Admin)

Получение агрегированной статистики для панели. Ограничено организациями пользователя.

Параметры

startTime `number` (необязательно) Время начала (метка времени Unix), по умолчанию 24 часа назад endTime `number` (необязательно) Время окончания (метка времени Unix), по умолчанию текущее время

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"

{}

Получение данных временных рядов для журналов аудита (доступ через модуль IAM & Admin)

Получение сгруппированных по интервалам данных временных рядов для визуализации хронологии запросов

Параметры

timeWindow `string` (необязательно) Временной интервал для данных временных рядов: - 1h: последний 1 час (блоки по 10 минут) - 12h: последние 12 часов (блоки по 10 минут) - 24h: последние 24 часа (блоки по 10 минут) - 7d: последние 7 дней (блоки по 1 часу) - 14d: последние 14 дней (блоки по 1 часу)

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"

{}

Получение организаций, к журналам аудита которых у пользователя есть доступ (доступ через модуль IAM & Admin)

Возвращает список организаций, журналы аудита которых может просматривать текущий пользователь

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"

{}

Первоначальный вызов для создания нового клуба. Обратите внимание: создаётся только объект клуба-«шаблона», после чего требуется второй запрос API, чтобы дополнить клуб его данными, такими как часы работы, местоположение, ссылки на социальные сети и т. д.

Параметры

body `string` (обязательно) JSON-объект нового клуба для добавления в систему.

POST /api/admin/clubs/addclub

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

{}

Добавляет нового пользователя в систему

Параметры

body `string` (обязательно) JSON-объект с данными пользователя, которые нужно добавить или обновить.

POST /api/users

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

{}

Возвращает список всех пользователей (учётных записей Google Apps), имеющих доступ к внутренней системе или 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"

{}

Список ключей MCP пользователя (в скрытом виде). Пользователи могут просматривать список собственных ключей.

Параметры

userId `string` (обязательно)

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"

{}

Создание нового ключа MCP API для пользователя. Пользователи могут создавать собственные ключи.

Параметры

userId `string` (обязательно) body `object` (необязательно)

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"

Отзыв или удаление ключа MCP API. Пользователи могут удалять собственные ключи.

Параметры

userId `string` (обязательно) keyId `string` (обязательно)

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"

{}

Удаление роли у пользователя

Параметры

userId `string` (необязательно) Адрес электронной почты пользователя, у которого нужно удалить роль. roleId `string` (необязательно) ID роли, которую нужно удалить у пользователя.

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"

{}

Обновляет данные профиля существующего пользователя (firstName, lastName, phoneNumber)

Параметры

userId `string` (обязательно) Адрес электронной почты пользователя body `object` (обязательно) Данные профиля пользователя для обновления

PATCH /api/users/{userId}

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

{}

Создание или обновление роли пользователя

Параметры

body `object` (необязательно)

PUT /api/users/{userId}/roles

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

{}

Live Services, работающие на ИИ-агенте объекта (средство выбора для публикации)

Получает через туннель Live Services устройства, обнаруженные мостом, для средства выбора «Publish to Performance Hub» в апплете. Требуются модуль ph-ai-agent И доступ к устройству уровня 'open' (те же требования, что и для самой публикации). Каждый сервис помечается полем publishedAppId, если для его порта уже существует Custom App.

Параметры

club `string` (обязательно) device `string` (обязательно)

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"

{}

Индекс имён значков MDI, встроенный в ИИ-агент объекта (средство выбора значков)

Проксирует через туннель встроенный индекс значков MDI моста устройства (GET /__services/icons/mdi/index.json). Средство выбора при публикации и редактировании использует каталог, входящий в апплет (та же закреплённая версия 7.4.47); SVG опубликованных приложений берутся из локального пакета @mdi/js сервера портала. Требования к доступу те же, что и для средства выбора сервисов (модуль ph-ai-agent + доступ к устройству уровня 'open').

Параметры

club `string` (обязательно) device `string` (обязательно)

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"

{}

Получение пакета SVG-значков MDI с ИИ-агента объекта (предпросмотр в средстве выбора)

За один вызов получает до 60 именованных глифов MDI из встроенного набора значков устройства; на сервере они очищаются по тому же списку разрешённых элементов, что применяется к сохранённым значкам приложений. Используется средством выбора значков для отображения результатов поиска; для неизвестных имён возвращается null.

Параметры

club `string` (обязательно) device `string` (обязательно)

Тело запроса

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

{}

Области аудитории, для которых инициатор запроса может публиковать с этого объекта

Допустимые границы аудитории публикующего для средства выбора при публикации и редактировании: объекты, к которым дают доступ его роли ph-ai-agent (область из нескольких объектов), а также наличие у него полномочий уровня организации, необходимых для аудитории всего бренда или всей организации для бренда или организации этого объекта. Те же правила повторно применяются на сервере при публикации или обновлении (validatePublishAudience): эта конечная точка только формирует интерфейс.

Параметры

club `string` (обязательно)

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"

{}

Автозаполнение коллег для аудитории приложения из указанных пользователей

Ищет ТОЛЬКО среди пользователей, которых инициатор запроса уже видит, то есть людей, роли которых пересекаются хотя бы с одним объектом, регионом или организацией в собственном доступе ph-ai-agent инициатора. Минимальная длина запроса в 2 символа и ограничение в 10 результатов делают конечную точку бесполезной для сбора данных; тот же набор доступности повторно применяется на сервере при сохранении аудитории.

Параметры

club `string` (обязательно) q `string` (обязательно)

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"

{}

Публикация Live Service ИИ-агента как Custom App в Performance Hub

Регистрирует веб-приложение, размещённое на ИИ-агенте объекта (Live Service, обнаруженный мостом), как пункт бокового меню «Custom Apps» для выбранной аудитории. Требуются модуль ph-ai-agent на этом объекте И доступ к устройству уровня 'open'; аудитория ограничена областями собственных ролей публикующего (публиковать шире собственного доступа нельзя). Идентификация сервиса выполняется В РЕАЛЬНОМ ВРЕМЕНИ по списку /__services устройства; схема http/https никогда не сохраняется.

Параметры

club `string` (обязательно)

Тело запроса

POST /api/agent-apps/publish/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-apps/publish/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Опубликованные Custom Apps, видимые на этом объекте

Возвращает активные опубликованные приложения, аудитория которых охватывает этот объект, в формате, который отображает боковое меню (appId, name, icon, description). Аудитория заново определяется при каждом вызове, поэтому изменения доступа вступают в силу немедленно.

Параметры

club `string` (обязательно)

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"

{}

Опубликованные приложения, управляемые с этого объекта (представление публикующего)

Полные строки приложений, ДОМАШНИМ объектом которых является этот клуб, для списка управления «Published Apps» в апплете. Каждая строка помечается полем canManage для запрашивающего пользователя (публикующего).

Параметры

club `string` (обязательно)

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"

{}

Выпуск токена просмотра с областью сервиса для опубликованного Custom App

Возвращает кратковременный подписанный URL и токен, с помощью которых браузер открывает ОДНО опубликованное приложение напрямую через региональный ретрансляционный шлюз устройства. Токен содержит утверждение svc с портом сервиса, поэтому шлюз ограничивает сеанс путём /__services/proxy//: чат и терминал агента с этим токеном недоступны. Зрителям нужен модуль custom-apps на объекте, который охватывает аудитория приложения; модуль ph-ai-agent и доступ к агенту на устройстве им НЕ нужны.

Параметры

club `string` (обязательно) appId `string` (обязательно)

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"

{}

Ответственный за поддержку опубликованного Custom App (контакт владельца)

Кто поддерживает это приложение, опубликованное пользователем: адрес электронной почты публикующего (или, если его нет, владельца агента, на котором размещено приложение). Отображается на панелях офлайн-режима и ошибок у зрителя, чтобы запросы в поддержку направлялись владельцу приложения, а не в Performance Hub: опубликованные приложения не входят в основную поддержку Performance Hub. Сначала повторно проверяется аудитория приложения; зрители, которым приложение не было предоставлено, ничего не узнают. Для приостановленных приложений ответ тоже возвращается (владельцы отвечают и на вопросы «почему оно приостановлено?»).

Параметры

club `string` (обязательно) appId `string` (обязательно)

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"

{}

Отправка запроса в поддержку владельцу опубликованного Custom App по электронной почте

Отправляет сообщение зрителя контакту поддержки приложения (публикующему или, если его нет, владельцу агента) в виде фирменного письма: «Кому» — владелец, «Копия» — зритель (для учёта своего запроса), «Ответить» — зритель, чтобы владелец отвечал ему напрямую. Опубликованные приложения поддерживаются пользователями, поэтому такие запросы не попадают в очередь Performance Hub. Аудитория проверяется повторно; не более одного запроса от зрителя по одному приложению за 15 минут (период ожидания в Redis, при сбое запрос пропускается).

Параметры

club `string` (обязательно) appId `string` (обязательно)

Тело запроса

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

{}

Обновление опубликованного Custom App (название, значок, описание, статус, аудитория)

Только для публикующего. Изменения аудитории повторно проверяются по областям ролей РЕДАКТОРА с теми же ограничениями, что и при публикации. Статус переключается между active и paused (приостановленные приложения исчезают из меню, и выпуск токенов для них отклоняется).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Отмена публикации Custom App (мягкое удаление)

Только для публикующего. Выполняет мягкое удаление строки реестра: приложение сразу исчезает из меню, и выпуск токенов просмотра отклоняется; уже выданные сеансы шлюза завершаются по истечении срока действия токена.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Передача владения опубликованным Custom App

Работает так же, как смена владельца ИИ-агента: текущий публикующий или владелец учётной записи (модуль billing) может передать приложение другому пользователю, который затем управляет им. Новый владелец должен иметь доступ к объекту в домашнем клубе приложения.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Подготовленные экспорты навыков на ИИ-агенте объекта (средство выбора для обмена)

Проксирует через туннель список подготовленных экспортов моста устройства (GET /__skills/exports) для средства выбора «Share a skill» в апплете. Экспорты подготавливаются проверкой безопасности и переносимости ph-skill-sharing на устройстве; каждая запись содержит результат проверки на стороне устройства. Требуются модуль ph-ai-agent И доступ к устройству уровня 'open' (те же требования, что и для самой публикации).

Параметры

club `string` (обязательно) device `string` (обязательно)

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"

{}

Публикация подготовленного экспорта навыка как НОВОГО общего навыка (черновая версия)

Получает через туннель указанный архив подготовленного экспорта с моста устройства, распаковывает его в памяти (обход путей, символические ссылки и превышение размера отклоняются), выполняет детерминированную проверку безопасности в облаке, формирует манифест из frontmatter файла SKILL.md, сохраняет архив с адресацией по содержимому в закрытом бакете навыков и создаёт заголовок навыка и ЧЕРНОВУЮ версию. При блокировке по результатам проверки НИЧЕГО не сохраняется, а возвращаются найденные проблемы. Аудитория ограничена областями собственных ролей публикующего. Чтобы опубликовать черновик, отправьте его (POST submit).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Публикация подготовленного экспорта как НОВОЙ ВЕРСИИ существующего общего навыка

Тот же конвейер, что и при публикации, но для существующего навыка: имя в SKILL.md экспорта должно совпадать с навыком, версия должна быть новой (версии неизменяемы), и требуется журнал изменений. Добавлять версии может только публикующий. При блокировке по результатам проверки сохраняется строка версии со статусом 'rejected' (только отчёт, без артефакта), чтобы найденные проблемы отображались в истории публикующего.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Полный отчёт о проверке (+ проверка LLM) для одной версии навыка

Полный список найденных проблем для версии: только для публикующего и администраторов организации (при рассмотрении на утверждение); устанавливающие пользователи вместо этого видят сводные показатели в сведениях о навыке.

Параметры

club `string` (обязательно) skillId `string` (обязательно) version `string` (обязательно)

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"

{}

Отправка черновой версии навыка (публикация или постановка в очередь на утверждение)

Продвигает черновую версию дальше в соответствии с правилами управления организации. Если организация включила проверку LLM, сначала выполняется проверка инструкций (по возможности; вердикт 'fail' отклоняет версию, вердикт 'flag' принудительно отправляет её в очередь на утверждение). Публикации уровня объекта публикуются сразу, если правила управления не требуют утверждения; публикации в библиотеке организации (аудитория бренда или организации) по умолчанию требуют утверждения. Публикация задаёт latestVersion навыка: установки с политикой 'auto' получают её при следующем цикле согласования.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Снятие общего навыка с публикации (удаляет его из библиотеки)

Только для публикующего. Навык сразу исчезает из библиотеки, и новые установки отклоняются; СУЩЕСТВУЮЩИЕ установки продолжают работать: снятие с публикации влияет только на список и не является аварийным отключением.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Изменение карточки общего навыка (отображаемое имя, описание, значок)

Только для публикующего. Поля только для отображения: каноническое имя навыка является его идентификатором (манифесты, каталоги установки, сопоставление версий) и никогда не меняется. Пустая строка сбрасывает поле в null (используется каноническое имя или значок отсутствует). Значки берутся из каталога MDI (mdi:icon-name) в том же формате, что и у опубликованных приложений агентов.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Передача владения общим навыком

Работает так же, как передача опубликованных приложений: текущий публикующий или владелец учётной записи (модуль billing) может передать навык другому пользователю, который затем управляет его версиями и карточкой. Новый владелец должен иметь доступ к объекту в домашнем клубе навыка.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Библиотека навыков, видимая на этом объекте (с фильтром по аудитории)

Активные навыки, у которых есть хотя бы одна опубликованная версия, аудитория которой охватывает этот объект (или включает зрителя), со сводкой последней опубликованной версии и степенью распространения в организации (число разных объектов, а не общее число установок). Аудитория заново определяется при каждом вызове.

Параметры

club `string` (обязательно)

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"

{}

Сведения о навыке (версии, требования, сводка проверки, распространение)

Полные сведения об одном навыке библиотеки: история версий с журналами изменений и сводками проверок (списки конечных точек по версиям используются для сравнения проверок при обновлении), заявленные в манифесте требования, сведения о публикующем и показатель распространения по числу объектов. Аудитория проверяется повторно: зрители, которым навык не был предоставлен, ничего не узнают (публикующий и администраторы организации видят его всегда).

Параметры

club `string` (обязательно) skillId `string` (обязательно)

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"

{}

Навыки, опубликованные с этого объекта (список управления публикующего)

Полные строки навыков, ДОМАШНИМ объектом которых является этот клуб, каждая с полем canManage для запрашивающего пользователя и сводкой последней версии (включая черновики и версии, ожидающие утверждения: это рабочее представление публикующего).

Параметры

club `string` (обязательно)

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"

{}

Установка навыка из библиотеки на ИИ-агент объекта

Зависит от правил управления: installSources организации должен это разрешать, аудитория навыка должна охватывать этот объект (или включать инициатора запроса), версия должна быть опубликована, а инициатор запроса должен соответствовать уровню whoCanInstall для целевого устройства (владелец / разрешённый пользователь / администратор объекта / администратор организации; см. правила управления). Записывает строку жизненного цикла установки (источник истины) и сразу выполняет отправку по возможности; задание согласования по расписанию гарантирует доставку, как только устройство станет доступно.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Утверждение ожидающего обновления навыка для одной установки

Переводит desiredVersion установки на последнюю опубликованную версию (ручной шаг для политик 'notify' и 'pinned', а также путь, когда правила управления задают updatePosture 'approvalRequired'). Сохраняет текущую версию как цель для отката на один шаг и снимает закрепление обновлений после отката (skipVersion). Тот же уровень разрешений whoCanInstall, что и для установки.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Откат установленного навыка к предыдущей версии

Устанавливает desiredVersion равным previousVersion из строки установки (сохраняется при каждой смене версии), после чего обычный путь доставки переустанавливает навык. Откат на один шаг: версии меняются местами, поэтому двойной откат возвращает к исходному состоянию. Также закрепляет обновления (skipVersion = версия, с которой выполнен откат), чтобы политики auto/notify не отменяли откат; закрепление снимается при публикации строго более новой версии, при update-approve или при set-policy.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Удаление навыка с ИИ-агента объекта

Помечает строку установки как pending-uninstall и отправляет требуемое состояние; строка удаляется, когда устройство подтвердит удаление (обратное чтение при согласовании). Тот же уровень разрешений whoCanInstall, что и для установки.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Настройка политики обновления навыка для отдельной установки на одном устройстве

auto (согласование применяет новые опубликованные версии автоматически, если updatePosture организации не требует утверждения), notify (владелец получает одно уведомление о каждой новой версии и применяет её вручную) или pinned (версия не меняется без явного update-approve). Изменение политики снимает закрепление обновлений после отката (skipVersion). Тот же уровень разрешений whoCanInstall, что и для установки.

Параметры

club `string` (обязательно)

Тело запроса

POST /api/agent-skills/set-policy/{club}

curl -X POST https://portal.hub.gymsystems.co/api/agent-skills/set-policy/{club} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Установки навыков на ИИ-агенте объекта (вкладка Skills)

Строки жизненного цикла установок для одного устройства, каждая с полями карточки навыка и признаком наличия более новой опубликованной версии. Требуется доступ к устройству уровня 'open' (вкладка Skills находится в выдвижной панели агента).

Параметры

club `string` (обязательно) device `string` (обязательно)

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"

{}

Версии навыков, ожидающие утверждения в организации этого объекта

Очередь утверждения администратора организации: все версии навыков организации, ожидающие утверждения, с карточкой навыка и сводками проверки и LLM. Только для администраторов организации.

Параметры

club `string` (обязательно)

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"

{}

Утверждение ожидающей версии навыка (публикует её)

Только для администраторов организации. Версия публикуется, latestVersion навыка обновляется, а публикующий получает уведомление. Установки с политикой 'auto' получают версию при следующем цикле согласования.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Отклонение ожидающей версии навыка

Только для администраторов организации. Версия отклоняется с указанием причины проверяющего, а публикующий получает уведомление: он может устранить найденные проблемы и отправить новую версию (версии неизменяемы).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Действующие правила управления навыками агентов для организации этого объекта

Сохранённая политика организации, наложенная на значения платформы по умолчанию (организация без сохранённой строки видит только значения по умолчанию). Только для администраторов организации.

Параметры

club `string` (обязательно)

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"

{}

Обновление правил управления навыками агентов для организации этого объекта

Частичное обновление: меняются только переданные поля, остальные сохраняют сохранённые значения или значения по умолчанию. Только для администраторов организации. Переопределения для отдельных устройств хранятся в строке регистрации и задаются через существующие маршруты настройки устройств.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Получение данных об окружающей среде для объекта

Возвращает текущие погодные условия, включая время восхода и заката (через Open-Meteo), и температуру в помещении объекта (с датчиков Duress) для указанного клуба. Кешируется в Redis на 30 минут.

Параметры

clubId `string` (обязательно) Внутренний ID клуба или объекта

GET /api/clubs/{clubId}/environment

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

{}

Добавляет универсальное IoT-устройство и привязывает его к клубу.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство. body `string` (обязательно) JSON-объект нового экрана для привязки.

POST /api/devices/addGenericDevice/{club}

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

{}

Удаление экрана и сброс к заводским настройкам

Удаляет активную привязку экрана к объекту и назначает устойчивый сброс к заводским настройкам. Выключенный экран выполнит сброс после следующего включения и повторного подключения, а затем вернётся на страницу сопряжения HDMI. Исторические записи о выставлении счетов сохраняются.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Привязывает контроллер двери к объекту.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Обновляет настройки контроллера двери для объекта.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Выводит контроллер двери объекта из эксплуатации.

Параметры

club `string` (обязательно)

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"

{}

Возвращает конфигурацию реле контроллера двери.

Параметры

uuid `string` (обязательно)

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"

{}

Возвращает метаданные устройства

Параметры

uuid `string` (обязательно) Уникальный ID устройства

GET /api/devices/metadata/{uuid}

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

{}

Возвращает метаданные устройства. Ответ содержит строку метаданных на верхнем уровне (устаревший формат), а также `detectedType` (camera | ai-edge-processor | door-controller | ph-ai-agent | null) и `online` (true, если данные обновлялись в течение последних 5 минут).

Параметры

deviceSerialNumber `string` (обязательно) Серийный номер устройства

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"

{}

Возвращает данные Smart Club для клуба.

Параметры

club_id `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство.

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"

{}

Возвращает все устройства, привязанные к отдельному клубу.

Параметры

club `string` (обязательно) Внутренний ID клуба, для которого нужно получить список устройств.

GET /api/devices/list/{club}

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

{}

Возвращает все выпуски (версии) приложений для наших устройств balena.

GET /api/devices/listReleases

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

{}

Перемещает устройство на новый объект (клуб) и обновляет связанные системы.

Параметры

club `string` (обязательно) ID исходного объекта (текущий клуб, в котором находится устройство) body `object` (обязательно) Параметры перемещения

POST /api/devices/move/{club}

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

{}

Пытается установить подключение к маршрутизатору объекта, выбирая наиболее подходящее устройство в клубе и отправляя команду MQTT для создания туннеля.

Параметры

facilityID `string` (обязательно) Внутренний ID объекта, к маршрутизатору которого выполняется попытка подключения.

GET /api/devices/openRouterWebpage/{facilityID}

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

{}

Каталог Cloud Agent (зоны, размеры, текущие цены продажи)

Параметры

club `string` (обязательно)

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"

{}

Расчёт стоимости Cloud Agent (программное обеспечение + хостинг)

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"

Запуск Cloud Agent (постановка подготовки в очередь + автоматическая привязка)

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"

Статус задания 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"

Полное удаление Cloud Agent (ВМ + balena + регистрация)

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"

Решение по отложенному удалению Cloud Agent (повторить резервное копирование, удалить без резервной копии или отменить)

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"

Список Connected Apps агента (наборы и приложения с подключёнными учётными записями)

Возвращает состояние Connected Apps агента: флаг включения, сводки по наборам (Google Workspace, Microsoft 365) и отобранный каталог приложений с подключёнными учётными записями каждого приложения (несколько учётных записей: агент может иметь несколько учётных записей в одном приложении, каждую с необязательным псевдонимом), полученными из вышестоящего сеанса агента.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

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"

{}

Полный каталог магазина Connected Apps для агента

Возвращает все приложения, доступные для подключения (полный каталог наборов инструментов с управляемой аутентификацией, кешируется на сервере примерно на 12 часов), с уровнями «рекомендуемые» и «набор», подключёнными учётными записями агента по каждому приложению, а также сводками по наборам и ожидающими запросами агента на подключение: один ответ для магазина приложений с поиском на стороне клиента.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

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"

{}

Отклонение ожидающего запроса агента на подключение

Помечает ожидающий запрос агента на подключение набора инструментов как отклонённый (он исчезает из раздела магазина "Requested by your agent"). Идемпотентно: отклонение запроса, который не ожидает обработки, ничего не делает.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Включение или отключение Connected Apps для агента

Сохраняет переключатель Connected Apps агента и отправляет переменную устройства Balena PH_APPS_MCP_ENABLED на это устройство (по возможности: строгим ограничением для ретрансляции MCP служит флаг на стороне Performance Hub).

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Начало подключения одного приложения к агенту (процесс OAuth Connect Link)

Запускает размещённый процесс Connect Link для одного набора инструментов и возвращает URL, на который нужно направить пользователя. Необязательный псевдоним обозначает новую учётную запись (несколько учётных записей: повторное подключение уже подключённого приложения добавляет ЕЩЁ ОДНУ учётную запись, не более 10 на приложение). Выполняется через тот же цепочечный обратный вызов, что и подключение наборов (набор из одного инструмента), поэтому по завершении пользователь возвращается на страницу апплета ph-ai-agent.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Данные для подготовки подключения одного приложения (режим, поля учётных данных, руководство по настройке)

Всё, что нужно диалоговому окну подключения перед началом подключения: способ подключения приложения (oauth = размещённый процесс согласия, credentials = форма в продукте), поля учётных данных для режима credentials и руководство по настройке в продукте (написанное вручную для приоритетных приложений, в остальных случаях сгенерированное по метаданным полей приложения; никогда не ссылка на внешнюю документацию). Для приложений с собственным OAuth также указывается, зарегистрировано ли уже OAuth-приложение клиента для ЭТОГО агента (byoConfigured), и URL перенаправления для регистрации у поставщика.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента. toolkit `string` (обязательно)

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"

{}

Подключение приложения с учётными данными пользователя (ключ API и т. д., без OAuth)

Создаёт подключённую учётную запись для приложения в режиме credentials прямо из формы в продукте, без размещённого процесса согласия. Поля учётных данных берутся из ответа connect-info приложения; все обязательные поля должны быть заполнены. Учётные данные проверяются у поставщика, если это поддерживается (по возможности: некоторые приложения отклоняют неверный ключ только при первом вызове инструмента агентом). Необязательный псевдоним обозначает новую учётную запись (несколько учётных записей: повторное подключение уже подключённого приложения добавляет ЕЩЁ ОДНУ учётную запись).

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Регистрация собственного OAuth-приложения клиента для приложения BYO и запуск процесса подключения

Для приложений с собственным OAuth (Xero, Shopify, ...): принимает ID клиента и секрет клиента OAuth-приложения, созданного клиентом у поставщика (по шагам руководства по настройке приложения), регистрирует его для ЭТОГО агента (секрет хранится только на вышестоящей платформе интеграции, но никогда не в Performance Hub) и сразу запускает размещённый процесс входа с ним. Возвращает URL согласия, на который нужно направить пользователя, по тому же контракту, что и конечная точка подключения. Повторная отправка заменяет зарегистрированное приложение агента (например, после смены секрета); существующие подключённые учётные записи продолжают работать.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Запуск подключения набора одним щелчком для агента (цепочка процессов Connect Link)

Запускает цепочку подключения для целого набора (например, google-workspace). Возвращённый URL открывает экран согласия первого набора инструментов; после каждого завершения выполняется перенаправление 302 сразу в процесс следующего набора инструментов, а в конце — на страницу апплета ph-ai-agent. Элементы, у которых уже есть подключённая учётная запись, ПРОПУСКАЮТСЯ, поэтому повтор после сбоя в середине цепочки продолжается с недостающих приложений, не создавая дублирующих учётных записей. Если все элементы уже подключены, вся цепочка выполняется заново: это явный процесс "add another account".

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Отключение одной подключённой учётной записи от агента

Удаляет одну подключённую учётную запись (несколько учётных записей: другие учётные записи того же приложения остаются подключёнными). Перед удалением проверяется, что учётная запись принадлежит этому агенту; если это была ПОСЛЕДНЯЯ учётная запись приложения, набор инструментов удаляется из подключённых у агента (сеанс отложенно создаётся заново, чтобы обновился список инструментов агента).

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Переименование (смена псевдонима) одной из подключённых учётных записей агента

Задаёт отображаемый псевдоним одной подключённой учётной записи. Обычно псевдонимы задаются автоматически после OAuth (по удостоверению вошедшего пользователя); эта конечная точка обеспечивает ручное переименование в диалоговом окне сведений о приложении. Пустой псевдоним очищает метку. Перед вышестоящим обновлением проверяется, что учётная запись принадлежит этому агенту.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента.

Тело запроса

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

{}

Включение или отключение встроенного сервиса Performance Hub для агента

Включает или отключает для этого агента один постоянно доступный встроенный сервис (Smart Search, Weather, ...). Встроенным сервисам не нужны подключение или OAuth: они входят в состав каждого агента и включены по умолчанию; этот переключатель сохраняет переопределение для агента и сразу заново создаёт вышестоящий сеанс агента, чтобы обновился набор инструментов. Обратите внимание, что отдельный переключатель "External apps" (маршрут /enable) полностью отключает весь MCP-сервер приложений: когда он выключен, встроенные сервисы тоже недоступны независимо от их собственных переключателей.

Параметры

facilityId `string` (обязательно) deviceId `string` (обязательно) UUID balena устройства агента. slug `string` (обязательно) Slug встроенного сервиса.

Тело запроса

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

{}

Привязка устройства ИИ-агента к объекту

Привязка в первую очередь по метаданным. Находит устройство по серийному номеру в текущих метаданных устройств, требует, чтобы оно было онлайн, затем отложенно создаёт строку регистрации, назначает регион ретрансляции Chisel, порт туннеля и секрет, регистрирует этот слот на ретрансляторе и отправляет на устройство конфигурацию объекта и туннеля через Balena. Новым устройствам также назначается сервисная учётная запись MCP по умолчанию (включена, ограничена этим объектом, все возможности); при повторном сопряжении существующее разрешение MCP сохраняется. Необязательные расширенные настройки переопределяют значения по умолчанию при сопряжении (конфигурация резервного копирования, включение или отключение MCP, ограничение доступа), а `restoreFrom` заполняет новое устройство из облачной резервной копии другого устройства объекта (активного или выведенного из эксплуатации; ставит в очередь восстановление между репозиториями, которое возвращается как `restoreRequest` для отслеживания хода выполнения).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Список устройств ИИ-агентов объекта

Возвращает устройства ИИ-агентов объекта с текущим статусом подключения и туннеля (используется переключателем устройств в апплете).

Параметры

club `string` (обязательно)

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"

{}

Обновление и сетевой статус ИИ-агента

Возвращает, находится ли устройство онлайн, доступно ли или ожидает ли обновление, и предлагаемый выпуск (закреплённый для парка, если парк закреплён; последний успешный, если парк отслеживает последнюю версию).

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Текущий статус и метрики устройства ИИ-агента

Возвращает подготовленный снимок для полосы метрик и панели управления апплета: поля идентификации и регистрации, активность и подключение, версии ПО и последние метрики сигнала активности (ЦП, температура, память, хранилище по точкам монтирования, время работы, сеть). Объединяет маяк метаданных устройства и статус обновления Balena; при временном сбое любая из частей может отсутствовать.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

ИИ-описание для отчёта о состоянии устройства

Возвращает краткое пояснение для оператора о текущих выявленных проблемах с состоянием. Факты и шаги из сценария действий всегда есть в device-status; этот дополнительный абзац формируется по возможности и может быть null.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Выпуск токена прямого доступа к ретранслятору для ИИ-агента

Возвращает кратковременный подписанный URL, с помощью которого браузер подключается НАПРЯМУЮ к региональному ретрансляционному шлюзу устройства (минуя глобальный узел Performance Hub в Сиднее), а также токен HS256. Полномочия остаются за Performance Hub (здесь выполняются Google SSO и проверки модуля и объекта); ретрансляционный шлюз проверяет токен. Прокси /ai-agent-ui остаётся резервным вариантом.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Отправка сообщения чата в сеанс ИИ-агента (быстрый ответ из уведомления)

Серверная ретрансляция для действия быстрого ответа в веб-push-уведомлении: service worker отправляет сюда POST-запрос (тот же источник, файлы cookie SSO), поэтому ответ работает без открытой вкладки Performance Hub. Performance Hub определяет цель ретрансляции устройства (так же, как прокси /ai-agent-ui), проставляет x-ph-user для атрибуции хода (итоговое push-уведомление о завершении возвращается этому пользователю) и пересылает запрос на /api/chat/start устройства с id сеанса.

Тело запроса

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

{}

Чтение настроек управления доступом ИИ-агента (владелец)

Возвращает блок доступа устройства (режим, список разрешённых, видимость, переключатель поддержки Performance Hub), а также ожидающие запросы на доступ. Доступно для чтения владельцу устройства; другие пользователи получают 403.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Обновление настроек управления доступом ИИ-агента (владелец)

Запись режима (org/restricted), списка разрешённых для ограниченного режима, видимости списка (all/admins) и переключателя "permit access from Performance Hub Support". Разрешено владельцу устройства. Самого владельца можно сменить только через reallocate-owner. Одобренные запросы на доступ сохраняются: всё ещё одобренные инициаторы запросов снова добавляются в сохранённый список разрешённых; удаление одного из них из отправленного списка отзывает его одобрение (запрос переходит в статус denied, и он может запросить доступ снова).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Смена владельца ИИ-агента

Передаёт владение устройством другому пользователю Performance Hub. Доступно только владельцам учётной записи (доступ к модулю оплаты SaaS): это запасной вариант на случай ухода владельца агента с ограниченным доступом. Уведомления получают и прежний, и новый владелец (в приложении, push-уведомлением и по электронной почте).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Список пользователей объекта для выбора разрешённых пользователей и владельца ИИ-агента

Возвращает адрес электронной почты и имя (+ флаги isOrgAdmin) каждого пользователя, роль которого даёт доступ к ЭТОМУ объекту. Доступно только владельцу устройства и тем, кто может менять владельца (владельцу учётной записи), чтобы обычные пользователи не могли перечислить базу пользователей.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Запрос доступа к ИИ-агенту с ограниченным доступом

Создаёт (или повторно открывает) запрос инициатора на доступ к устройству с ограниченным доступом; идемпотентно для сочетания пользователь+устройство. Владелец получает уведомление в приложении, веб-push-уведомлением и по электронной почте с прямой ссылкой на модуль агента.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Одобрение или отклонение запроса на доступ к ИИ-агенту (владелец)

Рассмотрение ожидающего запроса владельцем устройства. При одобрении инициатор запроса добавляется в список разрешённых устройства; при любом решении инициатор получает уведомление (в приложении, push-уведомлением и по электронной почте).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Разрешение и применение обновления ИИ-агента

Закрепляет на устройстве предлагаемый выпуск (закреплённый для парка или последний успешный, если парк отслеживает последнюю версию) и снимает блокировку обновлений, чтобы супервизор balena применил его. Состояние на томе данных устройства сохраняется после обновления.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Планирование обновления ИИ-агента на более позднее время

Сохраняет запланированное время установки в регистрации устройства. Периодическое серверное задание (каждые 5 минут) применяет обновление (закрепление + разблокировка), когда наступает запланированное время. Новое планирование заменяет существующее расписание устройства.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Отмена запланированного обновления ИИ-агента

Удаляет ожидающую запланированную установку для устройства (ничего не делает, если ничего не запланировано).

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Выполнение удалённой команды на устройстве ИИ-агента

Публикует разрешённую команду MQTT (перезагрузка, перезапуск контейнера, блокировка или разблокировка обновлений, управление Wi-Fi) для device-controller, работающего на ИИ-агенте. Устройство должно быть привязано к объекту.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Обновление конфигурации ИИ-агента, относящейся к объекту

Сохраняет настройки связанного ИИ-агента, которые может изменять оператор: имя устройства, его физическое расположение и периодичность плановой перезагрузки. Расписание перезагрузки также передаётся на устройство в переменной среды Balena REBOOT_DEVICE (2:00 по местному времени), как и для Display Screens.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Объекты, на которые можно переместить ИИ-агент с этого объекта

Возвращает объекты той же организации, к которым у вошедшего пользователя есть доступ (кроме текущего объекта), для списка выбора «Переместить на другой объект». Само перемещение выполняет POST /api/devices/move/:club, который на стороне сервера применяет те же правила: та же организация и доступ к целевому объекту.

Параметры

club `string` (обязательно)

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"

{}

Допустимые для выдачи права доступа MCP запрашивающего пользователя для ИИ-агентов объекта

Возвращает, что вошедший пользователь может выдать сервисной учётной записи MCP ИИ-агента в организации этого объекта: объекты и регионы в пределах его собственного доступа, может ли он выдавать область на уровне всей организации, набор модулей, которыми он располагает, и полный каталог инструментов MCP (для расширенной маски по инструментам). Интерфейс использует эти данные, чтобы пользователи видели только варианты в пределах своих прав; эндпоинт POST mcp-access применяет то же ограничение на стороне сервера.

Параметры

club `string` (обязательно)

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"

{}

Получить конфигурацию сервисной учётной записи MCP ИИ-агента

Возвращает конфигурацию доступа MCP устройства (область, модули, маска инструментов, поля аудита).

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Настроить сервисную учётную запись MCP ИИ-агента

Сохраняет конфигурацию доступа MCP устройства с ограничением прав в момент выдачи. Запрашивающий может выдать только объекты и регионы в пределах своего доступа, область организации — только при наличии роли на уровне всей организации, а модули — только те, которыми он сам располагает в организации объекта. Флаг включения также передаётся на устройство в переменной среды Balena PH_MCP_ENABLED.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Получить конфигурацию VPN ИИ-агента (со скрытыми данными)

Возвращает флаг поддержки VPN устройства и список подключений. Содержимое профилей и значения учётных данных никогда не возвращаются — только метаданные, полученные при импорте (удалённые узлы, маршруты, DNS), и флаги наличия учётных данных. Текущее состояние каждого подключения возвращает эндпоинт состояния устройства (beacon metadata.vpn).

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Включить или выключить поддержку VPN ИИ-агента

Включает или выключает функцию VPN устройства. Передаёт переменную устройства balena PH_VPN_ENABLED и уведомляет устройство (MQTT vpnConfigChanged); при выключении подключения сохраняются (туннели останавливаются, конфигурация остаётся для повторного включения).

Параметры

club `string` (обязательно) uuid `string` (обязательно)

Тело запроса

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

{}

Импортировать профили OpenVPN на ИИ-агент

Принимает загрузки в кодировке base64: отдельные файлы .ovpn/.conf, наборы из нескольких файлов (конфигурация + сертификаты/ключи) и архивы (.zip, экспорт Pritunl в .tar/.tgz, .tblk Tunnelblick, .visc/.visz Viscosity). Профили приводятся к каноническому встроенному виду; каждый профиль становится одним подключением (импортируется в отключённом состоянии — введите учётные данные, затем подключитесь). Для непригодных загрузок возвращаются ошибки 400 с описанием, что исправить.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

Тело запроса

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

{}

Обновить VPN-подключение ИИ-агента (имя / учётные данные / split-DNS)

Обновляет сохранённое подключение. Поля учётных данных доступны только для записи (не указано — сохранить текущее значение; пустая строка — очистить). Изменение учётных данных или split-DNS увеличивает ревизию подключения, поэтому активный туннель перезапускается с новыми значениями.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

Тело запроса

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

{}

Удалить VPN-подключение ИИ-агента

Удаляет подключение из регистрации и уведомляет устройство, которое закрывает туннель и удаляет кэшированный профиль и учётные данные.

Параметры

club `string` (обязательно) uuid `string` (обязательно) connectionId `string` (обязательно)

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"

{}

Подключить или отключить VPN-подключение ИИ-агента

Модель желаемого состояния: устанавливает флаг включения подключения в регистрации и уведомляет устройство (MQTT vpnConfigChanged без полезной нагрузки); устройство получает актуальное состояние через вызов universal-api с аутентификацией JWT и согласует свои туннели. Если уведомление не дошло, состояние выравнивается при периодической синхронизации.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

Тело запроса

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

{}

Получить конфигурацию и состояние облачного резервного копирования ИИ-агента

Возвращает настройки резервного копирования устройства (включено, срок хранения, регион хранилища), текущее состояние резервного копирования (последняя копия, размер, ошибки), автоматически выбранный регион и доступные регионы хранилища для списка выбора. Пароль репозитория restic никогда не возвращается.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Обновить конфигурацию облачного резервного копирования ИИ-агента

Сохраняет включение, срок хранения и регион. Изменения вступают в силу при следующем ежечасном резервном копировании (перед каждым запуском устройство запрашивает у PH контекст запуска), поэтому перезапуск устройства не требуется.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Список источников восстановления из резервной копии для подключения нового ИИ-агента

Представление на уровне объекта для варианта «восстановить из резервной копии» в диалоге добавления агента: все регистрации на объекте — активные И выведенные из эксплуатации или замененные, — у которых ещё есть расшифровываемый репозиторий резервных копий и хотя бы одна пригодная точка восстановления, с их последними снимками. Также возвращает списки вариантов конфигурации резервного копирования (allowedRetentionDays, availableRegions), чтобы диалогу не требовался UUID устройства для заполнения списков.

Параметры

club `string` (обязательно)

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"

{}

Список точек восстановления ИИ-агента

Возвращает индекс снимков устройства (сначала новые) из DynamoDB — без обращения к устройству или репозиторию — а также текущее состояние запроса ручного резервного копирования или восстановления для опроса в боковой панели. Устаревшие запросы (так и не принятые или без сигнала о ходе выполнения) отображаются как неудачные, чтобы в интерфейсе всегда можно было отправить новый.

Параметры

club `string` (обязательно) uuid `string` (обязательно)

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"

{}

Запросить ручное резервное копирование ИИ-агента сейчас

Записывает запрос на ручной запуск (с примечанием пользователя) в строку регистрации и уведомляет устройство через MQTT. Устройство получает проверенный запрос через вызов run-context universal-api с аутентификацией JWT — даже без MQTT запрос будет принят при следующем срабатывании планировщика. Отклоняется, пока выполняется другое резервное копирование или восстановление.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Закрепить или открепить точку восстановления ИИ-агента

Закреплённые точки восстановления защищены от удаления по сроку хранения — при ночном обслуживании устройство получает идентификаторы закреплённых снимков через вызов run-context и исключает их из restic forget, — а их строки индекса никогда не удаляются по TTL. Открепление возвращает обычное поведение срока хранения.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Восстановить ИИ-агент из точки восстановления

Записывает запрос на восстановление в строку регистрации и уведомляет устройство. Полное восстановление перезаписывает /data и /home/hermeswebui (устройство сначала автоматически создаёт страховочный снимок и останавливает агента на время восстановления) и требует ввести имя устройства для подтверждения. Если передать `paths`, вместо этого выполняется восстановление только указанных путей на уровне файлов без прерывания работы. При необходимости после восстановления данных устройство закрепляется на выпуске ПО из снимка (см. backup-restore-release).

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Применить выпуск ПО, записанный при завершённом восстановлении

Последний шаг восстановления, для которого была запрошена версия ПО из снимка: когда устройство сообщает о завершении восстановления данных, устройство закрепляется на сохранённом выпуске и обновления разблокируются (тот же механизм, что и у эндпоинта обновления). Запускается опросом из боковой панели; идемпотентен — сохранённое закрепление очищается после применения.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Просмотр файлов в точке восстановления

Выводит один уровень каталога снимка restic; полностью обслуживается на стороне сервера из репозитория Wasabi (работает, даже если устройство не в сети). Читаются только метаданные дерева — для списков данные файлов не загружаются.

Параметры

club `string` (обязательно) uuid `string` (обязательно) takenAt `number` (обязательно) path `string` (необязательно)

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"

{}

Поиск по именам файлов в точке восстановления

Поиск по имени файла без учёта регистра от указанного каталога вниз, выполняется на стороне сервера по метаданным дерева restic (данные файлов не читаются; работает, даже если устройство не в сети). Список передаётся потоком и останавливается на первых 200 совпадениях.

Параметры

club `string` (обязательно) uuid `string` (обязательно) takenAt `number` (обязательно) q `string` (обязательно) path `string` (необязательно)

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"

{}

Что изменилось между двумя точками восстановления

Выполняет на стороне сервера restic diff между двумя снимками устройства (только метаданные дерева) и возвращает список добавленных, удалённых и изменённых файлов (не более 500 изменений) со сводной статистикой. Результаты кэшируются — снимки неизменяемы.

Параметры

club `string` (обязательно) uuid `string` (обязательно) fromTakenAt `number` (обязательно) toTakenAt `number` (обязательно)

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"

{}

История версий одного файла во всех точках восстановления

Один запуск restic find на стороне сервера по всем снимкам в репозитории устройства, сведённый к РАЗЛИЧНЫМ версиям (последовательные совпадения с одинаковыми size+mtime объединяются) и связанный со строками индекса снимков для дат, типов и примечаний.

Параметры

club `string` (обязательно) uuid `string` (обязательно) path `string` (обязательно)

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"

{}

Поиск по имени файла во всех точках восстановления резервных копий устройства

Способ восстановить удалённый файл: один запуск restic find на стороне сервера по ВСЕМ снимкам в репозитории (без учёта регистра, по подстроке или шаблону glob) с группировкой по пути и списком точек восстановления, в которых есть каждый файл. Файл, удалённый с устройства, можно найти здесь, пока он есть хотя бы в одной точке восстановления.

Параметры

club `string` (обязательно) uuid `string` (обязательно) q `string` (обязательно)

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"

{}

Скачать один файл из точки восстановления

Передаёт один файл потоком прямо из репозитория restic в браузер (как вложение). Каталоги передаются как архив tar. Размер ограничен; обслуживается на стороне сервера, поэтому работает, даже если устройство не в сети.

Параметры

club `string` (обязательно) uuid `string` (обязательно) takenAt `number` (обязательно) path `string` (обязательно)

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"

{}

Вывести ИИ-агент из эксплуатации на объекте

Параметры

club `string` (обязательно)

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"

{}

Удалить ИИ-агент с объекта и сбросить оборудование к заводским настройкам

Полностью отвязывает устройство, чтобы его можно было подключить на ЛЮБОМ объекте, и стирает все данные на NUC. Стирание назначается через переменную устройства balena PH_FACTORY_RESET (одноразовый nonce) ДО удаления облачных ресурсов, поэтому оно сработает, даже если устройство не в сети в момент удаления, — стирание выполнится при следующем подключении. Если устройство в сети, уведомление MQTT factoryReset запускает его сразу. Затем при удалении облачных ресурсов отзываются все учётные данные и права, удаляется привязка Balena к объекту (переменные устройства + тег club) и clubID в метаданных, удаляются запросы на доступ и запись LAN DNS. Облачные резервные копии СОХРАНЯЮТСЯ: индекс снимков и пароль репозитория остаются в мягко удалённой регистрации и могут служить источником восстановления при добавлении замены. Требуется ввести имя устройства для подтверждения.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Заменить неисправный ИИ-агент новым NUC (аварийное восстановление)

Замена устройства за один шаг: связывает новый NUC (слот туннеля, секреты, переменные balena, начальные данные резервного копирования), переносит имя, расположение, расписание перезагрузки, настройки резервного копирования, блокировку доступа и права MCP старого устройства, переназначает индекс старых снимков на новое устройство (чтобы вся история резервных копий оставалась доступной для просмотра), выводит из эксплуатации старую регистрацию (с отметками replacedBy / replacedFrom) и — если `restore` не равно false — ставит в очередь полное восстановление выбранной точки восстановления из репозитория СТАРОГО устройства на новое оборудование. Работает, даже если старое устройство неисправно или не в сети; требуется ввести имя старого устройства для подтверждения. Только в пределах одного объекта.

Параметры

club `string` (обязательно)

Тело запроса

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

{}

Преобразует короткую ссылку QR-кода устройства Performance Hub в глубокую ссылку, на которую она указывает, чтобы сканер «Добавить устройство» мог определить тип устройства. Переход выполняется только по хостам performancehub.co.

Параметры

url `string` (обязательно) Отсканированная короткая ссылка

GET /api/devices/resolve-qr

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

{}

Проверяет подключение к контроллеру Unifi объекта и правильность учётных данных.

Параметры

facilityID `string` (обязательно) Внутренний идентификатор объекта, для которого нужно проверить подключение к 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"

{}

Обновляет универсальное IoT-устройство на объекте.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

PUT /api/devices/updateGenericDevice/{club}

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

{}

Возвращает число невыполненных соглашений, требующих действий, для пользователя и связанных с ним клубов

GET /api/agreements/agreements-outstanding

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

{}

Возвращает список всех соглашений, доступных клубу

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. contracts-sort `string` (необязательно) Сортировка соглашений по date-effective или alphabetical. По умолчанию date-effective. contracts-acknowledgement `string` (необязательно) Фильтрация соглашений по all, acknowledged или unacknowledged. По умолчанию all. contracts-requirement `string` (необязательно) Фильтрация соглашений по all, signature, checkbox, popup или none. По умолчанию all. contracts-status `string` (необязательно) Фильтрация соглашений по all, active или archived. По умолчанию 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"

{}

Подписывает соглашение по его ID.

Параметры

club `string` (обязательно) Внутренний ID клуба, подписывающего соглашение. agreementid `string` (обязательно) ID подписываемого соглашения. body `string` (обязательно) JSON-объект, содержащий соглашение и параметры для добавления или загрузки в систему...

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"

{}

Сводка Model Router объекта (конфигурация, баланс, расходы).

Параметры

clubID `string` (обязательно) tz `string` (необязательно) Часовой пояс IANA зрителя: используется для дневных и месячных периодов расходов, если у объекта нет данных о часовом поясе.

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"

{}

Каталог доступных моделей с состоянием включения для каждого объекта (по умолчанию все включены).

Параметры

clubID `string` (обязательно)

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"

{}

Доступные guardrails и готовые шаблоны Performance Hub.

Параметры

clubID `string` (обязательно)

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"

{}

Подключённые сервисы Model Router. Включают сопряжённые устройства ИИ-агентов, внешних агентов с явно указанным типом и сервис Workflow объекта. Конфигурация изменяется через PATCH /keys/{keyHash}.

Параметры

clubID `string` (обязательно) tz `string` (необязательно) Часовой пояс IANA зрителя: используется для дневных и месячных периодов расходов, если у объекта нет данных о часовом поясе.

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"

{}

Включение Model Router для объекта и предоставление ему доступа к инференсу.

Параметры

clubID `string` (обязательно)

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"

{}

Обновление тарифа, списка разрешённых моделей, guardrails, фильтров контента (скрытие или блокировка по регулярным выражениям на стороне Performance Hub), лимита расходов и настроек автопополнения.

Параметры

clubID `string` (обязательно)

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"

{}

Сброс счётчика жёсткого лимита за весь срок до 0 (новая точка отсчёта от текущих расходов) и запись закрытого периода в историю.

Параметры

clubID `string` (обязательно)

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"

{}

История сбросов жёсткого лимита (сначала новые): лимит, израсходованная сумма и метки времени для каждого закрытого периода.

Параметры

clubID `string` (обязательно)

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"

{}

Создание нового ключа API phk_ для объекта (открытый текст возвращается один раз). Принимает необязательные лимиты расходов, список разрешённых моделей, guardrails, фильтры контента и ограничения частоты rpmLimit/tpmLimit.

Параметры

clubID `string` (обязательно)

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"

Обновление изменяемых полей ключа: метка, лимиты расходов ключа, список разрешённых моделей, guardrails, фильтры контента и ограничения частоты rpmLimit/tpmLimit (синхронизируются с ключом).

Параметры

clubID `string` (обязательно) keyHash `string` (обязательно)

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"

{}

Журналы инференса объекта по каждому запросу (в реальном времени, только метаданные).

Параметры

clubID `string` (обязательно) page `string` (необязательно) pageSize `string` (необязательно) status `string` (необязательно) model `string` (необязательно) provider `string` (необязательно) source `string` (необязательно) `key` или `agent` keyHash `string` (необязательно) Фильтр по одному ключу или агенту по его keyHash в Performance Hub. q `string` (необязательно) Полнотекстовый поиск по ID запроса, метке ключа или агента, модели, поставщику и конечному пользователю. minutes `string` (необязательно) Интервал короче суток (например, Live=1440); переопределяет startDate/endDate. startTs `string` (необязательно) Начало интервала в секундах эпохи (масштабирование по щелчку); переопределяет минуты и даты. endTs `string` (необязательно) Конец интервала в секундах эпохи (масштабирование по щелчку); переопределяет минуты и даты.

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"

{}

Гистограмма запросов во времени для представления Logs. Те же фильтры, что и у маршрута списка, но данные агрегируются на сервере по временным интервалам (число успешных и неудачных запросов), поэтому ответ остаётся компактным при любом объёме журналов. Размер интервала выбирается автоматически в зависимости от периода.

Параметры

clubID `string` (обязательно) status `string` (необязательно) model `string` (необязательно) provider `string` (необязательно) source `string` (необязательно) keyHash `string` (необязательно) q `string` (необязательно) minutes `string` (необязательно) startDate `string` (необязательно) endDate `string` (необязательно) startTs `string` (необязательно) endTs `string` (необязательно)

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"

{}

Интервалы аналитики использования и итоги по моделям за период (в реальном времени).

Параметры

clubID `string` (обязательно) range `string` (необязательно) 24h | 7 | 30 | 90 | year | all (игнорируется, если заданы startDate/endDate) startDate `string` (необязательно) endDate `string` (необязательно) groupBy `string` (необязательно) model (по умолчанию) | key | source | provider | status — измерение для интервалов и групп subgroupBy `string` (необязательно) необязательное второе измерение, вложенное в каждую группу (Explore) keyHash `string` (необязательно) фильтр детального анализа: ограничение одним ключом или агентом model `string` (необязательно) фильтр детального анализа: ограничение одной моделью provider `string` (необязательно) source `string` (необязательно) compare `string` (необязательно) укажите "prev", чтобы также вернуть groupsPrev (непосредственно предшествующий период той же длины)

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"

{}

Календарь ежедневной активности за последний скользящий год (около 53 недель, как в GitHub).

Параметры

clubID `string` (обязательно)

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"

{}

Списание с сохранённой карты для оплаты SaaS для пополнения предоплаченного баланса Model Router.

Параметры

clubID `string` (обязательно) body `object` (необязательно)

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"

{}

Завершение пополнения после прохождения аутентификации 3DS в апплете.

Параметры

clubID `string` (обязательно)

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"

{}

Сводка о сохранённой карте для оплаты SaaS, с которой будут списываться пополнения и автопополнения.

Параметры

clubID `string` (обязательно)

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"

{}

Транзакции в журнале операций объекта, сначала новые. Можно отфильтровать по типу (например, `types=topup,adjustment` для истории движения средств или `types=charge-reconcile` с `from`/`to` для списаний за использование за месяц).

Параметры

clubID `string` (обязательно) limit `integer` (необязательно) Максимальное число строк (по умолчанию 50, не более 200) types `string` (необязательно) Типы транзакций через запятую (topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (необязательно) Только транзакции с createdAt >= from (секунды Unix) to `integer` (необязательно) Только транзакции с createdAt <= to (секунды 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"

{}

Уникальные месяцы `YYYY-MM` (UTC, сначала новые), в которых есть хотя бы одна транзакция запрошенных типов. Используются для раскрывающихся фильтров года и месяца, чтобы интерфейс предлагал только периоды, за которые действительно есть данные.

Параметры

clubID `string` (обязательно) types `string` (необязательно) Типы транзакций через запятую (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"

{}

Фирменная квитанция об оплате в формате PDF для одной транзакции Model Router.

Параметры

clubID `string` (обязательно) txId `string` (обязательно)

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"

{}

Набор фирменных квитанций об оплате в формате PDF для выбранных транзакций пополнения в виде ZIP-архива. Каждый id должен относиться к пополнению этого объекта: у списаний за использование и корректировок администратора квитанций нет, и такие id отклоняются.

Параметры

clubID `string` (обязательно) ids `string` (обязательно) ID транзакций через запятую (не более 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"

{}

Сводки списаний за использование по объекту по календарным месяцам (UTC), сначала новые. Текущий месяц всегда включается и помечается `isCurrentMonth` (с начала месяца до текущей даты).

Параметры

clubID `string` (обязательно) months `integer` (необязательно) Период ретроспективы в месяцах (по умолчанию 12, не более 24; игнорируется, если задан `year`) year `integer` (необязательно) Ограничение сводок одним календарным годом по UTC (например, 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"

{}

Фирменная ежемесячная выписка об использовании в формате PDF: сводка списаний за использование за месяц (промежуточные итоги по дням и общий итог). Не является счётом или квитанцией; списания за использование не являются сбором оплаты.

Параметры

clubID `string` (обязательно) month `string` (обязательно) Календарный месяц по 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"

{}

Исходные строки списаний за использование за месяц в формате CSV (ID транзакции, метка времени UTC, сумма, баланс после операции, снимок расходов за весь срок): подробный экспорт, сверяемый с итогом выписки за месяц.

Параметры

clubID `string` (обязательно) month `string` (обязательно) Календарный месяц по 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"

{}

Сводка использования и расходов объекта (данные в реальном времени и сверенный журнал операций).

Параметры

clubID `string` (обязательно) tz `string` (необязательно) Часовой пояс IANA зрителя: используется для дневных и месячных периодов расходов, если у объекта нет данных о часовом поясе.

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"

{}

Привязывает устройство AI Edge Processor к клубу или обновляет привязку

Параметры

body `string` (обязательно) JSON-объект для обновления регистрации устройства 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"

{}

Привязывает устройство AI Edge Processor к клубу. Определяет устройство в первую очередь по метаданным (приоритет у текущего сигнала активности), заполняет строку регистрации, если устройство ни разу не зарегистрировалось само, и удаляет устаревшие строки регистрации, оставшиеся после повторной подготовки оборудования.

Параметры

body `string` (обязательно) JSON-объект для обновления регистрации устройства 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"

{}

Возвращает список записей о загрузке bbox в клубе

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Поисковый индекс базы данных камер

Проксирует поисковый индекс camera-db общедоступной документации (производители, серии, модели, псевдонимы), который используется в диалоговом окне Find my camera при добавлении сетевых камер. Кешируется на сервере на 12 часов.

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"

{}

Шаблоны производителей в базе данных камер

Проксирует шаблоны URL RTSP и значения по умолчанию одного производителя из базы данных камер общедоступной документации. Slug проверяется для предотвращения обхода путей. Кешируется на сервере на 12 часов.

Параметры

slug `string` (обязательно) Slug производителя (например, 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"

{}

Возвращает список данных о регистрациях посещений для объекта

Параметры

club `string` (обязательно) Внутренний ID клуба или объекта, к которому нужно получить доступ. startDate `string` (необязательно) Дата начала в формате YYYY-MM-DD endDate `string` (необязательно) Дата окончания в формате YYYY-MM-DD timezone `string` (необязательно) Часовой пояс для интерпретации дат (по умолчанию Australia/Brisbane) nextToken `string` (необязательно) Токен пагинации для получения следующей страницы

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"

{}

Получение конфигурации клиентской части или интерфейса видеонаблюдения

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

GET /api/cctv/config/:club

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

{}

Получение конфигурации доставки контента видеонаблюдения

Возвращает домен контента, который клиенты видеонаблюдения используют для получения медиаресурсов. Домен задаётся переменной среды CONTENT_DOMAIN, а при её отсутствии используется значение по умолчанию в зависимости от среды (рабочая среда обслуживает /cctv, другие среды — /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"

{}

Изменение конфигурации клиентской части или интерфейса видеонаблюдения

Параметры

body `object` (обязательно) JSON-объект нового блока конфигурации для добавления в систему.

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"

{}

Возвращает список доступных регионов бакетов для настройки поставщика хранилища видеонаблюдения

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Сброс коллекции неопознанных лиц

Сбрасывает коллекцию неопознанных лиц CompreFace объекта, удаляя все субъекты. Записи о людях в DynamoDB, обнаружения лиц и блоки хронологии OpenSearch НЕ затрагиваются. Очищаются только исходные данные распознавания лиц. Новые теневые профили будут создаваться автоматически по мере обработки системой новых обнаружений с камер.

Параметры

facilityId `string` (обязательно)

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"

{}

Получение сведений о коллекции неопознанных лиц

Возвращает текущее число субъектов в коллекции неопознанных лиц CompreFace объекта.

Параметры

facilityId `string` (обязательно)

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"

{}

Добавляет сетевую камеру (OEM- или IP-камеру) по URL потока (RTSP, HTTP, HTTPS)

Параметры

body `string` (обязательно) JSON-объект для добавления сетевой камеры.

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"

{}

Массовое добавление сетевых камер на Edge Processor

Регистрирует несколько сетевых камер RTSP/HTTP на одном Edge Processor, затем один раз отправляет FEED_CONFIG, чтобы устройство перезагрузило конфигурацию только один раз.

Параметры

body `object` (обязательно)

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"

{}

Привязывает устройство к клубу или обновляет привязку

Параметры

body `string` (обязательно) JSON-объект для обновления регистрации устройства видеонаблюдения.

POST /api/cctv/devices

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

{}

Привязывает устройство к клубу

Параметры

body `string` (обязательно) JSON-объект для обновления регистрации устройства видеонаблюдения.

POST /api/cctv/devices/associate

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

{}

Отправляет запрос MQTT на устройство с указанным UUID и ожидает ответ (через websocket) со списком доступных возможностей камеры.

Параметры

club `string` (обязательно) Внутренний ID клуба, которому принадлежит запрашиваемое устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Список регистраций устройств

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

GET /api/cctv/devices/:club

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

{}

Удаляет сетевую камеру, помечая её как удалённую и исключая её из FEED_CONFIG Edge Processor

Параметры

club `string` (обязательно) Внутренний ID клуба, которому принадлежит устройство. balenaUUID `string` (обязательно) UUID удаляемой сетевой камеры.

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"

{}

Сохраняет все настроенные возможности камеры и применяет их к устройству в виде переменной среды (через balena)

Параметры

club `string` (обязательно) Внутренний ID клуба, которому принадлежит запрашиваемое устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Сохраняет маску движения камеры (если настроена) и применяет её к устройству в виде переменной среды (через balena)

Параметры

club `string` (обязательно) Внутренний ID клуба, которому принадлежит запрашиваемое устройство. body `string` (обязательно) JSON-объект маски камеры.

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"

{}

Отправляет на физическое устройство определённую команду v4l2 (например, яркость или контрастность)

Параметры

club `string` (обязательно) Внутренний ID клуба, которому принадлежит запрашиваемое устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Проверка URL потока сетевой камеры

Отправляет на Edge Processor тестовую команду для проверки URL потока камеры с помощью ffprobe

Тело запроса

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

{}

Безвозвратно удаляет одну запись об обнаружении лица из базы данных. Используется для удаления несовпадающих или неверных записей треков из журнала активности человека.

Параметры

club `string` (обязательно) fdID `string` (обязательно)

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"

{}

Возвращает список данных об обнаружениях лица человека

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personID `string` (обязательно) ID человека в системе идентификации лиц

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"

{}

Возвращает обнаружения лиц, ссылающиеся на указанное обрезанное изображение человека; запрос выполняется через GSI personCropImage.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personCropImage `string` (обязательно) URL обрезанного изображения человека, сохранённый в записи об обнаружении лица. limit `string` (необязательно) Максимальное число возвращаемых обнаружений. nextToken `string` (необязательно) Токен пагинации из предыдущего ответа.

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"

{}

Возвращает список данных об обнаружениях лиц в клубе, сгруппированных по периоду относительно текущего времени

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает список данных об обнаружениях лиц в клубе

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Поиск блоков хронологии обнаружений лиц на объекте с помощью OpenSearch

Параметры

facilityId `string` (обязательно) Внутренний ID объекта для поиска timezone `string` (обязательно) Часовой пояс IANA для преобразования дат (например, Pacific/Auckland) startDate `string` (необязательно) Фильтр по дате начала (YYYY-MM-DD), преобразуется в startUnix с учётом часового пояса endDate `string` (необязательно) Фильтр по дате окончания (YYYY-MM-DD), преобразуется в endUnix с учётом часового пояса personId `string` (необязательно) Фильтр по ID определённого человека query `string` (необязательно) Полнотекстовый поиск (например, по имени человека) limit `string` (необязательно) Результатов на странице (по умолчанию 20, не более 100) filters `string` (необязательно) Объект фильтров в формате JSON (например, {"matchType":"identified"}) sortBy `string` (необязательно) Поле для сортировки (startUnix, endUnix, created). По умолчанию endUnix. page `string` (необязательно) Номер страницы для пагинации (по умолчанию 1) sortOrder `string` (необязательно) Направление сортировки (asc или desc). По умолчанию 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"

{}

Возвращает список отчётов об объекте клуба

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Запуск генерации тепловой карты по требованию. Вызывает ту же логику Starter, что и задание cron по расписанию, но позволяет указать определённый объект, дату и время, а также набор периодов. При вызове без тела работает так же, как cron: проверяет все подходящие объекты и ставит в очередь каждое устройство.

Тело запроса

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

{}

Определение расположения составной PNG-тепловой карты за скользящий период для одного устройства. Возвращает только метаданные JSON: байты PNG хранятся в домене контента, а клиентская часть формирует URL так: `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` Порядок определения: 1. Найдено в индексе DynamoDB `composed#…` → немедленный возврат (~10 мс). 2. HEAD в Wasabi по детерминированному ключу кеша. Если найдено, записывается строка индекса для дозаполнения, и выполняется возврат. 3. Резерв из устаревших данных: существует любая составная запись для этого кортежа (устройство, диапазон, час), даже за другую дату. Возвращается сразу с `cache: 'HIT-STALE'`, чтобы клиентская часть могла хоть *что-то* отобразить. Новое составление запускается асинхронно. 4. Холодный путь: записи нет совсем. Lambda составления ставится в очередь через `InvocationType: 'Event'`, а конечная точка возвращает `202 { cache: 'PENDING' }`. Клиентская часть опрашивает, пока не появится запись (обычно 3–5 секунд). Обработка текущего дня: если `endDate` — местное «сегодня» объекта, конечная точка вместо этого отдаёт PNG за вчера: срезы за сегодня еще записываются заданием cron Starter, и новое составление было бы неполным. В ответе повторяется запрошенный `endDate` и добавляется `endDateUsed` (= вчера). Перечисление `cache`: - `HIT` — отдано из индекса DDB за запрошенную дату. - `HIT-FALLBACK` — запрошено сегодня; отдана строка индекса за вчера. - `HIT-BACKFILL` — нет в DDB, но PNG был в Wasabi; строка только что записана. - `HIT-FALLBACK-BACKFILL` — дозаполнение при резервном использовании данных за вчера. - `HIT-STALE` — нет записи за запрошенную дату, но есть запись за другую дату для этого кортежа; отдана сразу, а новое составление поставлено в очередь в фоновом режиме. - `PENDING` — записи нет совсем; составление поставлено в очередь. Клиентской части следует выполнять опрос. Ответ — `202 Accepted`, без `filePath`.

Параметры

facilityId `string` (обязательно) deviceUUID `string` (обязательно) Устройство, для которого выполняется составление. Составление выполняется отдельно для каждого устройства. hour `integer` (обязательно) Час суток (0–23), по которому выполняется составление за период ретроспективы. endDate `string` (необязательно) Последняя дата периода (YYYY-MM-DD). По умолчанию сегодня (по часовому поясу объекта). range `string` (необязательно) Период ретроспективы. Должен быть одним из разрешённых диапазонов. nocache `integer` (необязательно) Укажите `1`, чтобы обойти уровни кеша DDB и HEAD и принудительно выполнить новое составление.

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"

{}

Определение часов суток, для которых есть записи срезов `1h` для устройства за скользящий период ретроспективы. Клиентская часть использует это, чтобы заполнить список выбора часа рядом со списками выбора даты и диапазона, прежде чем вызвать конечную точку составления (`/api/cctv/heatmaps/hourly/...`). Пример: `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` Внутренняя реализация: один запрос диапазона DynamoDB к `cctvheatmaps` (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`) с группировкой по часам. Возвращает по одной записи на каждый час, в котором есть хотя бы один срез, включая репрезентативный опорный JPEG (из самого последнего дня периода; опорное изображение общее для устройства на каждый день).

Параметры

facilityId `string` (обязательно) deviceUUID `string` (обязательно) Запрашиваемое устройство. Почасовые срезы хранятся отдельно для каждого устройства. endDate `string` (необязательно) Последняя дата периода (YYYY-MM-DD). По умолчанию сегодня (по часовому поясу объекта). range `string` (необязательно) Период ретроспективы. Должен быть одним из разрешённых диапазонов.

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"

{}

Запрос заранее сгенерированных записей тепловых карт для объекта. **Все записи для типа периода:** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **Диапазон дат — один тип периода:** - `/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` **Диапазон дат — все применимые типы периодов (не указывайте periodType):** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` Возвращает годовые, полугодовые, квартальные и другие записи вплоть до 6h, которые пересекаются с заданным диапазоном. **Момент времени — все 9 типов периодов для одного устройства:** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` Возвращает до 9 записей (1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h).

Параметры

facilityId `string` (обязательно) Идентификатор объекта. deviceUUID `string` (необязательно) Запрос к определённому устройству. Если не указано, запрос выполняется по всем устройствам (GSI). periodType `string` (необязательно) Фильтр по одному типу периода. Если не указан при заданных from/to, запрашиваются все типы. from `string` (необязательно) Дата начала (yyyy-mm-dd). Используется вместе с `to`. to `string` (необязательно) Дата окончания (yyyy-mm-dd). Используется вместе с `from`. date `string` (необязательно) Поиск на момент времени (yyyy-mm-dd или yyyy-mm-ddTHH:mm). Требуется deviceUUID. Возвращает по одной записи на каждый тип периода.

GET /api/cctv/heatmaps/{facilityId}

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

{}

Получение миниатюры прямой трансляции устройства

Параметры

club `string` (обязательно) Внутренний ID клуба. deviceId `string` (обязательно) Внутренний ID устройства видеонаблюдения.

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"

{}

Уведомление системы видеонаблюдения о том, что вы собираетесь смотреть прямую трансляцию

Параметры

club `string` (обязательно) Внутренний ID клуба. deviceId `string` (обязательно) Внутренний ID устройства видеонаблюдения.

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"

{}

Подтверждение совпадения пересечения

Устанавливает статус совпадения confirmed и записывает проверяющего.

Параметры

club `string` (обязательно) matchId `string` (обязательно)

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"

{}

Получение одного совпадения пересечения со сведениями о посещениях

Возвращает запись о совпадении и разбивку времени по каждому посещению.

Параметры

club `string` (обязательно) matchId `string` (обязательно)

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"

{}

Ручная привязка несопоставленного человека к участнику

Связывает personId видеонаблюдения с определённым участником и устанавливает для совпадения статус confirmed.

Параметры

club `string` (обязательно) matchId `string` (обязательно)

Тело запроса

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

{}

Список совпадений пересечений для объекта

Возвращает постраничный список совпадений, отфильтрованных по статусу.

Параметры

club `string` (обязательно) status `string` (необязательно) limit `integer` (необязательно) nextToken `string` (необязательно)

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"

{}

Отклонение совпадения пересечения

Устанавливает статус совпадения rejected и записывает проверяющего.

Параметры

club `string` (обязательно) matchId `string` (обязательно)

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"

{}

Получение сводных показателей сопоставления пересечений

Возвращает число совпадений по объекту, сгруппированное по статусу.

Параметры

club `string` (обязательно) ID объекта

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"

{}

Отмена привязки автоматически изученного совпадения профиля

Возвращает привязанное совпадение в статус rejected и очищает autoLearnedFrom в записи участника.

Параметры

club `string` (обязательно) matchId `string` (обязательно)

Тело запроса

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

{}

Чтение статуса выполняющейся операции "upsert identified person" (охватывает создание и изменение). Строка читается напрямую из таблицы `people-ops`, принадлежащей cctv-rekognition-api, без вызова Lambda. Используется клиентской частью видеонаблюдения для опроса хода выполнения после POST /api/cctv/people/{facility}/identified. Путь находится на одном уровне с `/cctv/people/...` (а не вложен в него), чтобы маршрутизатор express не мог ошибочно сопоставить `operationId` с `:personID` в `/cctv/people/:club/:personID`. См. порядок шаблонов в createAPIRouter. Возвращает заполнитель `pending`, пока Lambda upsertIdentifiedPerson ещё не записала первую запись этапа (период холодного запуска). Обработчик опроса в клиентской части обрабатывает заполнитель и pending одинаково, поэтому контракт для вызывающих остаётся стабильным.

Параметры

operationId `string` (обязательно)

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"

{}

Добавляет изображение лица (из существующего обнаружения в треке) в субъект распознавания CompreFace этого человека и сохраняет ссылку в таблице теневых фотографий. НЕ загружает изображение в Wasabi: оно уже хранится там как снимок обнаружения лица.

Параметры

club `string` (обязательно) personID `string` (обязательно) body `string` (обязательно)

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"

{}

Добавление теневых фотографий в запись о человеке

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personID `string` (обязательно) ID записи о человеке body `string` (обязательно) JSON-объект нового блока конфигурации для добавления в систему.

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"

{}

Запрос теневых фотографий человека

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personID `string` (обязательно) ID записи о человеке

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"

{}

Безвозвратно удаляет запись теневой фотографии из CCTVShadowPhotosTable и удаляет соответствующее лицо из CompreFace (если сохранён faceId).

Параметры

club `string` (обязательно) personID `string` (обязательно) id `string` (обязательно) ID записи теневой фотографии (первичный ключ)

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"

{}

Удаляет ссылки и связанные записи rekognition по personID

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personID `string` (обязательно) Уникальный ID человека в системе видеонаблюдения.

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"

{}

Возвращает запись о человеке в клубе

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. personID `string` (обязательно) ID человека в базе данных.

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"

{}

Получение зон доступа, соответствующих профилю членства человека

Определяет тип участника, теги и планы членства человека, затем возвращает реальные зоны доступа (origin=membership-plan, не поглощённые), сопоставленные по правилам включения и исключения. accessRestriction каждой зоны сокращается до правил, которым соответствует человек. Камеры дочерних зон объединяются с родительскими зонами.

Параметры

club `string` (обязательно) Внутренний ID объекта personID `string` (обязательно) ID человека из таблицы людей видеонаблюдения

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"

{}

Возвращает текущий статус задания объединения, включая результаты по каждому источнику. Опрашивайте эту конечную точку каждые 3–5 секунд, пока статус равен IN_PROGRESS.

Параметры

club `string` (обязательно) mergeJobID `string` (обязательно)

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"

{}

Запускает фоновое объединение нескольких профилей неопознанных людей в один сохраняемый профиль. Сразу отвечает 202 с mergeJobID. Ход выполнения отслеживайте через /merge-status/:mergeJobID.

Параметры

club `string` (обязательно) body `string` (обязательно)

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"

Добавление лица в коллекцию чёрного списка объекта

Параметры

facilityId `string` (обязательно) Внутренний ID объекта

Тело запроса

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

{}

Создание или обновление опознанного человека на объекте: создаёт новую запись или обновляет существующую. Проксирует запрос в Lambda upsertIdentifiedPerson, которая записывает данные о человеке, загружает переданную фотографию в Wasabi и повторно индексирует лицо в CompreFace. Если `isNewRecord` равно true (по умолчанию), Lambda выполняет ветвь создания (cctvPeople.save), а `personID` генерируется, если не указан. Если `isNewRecord` равно false, Lambda выполняет ветвь обновления (cctvPeople.update): `personID` обязателен и должен указывать на существующую запись.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

Обновление набора необязательных полей партнёра, синхронизируемых в таблицу людей видеонаблюдения для объекта.

Параметры

facilityId `string` (обязательно) Внутренний ID объекта

Тело запроса

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

{}

Возвращает список данных о людях в клубе

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

GET /api/cctv/people/:club

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

{}

Поиск людей на объекте по изображению лица. Вызывает Lambda imageFaceSearch из cctv-rekognition-api с загруженным изображением base64 и ID объекта из пути. Возвращает ранжированные совпадения и сводку атрибутов DeepFace.

Параметры

club `string` (обязательно) ID объекта или клуба body `string` (обязательно)

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"

{}

Поиск людей на объекте с помощью OpenSearch

Параметры

facilityId `string` (обязательно) Внутренний ID объекта для поиска query `string` (необязательно) Поисковый запрос (например, имя) page `string` (необязательно) Номер страницы (по умолчанию 1) limit `string` (необязательно) Результатов на странице (по умолчанию 20, не более 100) filters `string` (необязательно) Объект фильтров в формате JSON (например, {"membershipStatus":"active"}) sortBy `string` (необязательно) Поле для сортировки (created, lastName, firstName, membershipUpdatedOn). По умолчанию created. sortOrder `string` (необязательно) Направление сортировки (asc или desc). По умолчанию 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"

{}

Обновляет элементы обнаружения лиц, присваивая новый personID, и связывает записи rekognition

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. body `string` (обязательно) JSON-объект нового блока конфигурации для добавления в систему.

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"

{}

Возвращает объект со всеми доступными фильтрами для данных записей видеонаблюдения клуба

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Потоковое воспроизведение записи.

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"

{}

Обновление сведений о записи.

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"

{}

Возвращает сводку данных записей видеонаблюдения клуба

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает список данных записей видеонаблюдения клуба за период относительно текущего времени

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает список данных записей видеонаблюдения клуба

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

GET /api/cctv/recordings/:club

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

{}

Записи автоматически удаляются по истечении заданного периода; используйте эту функцию, чтобы сохранить записи

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Поиск снимков отчётов объекта за диапазон дат

Параметры

facilityId `string` (обязательно) Внутренний ID объекта startDate `string` (обязательно) Фильтр по дате начала (YYYY-MM-DD) endDate `string` (обязательно) Фильтр по дате окончания (YYYY-MM-DD) deviceIds `string` (необязательно) Список ID камер или устройств через запятую для фильтрации view `string` (необязательно) Альтернативное представление отчёта для расчёта (передаётся в Lambda отчётов)

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"

{}

Векторный поиск по проиндексированным медиаданным видеонаблюдения объекта. Отвечает потоком text/event-stream, ретранслируемым из Lambda searchAnything, чтобы клиент мог отображать ход выполнения, пока холодный контейнер загружает кодировщик. События: сначала `status`, затем `result` или `error`. Есть три способа выполнить запрос, два из них — этим методом. Передайте `query` для поиска по произвольному тексту. Передайте `seedIndex` + `seedKey` для поиска по образцу («больше похожих») с использованием вектора строки, уже имеющейся в индексе: так можно найти больше результатов, похожих на тот, который просматривает пользователь. Чтобы выполнить поиск по изображению пользователя, отправьте байты на этот же путь методом `POST`. Передайте слова вместе с изображением, чтобы сузить одно другим: **текст фильтрует, изображение ранжирует**. Кандидаты берутся из образца, слова определяют, какие из них останутся, а визуальное сходство определяет порядок, поэтому результаты по-прежнему похожи на изображение, а слова отсеивают неподходящие. Эти два сигнала никогда не объединяются в один вектор, поэтому для комбинированного поиска `queryKind` остаётся `similar`; о том, что применён текстовый фильтр, говорит наличие `query` в результате. Комбинированный поиск довольно часто ничего не возвращает; рассматривайте это как отдельный результат: `perIndex..textGated` подсчитывает кандидатов, совпавших с изображением, но не со словами, поэтому пустую страницу можно объяснить как «уберите слова», а не «попробуйте другое изображение». Поиск по образцу без слов не загружает кодировщик, поэтому не требует холодного запуска; добавление слов лишает этого преимущества. В любом случае по умолчанию поиск выполняется по всем индексам: векторы фрагментов, записей и таймлапсов находятся в одном пространстве, поэтому по фрагменту с человеком можно найти соответствующие видеозаписи. Оценки при поиске по образцу значительно выше, чем при текстовом поиске (при сравнении изображения с изображением нет разрыва между модальностями), и фильтруются по отдельному, ещё не откалиброванному порогу: `result.queryKind` указывает, какую шкалу вы видите, и оценки разных шкал никогда нельзя сравнивать. По умолчанию поиск выполняется по всем индексам и возвращает один объединённый список, отсортированный по оценке; каждое совпадение содержит `index` и `kind`, чтобы вызывающая сторона могла отличить совпадение по изображению от совпадения по видео (у последнего добавляется `offsetMs`). Индексы, для которых у объекта нет таблицы, указываются в `skipped`, а не вызывают ошибку. Совпадения ниже откалиброванного порога релевантности каждого индекса отбрасываются, поэтому запрос без реальных совпадений возвращает пустой список, а не уверенную бессмыслицу; `perIndex` сообщает, что дал каждый индекс и почему. Результаты можно сузить по времени съёмки и по камере. Предпочитайте `cameraId` вместо `camera`: это balenaUUID камеры, единственное значение, которое все индексы хранят одинаково, поэтому один фильтр сужает их все. Фильтр, который индекс не может обработать, указывается в `perIndex..filtersIgnored`, и поиск по этому индексу выполняется без сужения, а не исключается. Совпадения по записям возвращаются **по одному на клип, а не на каждый совпавший кадр**: кадры выбираются каждые 2 с, поэтому задержавшийся в кадре субъект совпадает с десятью почти одинаковыми кадрами одной записи. Для каждого клипа возвращается лучший кадр, а также `matchCount` и `offsetsMs` со всеми совпавшими моментами внутри него, которые можно сразу использовать как точки перехода. Фрагменты с людьми никогда не объединяются, так как два фрагмента с одним человеком — это два разных появления.

Параметры

facilityId `string` (обязательно) Внутренний ID объекта для поиска query `string` (необязательно) Описание искомого в свободной форме. Обязательно, если не передан warm=1 или образец. Вместе с образцом оно перестаёт быть объектом ранжирования и становится фильтром для кандидатов образца, отбрасывая тех, чья текстовая оценка ниже порога релевантности индекса. seedIndex `string` (необязательно) Поиск по образцу вместо текста: индекс, в котором находится строка образца (person-crops, recording-frames, timelapse-frames). Это `index` совпадения, по которому щёлкнул пользователь. Передаётся вместе с seedKey. seedKey `string` (необязательно) `key` строки образца, взятый из совпадения без изменений. Образец исключается из собственных результатов; для записи это означает весь клип, так как его остальные кадры следуют с интервалом 2 с и почти идентичны. seedFrameId `string` (необязательно) Обязательно, если seedIndex равен recording-frames: этот индекс хранит по одной строке на каждый выбранный кадр, и все они имеют общий ключ клипа, поэтому один ключ указывает на клип, а не на момент. Передайте `frameId` совпадения. У старых строк его нет; вместо этого передайте seedOffsetMs. seedOffsetMs `string` (необязательно) Резервный идентификатор кадра для образцов recording-frames, строки которых созданы до появления `frame_id`. Передайте `offsetMs` совпадения. Игнорируется, если передан seedFrameId. warm `string` (необязательно) Подготовка контейнера Lambda без выполнения поиска. Вызывайте при загрузке страницы. warmTarget `string` (необязательно) Какой кодировщик загружает `warm`: `text` (по умолчанию), `image` или `both`. Визуальная часть модели занимает 355 МБ против 283 МБ у текстовой, поэтому её подготовка включается явно: запрашивайте `image`, только когда пользователь действительно подготовил изображение, а не при загрузке страницы. index `string` (необязательно) Наборы данных для поиска через запятую: person-crops, recording-frames, timelapse-frames. Результаты объединяются в один список, отсортированный по оценке. По умолчанию поиск выполняется по всем трём; чтобы сузить его, передайте явный список. timelapse-frames охватывает камеры, которые ничего не записывают и создают лишь один кадр в минуту; порог релевантности для него ещё не откалиброван. model `string` (необязательно) Кодировщик для запроса. Должен совпадать с кодировщиком, которым проиндексирован набор данных. limit `string` (необязательно) Число возвращаемых результатов на индекс (по умолчанию 50, не более 100); это не общее число, поэтому поиск по всем трём индексам может вернуть до трёх раз больше. Для записей учитываются клипы, а не совпавшие кадры. from `string` (необязательно) Сопоставлять только медиаданные, снятые в это время или позже, в миллисекундах с начала эпохи. Обратите внимание: это время съёмки, а не загрузки. to `string` (необязательно) Сопоставлять только медиаданные, снятые до этого времени (не включительно), в миллисекундах с начала эпохи. cameraId `string` (необязательно) balenaUUID камер через запятую для сужения поиска: поле `balenaUUID` каждой записи, возвращаемой /api/cctv/recordings/filters/:club. Предпочтительный фильтр по камере: все индексы хранят одно и то же значение, поэтому один фильтр сужает их все. Обратите внимание, что это значение есть только у фрагментов, для которых удалось связать обнаружение лица (сейчас ~1%), поэтому сужение фрагментов по камере вернёт мало результатов или ни одного, пока не будет выполнено дозаполнение фрагментов; записи заполнены полностью и фильтруются точно. camera `string` (необязательно) Названия камер через запятую для сужения поиска. Фактически работает только для записей: person-crops хранит пустое название камеры в каждой строке, поэтому любое значение здесь исключает все фрагменты. Предпочтительнее cameraId. cameraGroup `string` (необязательно) Группы камер через запятую для сужения поиска. Заполнены для всех записей, но только для ~1% фрагментов по той же причине, что и cameraId. minScore `string` (необязательно) Переопределение порога косинусного сходства для каждого индекса, отсекающего шум. Не указывайте в рабочей среде: у каждого индекса есть откалиброванное значение по умолчанию (и отдельное, неоткалиброванное, для поиска по образцу). Передайте 0, чтобы при отладке релевантности увидеть ближайших соседей без фильтрации.

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"

{}

Поиск по изображению пользователя, а не по словам или по результату, уже отображаемому на экране. Во всём остальном идентичен GET (те же параметры запроса, тот же поток событий, та же структура результата), поэтому здесь описаны только отличия. Передайте **исходные байты файла** в теле запроса с Content-Type `image/*`. Не изменяйте размер, не обрезайте и не перекодируйте изображение в браузере заранее: сервер воспроизводит очень специфическое масштабирование (сжатие до 256x256 билинейным ядром со сглаживанием), с которым были построены проиндексированные векторы, а масштабирование canvas использует другое. По измерениям такая замена даёт отклонение примерно на 0,93 по косинусному сходству от правильного ответа, что больше, чем между двумя действительно разными изображениями, поэтому результаты возвращаются ранжированными правдоподобно, но неверно, и без ошибки. Ограничение 4 МБ связано с транспортом, а не с качеством: байты передаются в полезной нагрузке вызова Lambda, которая ограничена 6 МБ, а base64 увеличивает их объём на треть. Результаты оцениваются по сходству изображений, поэтому `queryKind` равен `image`, а оценки находятся на той же значительно более высокой шкале, что и при поиске по образцу, и никогда не сравнимы с текстовыми оценками. Они будут немного *ниже*, чем при эквивалентном поиске по образцу: вектор образца записан самим устройством, а загруженное изображение перекодируется здесь другим движком, из-за чего вектор смещается на несколько сотых от того, что получило бы устройство. По измерениям качество результатов при этом одинаковое; просто наборы не идентичны. Добавление `query` фильтрует результаты по этим словам точно так же, как для образца. Отправка образца *и* изображения отклоняется: оба являются объектом ранжирования, поэтому такая пара не имеет смысла. Это самый ресурсоёмкий запрос, который обслуживает конечная точка. Загруженное изображение загружает визуальную часть модели, а добавление слов загружает и текстовую, причём обе в холодном контейнере. Вызов `warm=1&warmTarget=image`, как только пользователь подготовит изображение, убирает это с критического пути.

Параметры

facilityId `string` (обязательно) Внутренний ID объекта для поиска body `string` (обязательно) Исходные байты изображения без изменений, не более 4 МБ query `string` (необязательно) Необязательные слова для сужения результатов поиска по изображению: отбрасываются совпадения, текстовая оценка которых ниже порога релевантности индекса.

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"

{}

Возвращает сведения о хранилище и другие метрики видеонаблюдения клуба

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"

{}

Возвращает список записей о загрузке таймлапсов клуба

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

GET /api/cctv/timelapse/:club

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

{}

Список действий пользователей с записями в клиентской части или интерфейсе видеонаблюдения

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Запись действия пользователя с записями в клиентской части или интерфейсе видеонаблюдения

Параметры

body `string` (обязательно) JSON-объект нового блока конфигурации для добавления в систему.

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"

{}

Получение токена пользователя для клиентской части или интерфейса видеонаблюдения

Параметры

club `string` (обязательно) ID клуба

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"

{}

Создание токена для временного или гостевого доступа

Параметры

club `string` (обязательно) Уникальный идентификатор клуба. body `string` (обязательно) JSON-объект с данными выдаваемого токена.

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

Возвращает список записей о токенах для временного или гостевого доступа

Параметры

club `string` (обязательно) Уникальный идентификатор клуба.

GET /api/cctv/token/{club}

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

{}

Получить токен доступа по идентификатору доступа

Параметры

accessID `string` (обязательно) Идентификатор записи токена в базе данных.

POST /guest/cctv/token/:accessID

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

{}

Удаление часов доступа объекта

Параметры

facilityId `string` (обязательно) body `object` (обязательно) JSON-объект новых часов доступа.

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"

{}

Возвращает список часов доступа объекта

Параметры

facilityId `string` (обязательно)

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"

{}

Обновляет или создаёт часы доступа объекта

Параметры

facilityId `string` (обязательно) body `object` (обязательно) JSON-объект новых часов доступа.

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"

{}

Удаление зоны доступа объекта

Параметры

facilityId `string` (обязательно) body `object` (обязательно) JSON-объект новой зоны доступа.

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"

{}

Возвращает список зон доступа объекта

Параметры

facilityId `string` (обязательно)

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"

{}

Обновляет или создаёт зону доступа объекта

Параметры

facilityId `string` (обязательно) body `object` (обязательно) JSON-объект новой зоны доступа.

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"

{}

Возвращает объединение всех идентификаторов административных модулей по брендам и объектам организации в виде объектов модулей.

Параметры

organisationId `string` (обязательно) Идентификатор организации

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"

{}

Возвращает список всех организаций

Параметры

includeBrands `string` (необязательно) Включить бренды, связанные с организацией includeFacilities `string` (необязательно) Включить объекты, связанные с организацией includeRegions `string` (необязательно) Включить регионы, связанные с организацией

GET /api/organisations

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

{}

Простой ИИ-помощник, который анализирует содержимое заявки в поддержку и формирует предложения на основе доступных тем, а также рекомендуемых тем для поиска Algolia...

Параметры

messageBody `string` (обязательно) Текст отправляемого сообщения topicData `string` (обязательно) JSON-объект или массив topicData, возвращённый osTicket (системой заявок и поддержки) facilityId `string` (необязательно) Внутренний ID клуба, необходимый для определения нужного индекса Algolia для поиска.

PUT /api/ai/helpers/analyse-support-ticket

curl -X PUT https://portal.hub.gymsystems.co/api/ai/helpers/analyse-support-ticket \
  -H "x-api-key: YOUR_API_KEY"

{}

Простой API для генерации изображений

Параметры

type `string` (обязательно) Тип генерируемого изображения name `string` (обязательно) Имя изображения maxSize `string` (необязательно) Необязательный максимальный размер ответа, например 200KB, 1MB или просто число байтов. Изображение уменьшается или сжимается до нужного размера.

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"

{}

Простой запрос к LLM

Облегчённая конечная точка для простых запросов к LLM без сохранения состояния. Использует недорогую модель без рассуждений (gpt-4o-mini) со строгими ограничениями на число токенов. Без истории беседы, инструментов и потоковой передачи: на входе промпт, на выходе текст.

Тело запроса

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

{}

Возвращает конфигурацию Algolia, включая имя индекса, ID приложения и ключ API.

Параметры

facilityId `string` (обязательно)

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"

{}

Инициализирует индекс Algolia для маркетинговых печатных материалов

Параметры

organisationId `string` (обязательно)

PUT /api/algolia/index

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

{}

Поиск маркетинговых печатных материалов

Тело запроса

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

{}

Поиск маркетинговых печатных материалов

Параметры

club `string` (необязательно) ID клуба searchTerms `string` (необязательно) Поисковые запросы algoliaArgs `object` (необязательно) Дополнительные аргументы поиска 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"

{}

Массовое обновление объектов маркетинговых печатных материалов для определённого клуба

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"

{}

Получает маркетинговые печатные материалы из Algolia.

Параметры

organisationId `string` (обязательно) search `string` (необязательно) limit `string` (необязательно) brand `string` (необязательно) tag `string` (необязательно)

GET /api/algolia/marketing/assets

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

{}

Инициализирует индекс Algolia для маркетинговых печатных материалов с конфигурацией объекта.

Параметры

organisationId `string` (обязательно)

POST /api/algolia/marketing/assets

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

{}

Выполняет поиск в указанном индексе Algolia по поисковым запросам, клубу и/или языковому стандарту. Поиск можно дополнительно настроить с помощью дополнительных аргументов Algolia.

Параметры

searchTerms `string` (обязательно) Поисковые запросы для индекса Algolia. club `string` (необязательно) Внутренний ID клуба, выполняющего запрос. Если указан, результаты поиска фильтруются по региону, связанному с клубом. locale `string` (необязательно) Языковой стандарт для определения региона, если клуб не указан. Определяется по navigator.languages. algoliaArgs `string` (необязательно) Дополнительные или пользовательские аргументы, передаваемые в поисковый запрос 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"

{}

Возвращает список всех объявлений

GET /api/announcements/list

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

{}

Загружает ресурс в ОБЩЕДОСТУПНЫЙ БАКЕТ S3 (через Upload API), после чего файл проходит постобработку и оптимизацию, создаются миниатюры и т. д. *Обратите внимание: ресурсы будут общедоступными*

Параметры

file `string` (необязательно) Имя загружаемого файла или ресурса.

POST /api/asset-upload

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

{}

Возвращает статус загрузки по указанному uuid записи о загрузке

Параметры

uuid `string` (обязательно) UUID записи о загрузке

GET /api/asset-upload/:uuid

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

{}

Отправка команды на Sonos клуба

Параметры

body `object` (обязательно) JSON-объект с командой и входными данными для отправки на 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"

{}

Получение конфигурации клиентской части управления аудио

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Изменение конфигурации клиентской части управления аудио

Параметры

body `object` (обязательно) JSON-объект нового блока конфигурации для добавления в систему.

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"

{}

Получает настройки бренда для определённого региона

Параметры

brandId `string` (необязательно) ID бренда regionCode `string` (необязательно) Код ISO региона, для которого нужно получить настройки

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"

{}

Обновляет несколько настроек бренда для определённого региона

Параметры

brandId `string` (необязательно) ID обновляемого бренда regionCode `string` (необязательно) Код ISO региона, для которого нужно обновить настройки acceptFreeTrialBookingsVisibility `string` (необязательно) customTrackingCodeVisibility `string` (необязательно) displayDataSources `string` (необязательно) displayDefaultDataSource `string` (необязательно) displayDefaultUI `string` (необязательно) displayUIOptions `string` (необязательно) defaultAboutBusiness `string` (необязательно) defaultAboutBusinessFacebook `string` (необязательно) facilityCoverImage `string` (необязательно) digitalProfileSettingsVisibility `string` (необязательно) facilityHoursVisibility `string` (необязательно) facilityLocationVisibility `string` (необязательно) facilityPaymentMethods `string` (необязательно) facilityPrimaryLogo `string` (необязательно) facilityStatusVisibility `string` (необязательно) landingPagesVisibility `string` (необязательно) lineChatIntegrationVisibility `string` (необязательно) whatsAppIntegrationVisibility `string` (необязательно) defaultWhatsAppMessage `string` (необязательно) socialUrlsVisibility `string` (необязательно) yextApiKey `string` (необязательно) Ключ API, используемый интеграцией Yext для этого сочетания бренда и региона. Учитывается, только если `directorySyncMode` имеет значение `yext`. directorySyncMode `string` (необязательно) Серверная часть синхронизации для объектов этого сочетания бренда и региона. Если значение отсутствует, по умолчанию используется `yext` для обратной совместимости с брендами, созданными до внедрения Directory Publishers. websiteUrl `string` (необязательно) androidAppUrl `string` (необязательно) iosAppUrl `string` (необязательно) featuredMessageDescription `string` (необязательно) yextCategoryIds `string` (необязательно) Устаревший ключ хранения: на самом деле это ID категорий Google Business Profile (например, gcid:gym). Префикс "yext" появился до отказа от Yext и сохранён для обратной совместимости с существующими строками базы данных. customInputFields `string` (необязательно) customInputFieldsToRemove `string` (необязательно)

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"

{}

Получает настройки бренда для определённого объекта

Параметры

facilityId `string` (необязательно) ID объекта, для которого нужно получить настройки бренда

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"

{}

Создаёт новый бренд

Параметры

name `string` (обязательно) Название бренда organisationId `string` (обязательно) ID организации, которой принадлежит бренд redirectDashboard `string` (необязательно) URL для перенаправления после входа вместо панели по умолчанию

POST /api/brands

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

{}

Возвращает список всех брендов

GET /api/brands

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

{}

Возвращает объект бренда

Параметры

brandId `string` (обязательно) ID получаемого бренда includeOrganisation `boolean` (необязательно) Включать ли данные организации в ответ

GET /api/brands/{brandId}

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

{}

Обновляет бренд по ID

Параметры

brandId `string` (необязательно) ID обновляемого бренда name `string` (обязательно) Название бренда brandOrganisationId `string` (необязательно) ID организации, которой принадлежит бренд redirectDashboard `string` (необязательно) URL для перенаправления после входа вместо панели по умолчанию yextApiKey `string` (необязательно) Ключ API для доступа к Yext API для этого бренда customMenuLayout `object` (необязательно) Дерево структуры бокового меню бренда (разделы / группы / пункты со ссылками на системные модули или пользовательские URL). Задать его может только администратор организации, которой принадлежит этот бренд.

PUT /api/brands/{brandId}

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

{}

Список объектов бренда

Возвращает облегчённый список объектов (id, название, код ISO региона), принадлежащих бренду. Используется для заполнения списков выбора объектов в конфигурации бренда.

Параметры

brandId `string` (обязательно) ID бренда, для которого нужно получить список объектов

GET /api/brands/{brandId}/facilities

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

{}

Возвращает список всех брендов, связанных с организацией клуба.

GET /api/clubs/{club}/brands

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

{}

Возвращает список всех типов календарей

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"

{}

Удаление баннера панели

Выполняет мягкое удаление баннера панели, принадлежащего бренду.

Параметры

brandId `string` (обязательно) ID бренда, которому принадлежит баннер bannerId `string` (обязательно) ID удаляемого баннера

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"

{}

Список баннеров панели для бренда

Возвращает все (не удалённые) баннеры панели, настроенные для бренда, для управления администратором.

Параметры

brandId `string` (обязательно) ID бренда, для которого нужно получить список баннеров

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"

{}

Создание или обновление баннера панели

Создаёт новый баннер панели для бренда или обновляет существующий, если в теле передан `bannerId`. Для баннеров можно задать расписание (начало и конец в секундах Unix, null = без ограничения) и показывать их всему бренду, определённым регионам (коды ISO) или определённым объектам.

Параметры

brandId `string` (обязательно) ID бренда, которому принадлежит баннер

Тело запроса

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

{}

Получить активные баннеры панели для объекта

Определяет баннеры панели, которые сейчас должны отображаться для объекта, с учётом бренда объекта, региона (код страны ISO), а также флага включения, периода показа и таргетинга каждого баннера. Используется интерфейсами панели.

Параметры

facilityId `string` (обязательно) Идентификатор объекта, для которого нужно определить баннеры

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"

{}

Возвращает ресурс KYC клуба.

Параметры

clubId `string` (обязательно) ID клуба. key `string` (обязательно) Ключ ресурса 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"

{}

Возвращает сведения KYC клуба.

GET /api/clubs/{clubId}/kyc

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

{}

Обновляет сведения KYC клуба.

Параметры

clubId `string` (обязательно) ID обновляемого клуба. body `object` (обязательно)

PUT /api/clubs/{clubId}/kyc

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

{}

Загружает ресурс KYC для клуба.

Параметры

clubId `string` (обязательно) ID клуба. file `string` (обязательно) Загружаемый файл.

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"

{}

Возвращает настройки клуба.

GET /api/club/preferences/:club

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

{}

Создаёт или обновляет запись настроек клуба.

Тело запроса

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

{}

Возвращает список участников с соглашением.

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"

{}

Возвращает список участников с соглашением.

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"

{}

Возвращает список пользователей, относящихся к указанному клубу

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ

GET /api/clubs/{club}/members

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

{}

Возвращает, открыт ли клуб в указанную дату.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. date `string` (обязательно) Проверяемая дата в формате 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"

{}

Возвращает все метаданные клуба, отображаемые на веб-сайтах Example Club.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Обновляет метаданные клуба новыми данными, переданными из клиентской части. Поля, отсутствующие в теле запроса, сохраняются (без SET и REMOVE). Поля, переданные как `null` или пустая строка, очищаются. Передайте `updateAll: false`, чтобы использовать отдельный путь частичного слияния; в любом случае вызывающим не нужно передавать поля, которыми они не владеют.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. body `string` (обязательно) JSON-объект с данными клуба, которые нужно обновить.

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"

{}

добавление новой записи пользовательского отслеживания

Параметры

club `string` (обязательно) id клуба body `string` (обязательно) Массив элементов пользовательского отслеживания.

POST /api/clubs/{club}/customtracking

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

{}

Возвращает пользовательское отслеживание для определённого клуба

GET /api/clubs/customtracking/:clubID

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

{}

Обновление записей пользовательского отслеживания

Параметры

club `string` (обязательно) id клуба body `string` (обязательно) JSON-объект с данными клуба, которые нужно обновить.

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"

{}

Возвращает изображение фасада клуба по умолчанию.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Список дверей, доступных на объекте

Параметры

body `object` (обязательно) JSON-объект с данными клуба, которые нужно обновить.

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"

{}

Разблокировка определённой двери на объекте

Параметры

body `object` (обязательно) JSON-объект с данными клуба, которые нужно обновить.

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"

{}

Возвращает все интеграции и сведения об их конфигурации для указанного клуба.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Обновляет метаданные клуба новыми данными, переданными из клиентской части.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. body `object` (обязательно) JSON-объект с данными клуба, которые нужно обновить.

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"

{}

Возвращает логическое значение, указывающее, находится ли клуб в европейской стране

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. date `string` (обязательно) Проверяемая дата в формате 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"

{}

Возвращает общий список всех клубов в нашей базе данных.

GET /api/clubs/listclubs

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

{}

Возвращает, открыт ли клуб в указанную дату.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. date `string` (обязательно) Проверяемая дата в формате 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"

{}

Получение отзывов о клубе из DynamoDB.

Параметры

club `string` (обязательно) ID клуба

GET /api/clubs/{club}/reviews

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

{}

Получение настроек отзывов клуба из DynamoDB.

Параметры

facilityId `string` (обязательно) ID объекта

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"

{}

Обновление настроек отзывов клуба в DynamoDB.

Параметры

club `string` (обязательно) ID клуба

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"

{}

Повторное включение автоматической публикации в настройках отзывов.

Параметры

club `string` (обязательно) ID клуба

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"

{}

Публикует отзыв

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. review `string` (обязательно) Внутренний ID отзыва, который нужно опубликовать.

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"

{}

Повторное включение автоматической публикации в настройках отзывов.

Параметры

club `string` (обязательно) ID клуба

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"

{}

Публикация ответа на отзыв через исходную платформу публикации (Google и т. д.).

Параметры

club `string` (обязательно) ID объекта reviewId `string` (обязательно) ID отзыва в Performance Hub (ищется в таблице club-social-reviews) body `string` (обязательно)

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"

{}

Отменяет публикацию отзыва

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. review `string` (обязательно) Внутренний ID отзыва, публикацию которого нужно отменить.

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"

{}

Возвращает из базы данных Performance Hub список владельцев, относящихся к указанному клубу

Параметры

clubID `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ

GET /api/clubs/{clubID}/owners

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

{}

Возвращает все планы членства объекта.

Параметры

facilityId `string` (обязательно) Внутренний ID объекта

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"

{}

Обновляет запись плана членства.

Параметры

facilityId `string` (обязательно) Внутренний ID объекта body `object` (обязательно) JSON-объект с данными плана членства, которые нужно обновить.

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"

{}

Повторное включение автоматической публикации в настройках отзывов.

Параметры

club `string` (обязательно) ID клуба

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"

{}

Повторное включение автоматической публикации в настройках отзывов.

Параметры

club `string` (обязательно) ID клуба

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"

{}

Возвращает список всех доступных валют

GET /api/currencies

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

{}

Возвращает географическое местоположение по IP-адресу.

Параметры

ip `string` (обязательно) IP-адрес для поиска

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"

{}

Возвращает географическое местоположение текущего пользователя по его 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"

{}

Возвращает только публичный IP-адрес запрашивающего клиента (без определения местоположения и без вызова сторонних API). Используется приложением AI Agent, чтобы сравнить публичный IP-адрес браузера с WAN IP-адресом, который сообщает устройство, и определить, находятся ли они в одной сети.

GET /api/geo/client-ip

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

{}

Разбор номера телефона.

Параметры

body `string` (обязательно) Объект JSON с номером, который нужно разобрать.

POST /api/phone/parser

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

{}

Возвращает устройство главных часов

Параметры

club_id `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство.

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"

{}

Возвращает главное устройство Sonos

Параметры

club_id `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство.

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"

{}

получение уведомлений Duress о низком заряде батареи для указанного клуба.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает данные анализа сети

Параметры

club_id `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство.

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"

{}

отправка уведомлений Duress о низком заряде батареи для указанного клуба.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает данные проверки скорости устройств для каждого типа устройств

Параметры

club_id `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство.

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"

{}

Получить аналитику публикаций для объекта. По умолчанию возвращает агрегированные ежедневные итоги по всем площадкам публикации или по одной площадке, если указан `publisherId`.

Параметры

facilityId `string` (обязательно) publisherId `string` (необязательно) startDate `string` (обязательно) endDate `string` (обязательно)

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"

{}

Получить агрегированную аналитику публикаций бренда по всем площадкам публикации.

Параметры

brandId `string` (обязательно) startDate `string` (обязательно) endDate `string` (обязательно)

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"

{}

Самые частые поисковые запросы (с разделением на брендовые и небрендовые) для объекта; сейчас источником является Google Business Profile.

Параметры

facilityId `string` (обязательно) publisherId `string` (необязательно) По умолчанию "google" — сейчас поддерживается только Google. startDate `string` (обязательно) endDate `string` (обязательно) limit `string` (необязательно)

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"

{}

Самые частые поисковые запросы для бренда, агрегированные по всем объектам.

Параметры

brandId `string` (обязательно) startDate `string` (обязательно) endDate `string` (обязательно) limit `string` (необязательно)

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"

{}

Список вопросов и ответов для объекта.

Параметры

facilityId `string` (обязательно)

GET /api/facilities/{facilityId}/qna

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

{}

Ответить на вопрос.

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"

{}

Удалить ответ.

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"

{}

Возвращает площадки публикации, включённые для организации объекта, с состоянием их подключения.

Параметры

facilityId `string` (обязательно) organisationId `string` (обязательно)

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"

{}

Получить общие настройки Door & Gate Access для объекта

Параметры

facilityId `string` (обязательно)

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"

{}

Обновить общие настройки Door & Gate Access для объекта

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Получить Access Policies для объекта

Существующая конфигурация доступа при первом чтении автоматически преобразуется в эквивалентные действующие политики.

Параметры

facilityId `string` (обязательно)

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"

{}

Заменить Access Policies с оптимистической проверкой ревизии

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Создать политику доступа (Access Policy)

Параметры

facilityId `string` (обязательно)

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"

{}

Обновить одну политику доступа (Access Policy)

Параметры

facilityId `string` (обязательно) policyId `string` (обязательно)

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"

{}

Удалить одну политику доступа (Access Policy)

Параметры

facilityId `string` (обязательно) policyId `string` (обязательно) revision `integer` (обязательно)

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"

{}

Дублировать политику доступа (Access Policy) с новым постоянным идентификатором

Параметры

facilityId `string` (обязательно) policyId `string` (обязательно)

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"

{}

Подсчитать затронутых пользователей и двери для всех Access Policies

Параметры

facilityId `string` (обязательно)

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"

{}

Подсчитать пользователей и двери, затронутые политикой доступа (Access Policy)

Параметры

facilityId `string` (обязательно) policyId `string` (обязательно)

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"

{}

Список типов людей, статусов и тегов для объекта

Возвращает уникальные значения типа человека, статуса членства и тегов, встречающиеся в строках User Access объекта (ph-door-access-users), полученные из синхронизации с партнёром и ручного ввода. Приложение door-gate-access использует их для заполнения раскрывающихся списков правил доступа. Теги — это объединение синхронизированных `tags` и административных `customTags`, как в механизме оценки правил.

Параметры

facilityId `string` (обязательно)

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"

{}

Список контроллеров дверей на объекте с их действующими правилами Door & Gate Access

Параметры

facilityId `string` (обязательно)

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"

{}

Сохранить переопределения для отдельной двери, значок и конфигурацию на стороне устройства

Единая точка записи для всего, что административное приложение DGA изменяет для двери: - `accessRulesOverride` / `geofenceOverride` — передайте `null`, чтобы очистить и вернуться к значению объекта по умолчанию. - `icon` — постоянный ключ (см. services/door-access/door-icons.js); для неизвестных значений возвращается 400. - `holdTimeSeconds` (1–30), `maintenanceMode` (`off` / `force-open` / `force-closed`), `doorLocation` (произвольный текст, ≤64 символов), `playNotificationSoundOnRelayToggle` (boolean), `autoUnlockSchedule` (недельная сетка интервалов). Раньше эти поля были только в Device Management, но теперь приложение записывает их на месте, чтобы администраторам не нужно было покидать боковую панель двери ради повседневных изменений конфигурации. Если затронуто любое из полей на стороне устройства, маршрут также передаёт соответствующие переменные среды Balena (`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`) и отправляет команду MQTT `unlockUpdates`, чтобы устройство применило новую конфигурацию, не дожидаясь следующего обновления переменных среды Balena. Выполняется по возможности — ответ 200 возвращается, даже если Balena временно недоступна.

Параметры

facilityId `string` (обязательно) doorId `string` (обязательно)

Тело запроса

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

{}

Облегчённая проверка состояния Balena для уведомления о перезагрузке в боковой панели двери

Боковая панель приложения DGA запрашивает эти данные по требованию, когда администратор открывает дверь, чтобы показать нужный текст «сохранение перезагрузит контроллер»: вариант по умолчанию «несколько секунд» или более строгий вариант «несколько минут», если также ожидается обновление выпуска. Возвращает плоский снимок, полученный из `balena.models.device.get()`. При сбое мягко возвращает `data: null` (вместо ошибки 5xx), чтобы при недоступности Balena упрощался только текст уведомления, а открытие боковой панели не блокировалось.

Параметры

facilityId `string` (обязательно) doorId `string` (обязательно)

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"

{}

Административное переопределение — открыть дверь из приложения

Кратковременно переключает реле на текущее значение `holdTimeSeconds` двери, записывая строку аудита `admin-override` в ph-door-app-access-events, чтобы действие можно было отследить в журналах доступа. Всегда выполняется успешно независимо от `maintenanceMode === 'force-closed'` — это аварийный путь для администратора. Возвращает 200 сразу после отправки публикации MQTT; состояния confirmed / failed / timed_out здесь не ожидаются (устаревший поток /api/devices/door-controllers + /api/ics/devices/command также работает по принципу «отправил и забыл»).

Параметры

facilityId `string` (обязательно) doorId `string` (обязательно)

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"

{}

Воспроизвести на контроллере двери звуковой сигнал для поиска

Публикует команду MQTT `beep`, чтобы контроллер подал три сигнала средней длительности (около 500 мс каждый, пауза около 350 мс, всего около 2 с). Используется администраторами, чтобы найти контроллер двери на месте. Устаревшая кнопка в Device Management подаёт серию коротких сигналов около 30 с, но драйвер зуммера в прошивке надёжно воспроизводит только первый, поэтому приложение отправляет более короткий и надёжный сигнал. Строка аудита не создаётся — это диагностическое действие без влияния на управление доступом.

Параметры

facilityId `string` (обязательно) doorId `string` (обязательно)

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"

{}

Удалённо перезагрузить контроллер двери

Публикует ту же команду MQTT `rebootDevice` по принципу «отправил и забыл», что и устаревшая кнопка «Remotely Reboot Device» в Device Management, но с проверкой модуля `door-gate-access`, чтобы администраторы DGA могли перезагрузить контроллер из раздела Advanced боковой панели двери без отдельного права `device-management`. Возвращает 200 сразу после отправки публикации; на время перезагрузки устройство переходит в офлайн.

Параметры

facilityId `string` (обязательно) doorId `string` (обязательно)

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"

{}

Список строк User Access на объекте

Возвращает все неудалённые строки доступа пользователей на объекте. Поддерживает фильтры на стороне клиента (source, search, accessEnabled, hasGrants). Вычисление `hideExcluded` на стороне сервера (этап 4) будет добавлено, когда появится гибридный механизм оценки прав; пока параметр принимается, но возвращается полный набор.

Параметры

facilityId `string` (обязательно) search `string` (необязательно) source `string` (необязательно) accessEnabled `string` (необязательно) hasGrants `string` (необязательно) hideExcluded `boolean` (необязательно) Если true, синхронизированные пользователи (source != manual), которые не могут пройти ни через одну дверь этого объекта ни в какое время, скрываются. Ответ содержит обёртку `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"

{}

Вручную создать строку User Access на объекте

Создаёт новую строку с `source: 'manual'`. Возвращает 409 с `existingUserId`, если указанный телефон или адрес электронной почты уже соответствует строке на этом объекте.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

Получить одну строку User Access

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Частичное обновление строки User Access

Изменяет любой набор полей идентификации и авторизации. Передайте `null`, чтобы очистить необязательное поле. Возвращает 409, если новый телефон или адрес электронной почты совпадает с другой строкой на том же объекте. `appMessage` принимает ту же структуру, что и сообщение для всего объекта в PUT /api/door-access/rules/{facilityId}: текст, уровень важности, необязательная ссылка, необязательное расписание начала и окончания. Мобильное приложение показывает его на панели только указанному пользователю.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

Тело запроса

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

{}

Мягко удалить строку User Access

Помечает строку `deleted: true` и отключает доступ. Связь журнала аудита с userId сохраняется; администраторы могут снова включить доступ вручную.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Источники доступа пользователя по каждой двери

Для каждой двери возвращает текущую детерминированную авторизацию (`allowedNow`, `allowedVia`, `deniedReason`) и настроенные пути для Access Policies, постоянных прав, расписаний политик, административных прав по временным окнам и актуальных сопоставленных окон из партнёрских источников. Также возвращает текущую и следующую доступность и актуальность источников. Параметры двери blockAllAccess и обслуживание проверяются раньше всех разрешающих путей.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Массово создать строки User Access из импорта CSV

Создаёт несколько строк `source: 'manual'` за один запрос, используя ту же проверку, нормализацию телефона и адреса электронной почты, проверку совпадений в пределах объекта, автоматические сообщения и (необязательно) логику приглашений, что и создание одной строки. Строки обрабатываются по порядку, поэтому более поздняя строка, совпадающая с созданной ранее, отмечается как дубликат. Права передаются как уже определённые идентификаторы дверей и групп (клиент сопоставляет имена с идентификаторами). Права по временным окнам при массовом создании намеренно отклоняются; их нужно добавить через эндпоинт замены для отдельного пользователя после импорта. Никогда не выдаёт исключение для отдельной строки; результат каждой строки сообщается отдельно.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Заменить права гибридной авторизации в строке User Access

Подключение гибридного механизма оценки (этап 3). Права действуют наряду с правилами по тегам объекта — пользователю разрешён доступ, если в момент открытия совпадает любое из них.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

Тело запроса

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

{}

Заменить дополнительные права Access Time Window в строке User Access

Заменяет только `timeWindowGrants`; постоянные `grants` и `sourceTimeWindows` интеграций не затрагиваются. Для каждого элемента требуется область (`facilityWide`, `doors` или `groups`) и абсолютное или недельное `window`. Отправка пустого массива явно очищает все административные окна.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

Тело запроса

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

{}

Заморозить строку User Access от обновлений синхронизации из источника

Устанавливает `decoupledFromSource: true`, очищает все `sourceTimeWindows`, принадлежащие интеграции, и заставляет синхронизацию (cron + потоки) записывать в журнал и пропускать эту строку, пока администратор не сбросит флаг через /recouple.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Снова подключить строку User Access к обновлениям синхронизации из источника

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Отозвать все токены обновления приложения Door & Gate Access пользователя

Отзыв выполняется по сохранённому телефону или адресу электронной почты пользователя (таблица токенов обновления индексируется по `sha256(plaintext)`; индексы GSI byMobilePhone / byEmail позволяют удалить токены одного пользователя во всех записях). Другие пользователи с тем же телефоном или адресом электронной почты на другом объекте также будут разлогинены.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Отправить (повторно) пользователю письмо с приглашением в приложение Door & Gate Access

Принудительно отправляет письмо с приглашением скачать приложение на сохранённый адрес электронной почты пользователя (только электронная почта, без SMS). Игнорирует проверки права на приглашение и уже отправленного письма, используемые при автоматической синхронизации, — это явное действие администратора. Возвращает 400, если у пользователя не указан адрес электронной почты.

Параметры

facilityId `string` (обязательно) userId `string` (обязательно)

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"

{}

Предварительный просмотр получателей массовой отправки приглашений в приложение

Вычисляет набор пользователей, которые получат письмо с приглашением в приложение. Базовый набор — все неудалённые пользователи с адресом электронной почты, которые ещё ни разу не пользовались приложением (`appLastSeenAt` пусто). По умолчанию набор сужается до пользователей, у которых сейчас есть доступ (совпадение правила или право), и которых ещё не приглашали; `includeAlreadyInvited` и `includeNoAccess` расширяют его. Письма не отправляются — возвращаются количества, небольшая выборка и userIds кандидатов для эндпоинта выполнения.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Отправить письма с приглашением в приложение группе пользователей

Отправляет письмо с приглашением скачать приложение каждому из указанных userIds (не более 50 за запрос; клиент разбивает на пакеты полный список кандидатов из предварительного просмотра). Каждый пользователь повторно проверяется в момент отправки: строки, которых больше нет, у которых нет адреса электронной почты или которые воспользовались приложением после предварительного просмотра, пропускаются, а не считаются ошибкой. Результаты сообщаются по каждому пользователю отдельно, чтобы клиент мог подвести итог: отправлено / ошибка / пропущено.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Список групп дверей на объекте

Параметры

facilityId `string` (обязательно)

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"

{}

Создать группу дверей

Параметры

facilityId `string` (обязательно)

Тело запроса

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

Получить одну группу дверей

Параметры

facilityId `string` (обязательно) groupId `string` (обязательно)

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"

{}

Обновить группу дверей

Параметры

facilityId `string` (обязательно) groupId `string` (обязательно)

Тело запроса

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

{}

Мягко удалить группу дверей

Параметры

facilityId `string` (обязательно) groupId `string` (обязательно)

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"

{}

Список партнёрских интеграций, настроенных на объекте

Возвращает партнёрские интеграции объекта (id, name, logo, enabled), объединяя ph-facility-partner-config с каталогом ph-partners. Ограничено модулем door-gate-access (поэтому администраторы без доступа к external-integrations всё равно могут отображать значки партнёров и список синхронизации по партнёрам).

Параметры

facilityId `string` (обязательно)

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"

{}

Прочитать конфигурацию синхронизации User Access для объекта

Параметры

facilityId `string` (обязательно)

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"

{}

Обновить конфигурацию синхронизации User Access для объекта

Принимаются только поля, которыми управляет администратор (`enabled`, `requireIdentifier` и карта партнёров `partners`); `lastRunAt` и `lastRunCounts` записывает сам механизм синхронизации. `partner.partners` — карта включения по партнёрам с ключом partnerId (по умолчанию включено, отключается явно): когда общий `partner.enabled` включён, партнёр синхронизируется, если для него здесь нет явной записи `{ enabled: false }`.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Прочитать конфигурацию автоматических сообщений пользователям для объекта

Параметры

facilityId `string` (обязательно)

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"

{}

Обновить конфигурацию автоматических сообщений пользователям для объекта

Сохраняет правила, а затем сразу заново оценивает все строки User Access на объекте, чтобы существующие пользователи сразу получили или потеряли автоматическое сообщение. Ручные сообщения и отвязанные строки не затрагиваются.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Состояние фоновой повторной оценки автоматических сообщений

Параметры

facilityId `string` (обязательно)

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"

{}

Запустить синхронизацию User Access для объекта по требованию

Синхронно обходит все включённые источники (partner / cctv) на объекте и согласует строки ph-door-access-users с помощью каскадного устранения дубликатов. Возвращает количества по каждому источнику. Отключённые источники отображаются как `skippedSyncDisabled: 1`, а не отсутствуют, чтобы интерфейс мог единообразно показывать обе строки.

Параметры

facilityId `string` (обязательно)

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"

{}

Пробный предварительный просмотр массового удаления синхронизированных с партнёром записей

Возвращает количество и выборку строк доступа пользователей, которые будут мягко удалены, а также confirmToken, который нужно передать обратно в эндпоинт выполнения. Данные не изменяются. Журналы доступа никогда не затрагиваются.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Выполнить массовое удаление синхронизированных с партнёром записей (мягкое удаление)

Мягко удаляет все синхронизированные с партнёром строки доступа пользователей в заданной области. Требует confirmToken, полученный при предварительном просмотре; если фактический набор изменился после просмотра, токен не совпадёт и запрос будет отклонён (409), чтобы администратор проверил его заново. Журналы доступа сохраняются.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Последние действия синхронизации User Access (журнал для устранения неполадок)

Возвращает последние результаты синхронизации для объекта (создано / пропущено / отключено) с причиной, чтобы администраторы видели, почему участник синхронизировался или нет. Сначала новые.

Параметры

facilityId `string` (обязательно) limit `integer` (необязательно)

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"

{}

Список событий Door & Gate Access для объекта

Возвращает события открытия из мобильного приложения, административного переопределения и внешнего Partner API в одной ленте в обратном хронологическом порядке.

Параметры

facilityId `string` (обязательно) from `integer` (необязательно) to `integer` (необязательно) limit `integer` (необязательно)

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"

{}

Пробная оценка геозоны для метки тестового режима администратора

Тело запроса

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

{}

Получить состояние начальной настройки и активации объекта

Используется для начальной страницы «Get Started» приложения и баннера хода настройки. Возвращает текущее количество дверей и пользователей, два вычисляемых основных шага (есть пользователь, есть дверь), сохранённые необязательные флаги «просмотрено» и активирован ли объект (выполнены оба основных шага). Когда объект впервые становится активированным, записывается метка времени activatedAt.

Параметры

facilityId `string` (обязательно)

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"

{}

Обновить необязательные флаги «просмотрено» начальной настройки для объекта

Сохраняет необязательные флаги контрольного списка настройки, которые отмечает администратор (правила доступа, настройки синхронизации, геозоны). Основные шаги и активация вычисляются по текущим количествам данных и здесь задать их нельзя. Возвращает полное обновлённое состояние начальной настройки.

Параметры

facilityId `string` (обязательно)

Тело запроса

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

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

GET /clubs/{clubId}/lead-events

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

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

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"

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

GET /clubs/{clubId}/analytics/referrers

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

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

GET /clubs/{clubId}/analytics/socials

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

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

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"

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

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"

{}

Возвращает ответ JSON с данными аналитики объекта.

Параметры

clubId `string` (необязательно) Идентификатор объекта, для которого нужно получить данные аналитики. fromDate `string` (необязательно) Дата начала периода получаемых данных аналитики. toDate `string` (необязательно) Дата окончания периода получаемых данных аналитики.

GET /clubs/{clubId}/analytics/traffic

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

{}

Создаёт временный JWT (JSON Web Token) для фронтенда, используемый встраиваемыми диаграммами Google Analytics на странице «analytics».

GET /api/ga/onetimetoken

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

{}

Возвращает виджеты панели из «The Training Camp», если у объекта есть активные участники.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает все непросмотренные праздничные дни объекта.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Отметить все непросмотренные праздничные дни объекта как просмотренные.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает отчёт KPI в формате CSV с разбивкой по месяцам за последние 12 месяцев. *NOTE* Создаётся один отчёт по ВСЕМ объектам в системе — не запускайте его несколько раз параллельно, иначе GymMaster будет перегружен!

Параметры

months `string` (необязательно) Количество месяцев (от текущей даты) для получения (по умолчанию 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"

{}

Возвращает графики выручки MMS для указанного объекта.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. range `string` (необязательно) Диапазон в днях (отсчитывается назад от текущей даты), за который нужно получить данные

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"

{}

Возвращает данные и аналитику MMS (Member Management System) для панели указанного объекта. Данные включают статистику GymMaster/Perfect Gym, а также другие внутренние метрики, собираемые нашей системой.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ. range `string` (необязательно) Диапазон в днях (отсчитывается назад от текущей даты), за который нужно получить данные

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"

{}

Возвращает данные виджета Myzone для панели указанного объекта.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает объект со службами, которые считаются недоступными по данным одного или нескольких наших эндпоинтов страницы состояния и мониторинга, настроенных во внутреннем инструменте «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"

{}

Возвращает предстоящие записи на тренировки на ближайшие 7 дней.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно получить доступ.

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"

{}

Возвращает список прошлых праздничных дней объекта.

Параметры

clubId `string` (необязательно) ID клуба fromDate `string` (необязательно) Метка времени Unix для даты начала диапазона возвращаемых праздничных дней. toDate `string` (необязательно) Метка времени Unix для даты окончания диапазона возвращаемых праздничных дней.

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"

{}

Возвращает автоматизации устройств, связанные с объектом.

Параметры

club `string` (обязательно) Внутренний ID клуба, для которого нужно получить список устройств.

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"

{}

Обновляет конфигурацию существующего экрана или устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Добавляет или связывает с вашим объектом физический экран или компьютер.

Параметры

club `string` (обязательно) Внутренний ID клуба, к которому нужно добавить устройство. body `string` (обязательно) JSON-объект нового экрана для привязки.

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"

{}

Даёт устройству команду подключиться к новому SSID по указанным параметрам.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Обновляет конфигурацию существующего экрана или устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Загружает URL-адрес или веб-страницу на экране определённого устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Обновляет конфигурацию существующего экрана или устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) JSON-объект параметров обновления.

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"

{}

Переименовывает экран или устройство. Изменяется только регистрация: в отличие от эндпоинта обновления, на устройство ничего не передаётся, поэтому эндпоинт доступен и для экранов со сборкой ПО, поддержка которой прекращена.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, к которому относится устройство. body `string` (обязательно) Объект JSON с параметрами переименования.

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"

{}

Получает виджеты и ссылки на офлайн-медиа для объекта на указанную дату.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, для которого нужно изменить templated content. date `string` (обязательно) Дата, для которой возвращаются URL-адреса виджетов, в формате `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"

{}

Получает виджеты и ссылки на офлайн-медиа для объекта на указанную дату.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, для которого нужно изменить templated content.

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"

{}

Изменяет templated content для указанного объекта.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, для которого нужно изменить templated content. body `string` (обязательно) Объект JSON с новым templated content.

POST /api/ics/loadprogram/{club}

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

{}

Получает конфигурацию контента существующего экрана или устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, данные контента которого нужно получить.

GET /api/ics/programs/{club}

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

{}

Обновляет конфигурацию контента существующего экрана или устройства.

Параметры

club `string` (обязательно) Внутренний идентификатор объекта, на котором нужно обновить устройство. body `string` (обязательно) Объект JSON с параметрами обновления.

PUT /api/ics/programs/{club}

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

{}

Получает варианты конфигурации контента.

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"

{}

Чат с контекстом RAG. Доступа к инструментам нет — только простой инструмент запроса и ответа API, который позволяет напрямую получать знания из базы знаний.

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан)

Тело запроса

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

{}

Удалить эмбеддинги статьи из векторного хранилища и обновить состояние отслеживания эмбеддингов

Тело запроса

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

{}

Список записей отслеживания эмбеддингов по организации и состоянию

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан) status `string` (обязательно) Состояние для фильтрации (одно из in_queue, done, anomaly, fail, deleted) Limit `string` (необязательно) Максимальное количество элементов на странице LastEvaluatedKey `string` (необязательно) LastEvaluatedKey DynamoDB в формате JSON для разбиения на страницы

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"

{}

Список записей отслеживания эмбеддингов по организации (с необязательным фильтром по типу ресурса)

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан) resourceType `string` (необязательно) Необязательный тип ресурса (например, "article"). Если указан, отбираются записи, у которых resourceTypeId начинается с "{type}#". Limit `string` (необязательно) Максимальное количество элементов на странице LastEvaluatedKey `string` (необязательно) LastEvaluatedKey DynamoDB в формате JSON для разбиения на страницы

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"

{}

Инициализировать коллекцию векторной базы данных организации

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан)

POST /api/llm/init-org

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

{}

Семантический поиск в базе знаний

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан)

Тело запроса

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

{}

Запустить потоковую обработку статей из очереди для создания эмбеддингов с обновлением хода выполнения в реальном времени

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан)

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"

{}

Добавить или обновить эмбеддинги статьи в векторной базе данных

Обрабатывает эмбеддинги статьи в зависимости от её текущего состояния: - Если статья не опубликована ИЛИ является частной: эмбеддинги удаляются - Если статья опубликована И является публичной: эмбеддинги создаются заново по полному содержимому Всегда требуется полный текст статьи.

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется автоматически, если не указан)

Тело запроса

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

{}

Тестовый эндпоинт для пакетного удаления эмбеддингов статей по организации и (необязательно) состоянию

Параметры

organisationId `string` (необязательно) Идентификатор организации (определяется по контексту пользователя, если не указан) status `string` (необязательно) Состояние для фильтрации (необязательно; если не указано, удаляются ВСЕ статьи организации независимо от состояния) hardDelete `string` (необязательно) Удалить записи отслеживания эмбеддингов безвозвратно (true) или мягко, обновив состояние (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"

{}

Преобразовать текст и разбить его на фрагменты с подробной статистикой

Тестовый эндпоинт, который преобразует текст и разбивает его на фрагменты, а затем выдаёт подробную статистику распределения фрагментов, включая количество символов, проценты и метрики качества, чтобы помочь оценить эффективность разбиения.

Тело запроса

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

{}