Introdução

Boas-vindas à API do Performance Hub. Esta API gerencia os dados do clube e os principais sistemas que se integram ao seu clube e aos sistemas externos dele, e não é uma API de consumo público. Para mais informações sobre como usar os diversos sistemas do Performance Hub compatíveis com esta API, consulte a entrada do sistema desejado na [documentação do Performance Hub](https://docs.performancehub.co).

https://portal.hub.gymsystems.co

Autenticação

Os detalhes de autenticação serão fornecidos quando sua integração for aprovada.

Evento "turno do agente concluído" informado pelo dispositivo (gatilho de web push)

Chamado pelo sidecar de um dispositivo de Agente de IA pareado (nunca por navegadores) quando uma execução do agente iniciada pela interface web termina e durou mais que o limite de notificação do dispositivo. Autenticado com um JWT HS256 de curta duração por dispositivo (aud 'events'). Deduplicado por dispositivo+sessão+início e com limite de taxa por dispositivo; depois, é entregue às assinaturas de push HTML5 do usuário que iniciou, com um link direto para a conversa.

Corpo da solicitação

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

{}

Notificação push iniciada pelo agente (skill ph-notify)

Chamado pelo sidecar de um dispositivo de Agente de IA pareado em nome do agente no dispositivo (a skill ph-notify) para enviar uma notificação arbitrária ao navegador e aos dispositivos móveis de um usuário. Autenticado com um JWT HS256 de curta duração por dispositivo (aud 'events'). O usuário de destino precisa ter acesso ao dispositivo (política de acesso por agente); quando omitido, a notificação vai para o proprietário do dispositivo. Limite de taxa por dispositivo, separado dos eventos de turno concluído.

Corpo da solicitação

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

{}

Enviar uma imagem de notificação (skill ph-notify)

Aceita o corpo bruto de uma imagem de um dispositivo pareado (JWT aud 'events') e o armazena no bucket público notify-media sob uma chave UUID impossível de adivinhar. Os objetos são excluídos automaticamente após 7 dias (ciclo de vida do S3). Retorna a URL https pública para uso como `imageUrl` em /ai/events/agent-notify. Limite de 5 MB; somente png/jpeg/gif/webp.

Corpo da solicitação

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

{}

Relay MCP do dispositivo para Connected Apps (ferramentas SaaS externas)

Endpoint MCP HTTP com streaming para dispositivos de Agente de IA emparelhados (servidor MCP "connected_apps" no listener :8790 do sidecar do dispositivo). Autenticado com um JWT HS256 de curta duração por dispositivo (aud 'mcp', a mesma credencial de /mcp) e controlado pelo sinalizador de ativação de Connected Apps do AGENTE (as conexões são por dispositivo de agente, não por instalação). As solicitações são transmitidas para o servidor MCP da sessão da plataforma de ferramentas upstream do próprio agente, com os cabeçalhos da sessão injetados no servidor; as credenciais upstream nunca chegam ao dispositivo. Os nomes das ferramentas e a marca do fornecedor recebem white-label nos dois sentidos durante o trânsito. Um 401/410 upstream (sessão expirada) dispara uma recriação da sessão + uma nova tentativa.

POST /mcp/apps

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

{}

Pesquisar registros de auditoria da API (acesso ao módulo IAM & Admin)

Pesquise e filtre os registros de acesso à API com recursos de filtragem avançados. Os usuários só veem registros das organizações às quais têm acesso.

Parâmetros

organisationId `string` (opcional) ID da organização para verificação de ACL (obrigatório)

Corpo da solicitação

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

{}

Obter estatísticas de registros de auditoria em cache no Redis (acesso ao módulo IAM & Admin)

Recupera estatísticas agregadas do cache do Redis para carregamento instantâneo do painel

Parâmetros

timeWindow `string` (opcional) Janela de tempo das estatísticas (padrão: 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"

{}

Obter estatísticas de registros de auditoria (acesso ao módulo IAM & Admin)

Recupera estatísticas agregadas para o painel. Limitado às organizações do usuário.

Parâmetros

startTime `number` (opcional) Hora de início (timestamp Unix); padrão: 24 horas atrás endTime `number` (opcional) Hora de término (timestamp Unix); padrão: agora

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"

{}

Obter dados de séries temporais dos registros de auditoria (acesso ao módulo IAM & Admin)

Recupera dados de séries temporais agrupados em intervalos para visualizar a linha do tempo das solicitações

Parâmetros

timeWindow `string` (opcional) Janela de tempo dos dados de séries temporais: - 1h: última 1 hora (blocos de 10 minutos) - 12h: últimas 12 horas (blocos de 10 minutos) - 24h: últimas 24 horas (blocos de 10 minutos) - 7d: últimos 7 dias (blocos de 1 hora) - 14d: últimos 14 dias (blocos de 1 hora)

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"

{}

Obter as organizações às quais o usuário tem acesso nos registros de auditoria (acesso ao módulo IAM & Admin)

Retorna a lista de organizações cujos registros de auditoria o usuário atual pode visualizar

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"

{}

A chamada inicial para criar um novo clube. Observe que apenas o objeto de clube 'modelo' é criado; depois, é necessária uma segunda solicitação à API para atualizar o clube com seus dados, como horário de funcionamento, localização, URLs de redes sociais etc.

Parâmetros

body `string` (obrigatório) Objeto JSON do novo clube a ser adicionado ao sistema.

POST /api/admin/clubs/addclub

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

{}

Adiciona um novo usuário ao sistema

Parâmetros

body `string` (obrigatório) Objeto JSON dos dados do usuário que você deseja adicionar/atualizar.

POST /api/users

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

{}

Lista todos os usuários (contas do Google Apps) que têm acesso ao sistema/API de backoffice

GET /api/admin/users/listusers

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

{}

Lista as chaves MCP de um usuário (ocultadas). Os usuários podem listar as próprias chaves.

Parâmetros

userId `string` (obrigatório)

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"

{}

Cria uma nova chave de API MCP para um usuário. Os usuários podem criar as próprias chaves.

Parâmetros

userId `string` (obrigatório) body `object` (opcional)

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"

Revoga/remove uma chave de API MCP. Os usuários podem excluir as próprias chaves.

Parâmetros

userId `string` (obrigatório) keyId `string` (obrigatório)

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"

{}

Remover uma função de um usuário

Parâmetros

userId `string` (opcional) O e-mail do usuário do qual você deseja remover a função. roleId `string` (opcional) O ID da função que você deseja remover do usuário.

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"

{}

Atualiza os detalhes do perfil de um usuário existente (firstName, lastName, phoneNumber)

Parâmetros

userId `string` (obrigatório) Endereço de e-mail do usuário body `object` (obrigatório) Dados do perfil do usuário a atualizar

PATCH /api/users/{userId}

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

{}

Criar ou atualizar uma função de usuário

Parâmetros

body `object` (opcional)

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 em execução no Agente de IA de uma instalação (seletor de publicação)

Busca pelo túnel os Live Services do dispositivo detectados pela bridge para o seletor "Publish to Performance Hub" do applet. Requer o módulo ph-ai-agent E acesso 'open' por dispositivo (o mesmo requisito da própria publicação). Cada serviço é anotado com publishedAppId quando já existe um Custom App para a porta dele.

Parâmetros

club `string` (obrigatório) device `string` (obrigatório)

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"

{}

Índice de nomes de ícones MDI incorporado ao Agente de IA de uma instalação (seletor de ícones)

Faz proxy, pelo túnel, do índice de ícones MDI incorporado à bridge do dispositivo (GET /__services/icons/mdi/index.json). O seletor de publicação/edição usa o catálogo incluído no applet (mesma versão fixada 7.4.47); os SVGs dos apps publicados são resolvidos a partir do pacote @mdi/js local do portal-server. Mesmo requisito de acesso do seletor de serviços (módulo ph-ai-agent + acesso 'open' por dispositivo).

Parâmetros

club `string` (obrigatório) device `string` (obrigatório)

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"

{}

Buscar um lote de SVGs de ícones MDI do Agente de IA de uma instalação (prévias do seletor)

Resolve até 60 glifos MDI nomeados do conjunto de ícones incorporado ao dispositivo em uma única chamada, sanitizados no servidor com a mesma lista de permissões aplicada aos ícones de apps persistidos. Usado pelo seletor de ícones para exibir os resultados da pesquisa; nomes desconhecidos retornam null.

Parâmetros

club `string` (obrigatório) device `string` (obrigatório)

Corpo da solicitação

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

{}

Escopos de público para os quais o solicitante pode publicar a partir desta instalação

O limite de público que o publicador pode conceder no seletor de publicação/edição: as instalações alcançadas pelas funções ph-ai-agent dele (escopo de várias instalações) e se ele tem o nível de organização necessário para públicos de toda a marca / toda a organização na marca/organização desta instalação. As mesmas regras são aplicadas novamente no servidor ao publicar/atualizar (validatePublishAudience); este endpoint apenas molda a interface.

Parâmetros

club `string` (obrigatório)

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"

{}

Preenchimento automático de colegas para um público de app com usuários nomeados

Pesquisa SOMENTE os usuários que o solicitante já pode ver: pessoas cujas funções coincidem com pelo menos uma instalação/região/organização do próprio acesso ph-ai-agent do solicitante. Uma consulta mínima de 2 caracteres e um limite de 10 resultados tornam o endpoint inútil para scraping; o mesmo conjunto de alcance é aplicado novamente no servidor quando o público é salvo.

Parâmetros

club `string` (obrigatório) q `string` (obrigatório)

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"

{}

Publicar um Live Service do Agente de IA como Custom App do Performance Hub

Registra um web app hospedado pelo Agente de IA da instalação (um Live Service detectado pela bridge) como item do menu lateral "Custom Apps" para o público escolhido. Requer o módulo ph-ai-agent nesta instalação E acesso 'open' por dispositivo; o público é limitado pelos escopos das funções do próprio publicador (você nunca pode publicar além do que alcança). A identidade do serviço é resolvida AO VIVO a partir da lista /__services do dispositivo; o esquema http/https nunca é persistido.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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 publicados visíveis nesta instalação

Retorna os apps publicados ativos cujo público abrange esta instalação, no formato que o menu lateral exibe (appId, name, icon, description). O público é resolvido novamente ao vivo a cada chamada, para que as alterações de acesso entrem em vigor imediatamente.

Parâmetros

club `string` (obrigatório)

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"

{}

Apps publicados gerenciados a partir desta instalação (visão do publicador)

Linhas completas dos apps cuja instalação PRINCIPAL é este clube, para a lista de gerenciamento "Published Apps" do applet. Cada linha é anotada com canManage para o usuário solicitante (publicador).

Parâmetros

club `string` (obrigatório)

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"

{}

Emitir um token de visualização restrito ao serviço para um Custom App publicado

Retorna uma URL assinada de curta duração + token que o navegador usa para abrir UM app publicado diretamente no gateway de retransmissão regional do dispositivo. O token contém uma claim svc com a porta do serviço, então o gateway restringe a sessão a /__services/proxy//; o chat/terminal do agente nunca pode ser acessado com ele. Os visualizadores precisam do módulo custom-apps em uma instalação abrangida pelo público do app; NÃO precisam do módulo ph-ai-agent nem de acesso ao agente por dispositivo.

Parâmetros

club `string` (obrigatório) appId `string` (obrigatório)

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"

{}

Atribuição de suporte de um Custom App publicado (contato do proprietário)

Quem dá suporte a este app publicado por um usuário: o e-mail do publicador (ou, na falta dele, o proprietário do agente que o hospeda). Exibido nos painéis de offline/erro do visualizador para que as solicitações de suporte vão para o proprietário do app, e não para o Performance Hub; apps publicados não fazem parte do suporte principal do PH. O público do app é verificado novamente primeiro; visualizadores com quem o app nunca foi compartilhado não recebem nenhuma informação. Apps pausados ainda são resolvidos (os proprietários também respondem a perguntas do tipo "por que está pausado?").

Parâmetros

club `string` (obrigatório) appId `string` (obrigatório)

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"

{}

Enviar por e-mail uma solicitação de suporte ao proprietário de um Custom App publicado

Envia a mensagem do visualizador ao contato de suporte do app (o publicador ou, na falta dele, o proprietário do agente) como um e-mail com a marca: Para o proprietário, CC para o visualizador (como registro da solicitação) e Responder para o visualizador, para que o proprietário responda diretamente a ele. Os apps publicados são mantidos pelos usuários, então isso mantém o suporte deles fora da fila do Performance Hub. O público é verificado novamente; uma solicitação por visualizador por app a cada 15 minutos (intervalo de espera no Redis, fail-open).

Parâmetros

club `string` (obrigatório) appId `string` (obrigatório)

Corpo da solicitação

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

{}

Atualizar um Custom App publicado (nome, ícone, descrição, status, público)

Somente o publicador. As alterações de público são validadas novamente em relação aos escopos das funções do EDITOR, com as mesmas regras de limite da publicação. O status alterna entre ativo e pausado (apps pausados somem dos menus e recusam emissões de token).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Cancelar a publicação de um Custom App (exclusão lógica)

Somente o publicador. Faz a exclusão lógica da linha do registro: o app some dos menus imediatamente e as emissões de token para visualizadores são recusadas; as sessões de gateway já emitidas expiram quando o token expira.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Transferir a propriedade de um Custom App publicado

Espelha o fluxo de reatribuição de proprietário do Agente de IA: o publicador atual ou um proprietário da conta (módulo de faturamento) pode passar o app para outro usuário, que passa a gerenciá-lo. O novo proprietário precisa ter acesso à instalação no clube principal do app.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Exportações de skills preparadas no Agente de IA de uma instalação (seletor de compartilhamento)

Faz proxy, pelo túnel, da lista de exportações preparadas da bridge do dispositivo (GET /__skills/exports) para o seletor "Share a skill" do applet. As exportações são preparadas pela verificação de segurança/portabilidade ph-skill-sharing no dispositivo; cada entrada traz o resultado da verificação feita no dispositivo. Requer o módulo ph-ai-agent E acesso 'open' por dispositivo (o mesmo requisito da própria publicação).

Parâmetros

club `string` (obrigatório) device `string` (obrigatório)

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"

{}

Publicar uma exportação de skill preparada como uma NOVA skill compartilhada (versão de rascunho)

Obtém pelo túnel o tarball da exportação preparada indicada na bridge do dispositivo, extrai-o na memória (path traversal, symlinks e tamanho excessivo são rejeitados), executa a verificação de segurança determinística na nuvem, monta o manifesto a partir do frontmatter do SKILL.md, armazena o tarball endereçado por conteúdo no bucket privado de skills e cria o registro principal da skill + uma versão de RASCUNHO. Um bloqueio na verificação NÃO persiste nada e retorna os resultados. O público é limitado pelos escopos das funções do próprio publicador. Envie o rascunho (POST submit) para publicá-lo.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Publicar uma exportação preparada como NOVA VERSÃO de uma skill compartilhada existente

Mesmo pipeline da publicação, aplicado a uma skill existente: o nome no SKILL.md da exportação precisa corresponder à skill, a versão precisa ser nova (as versões são imutáveis) e um changelog é obrigatório. Somente o publicador pode adicionar versões. Um bloqueio na verificação persiste uma linha de versão com status 'rejected' (somente o relatório, sem artefato) para que os resultados apareçam no histórico do publicador.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Relatório completo da verificação (+ revisão por LLM) de uma versão da skill

A lista completa de resultados de uma versão, somente para o publicador e os administradores da organização (revisões de aprovação); quem instala vê, em vez disso, as contagens resumidas nos detalhes da skill.

Parâmetros

club `string` (obrigatório) skillId `string` (obrigatório) version `string` (obrigatório)

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"

{}

Enviar uma versão de rascunho da skill (publicar ou colocar na fila de aprovação)

Avança uma versão de rascunho conforme a governança da organização. Quando a organização optou pela revisão por LLM, a revisão das instruções é executada primeiro (melhor esforço; um veredito 'fail' rejeita e um veredito 'flag' força a fila de aprovação). Compartilhamentos no nível da instalação são publicados imediatamente, a menos que a governança exija aprovação; compartilhamentos na biblioteca da organização (público da marca/organização) exigem aprovação por padrão. A publicação define o latestVersion da skill; as instalações com política 'auto' o aplicam na próxima varredura de reconciliação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Remover uma skill compartilhada da listagem (retira-a da biblioteca)

Somente o publicador. A skill some da biblioteca e recusa novas instalações imediatamente; as instalações EXISTENTES continuam funcionando, pois remover da listagem é uma ação de listagem, não um botão de desligamento.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Editar a listagem de uma skill compartilhada (nome de exibição, descrição, ícone)

Somente o publicador. Campos apenas de apresentação: o nome canônico da skill é a identidade dela (manifestos, diretórios de instalação, correspondência de versões) e nunca muda. Uma string vazia redefine o campo para null (voltando ao nome canônico / sem ícone). Os ícones usam o catálogo MDI (mdi:icon-name), o mesmo formato dos apps de agente publicados.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Transferir a propriedade de uma skill compartilhada

Espelha o fluxo de transferência de apps publicados: o publicador atual ou um proprietário da conta (módulo de faturamento) pode passar a skill para outro usuário, que passa a gerenciar as versões e a listagem dela. O novo proprietário precisa ter acesso à instalação no clube principal da skill.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Biblioteca de skills visível nesta instalação (filtrada por público)

Skills ativas com pelo menos uma versão publicada cujo público abrange esta instalação (ou nomeia o visualizador), anotadas com o resumo da última versão publicada e a adoção na organização (instalações distintas, nunca contagens brutas de instalações). O público é resolvido novamente ao vivo a cada chamada.

Parâmetros

club `string` (obrigatório)

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"

{}

Detalhes da skill (versões, requisitos, resumo da verificação, adoção)

Detalhes completos de uma skill da biblioteca: histórico de versões com changelogs e resumos de verificação (as listas de endpoints por versão alimentam a comparação de verificação na atualização), requisitos declarados no manifesto, procedência do publicador e o indicador de adoção por número de instalações. O público é verificado novamente: visualizadores com quem a skill nunca foi compartilhada não recebem nenhuma informação (o publicador e os administradores da organização sempre a veem).

Parâmetros

club `string` (obrigatório) skillId `string` (obrigatório)

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"

{}

Skills publicadas a partir desta instalação (lista de gerenciamento do publicador)

Linhas completas das skills cuja instalação PRINCIPAL é este clube, cada uma anotada com canManage para o usuário solicitante e com o resumo da versão mais recente (incluindo rascunhos e aprovações pendentes, pois esta é a visão de trabalho do publicador).

Parâmetros

club `string` (obrigatório)

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"

{}

Instalar uma skill da biblioteca no Agente de IA de uma instalação

Controlado pela governança: o installSources da organização precisa permitir, o público da skill precisa abranger esta instalação (ou nomear o solicitante), a versão precisa estar publicada e o solicitante precisa atender ao nível whoCanInstall do dispositivo de destino (proprietário / usuário permitido / administrador da instalação / administrador da organização; consulte a governança). Grava a linha do ciclo de vida da instalação (a fonte da verdade) e faz um envio imediato em melhor esforço; o cron de reconciliação garante a entrega assim que o dispositivo estiver acessível.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Aprovar uma atualização de skill pendente para uma instalação

Move o desiredVersion da instalação para a versão publicada mais recente (a etapa manual das políticas 'notify' e 'pinned', e o caminho quando a governança define updatePosture como 'approvalRequired'). Mantém a versão atual como destino de reversão em uma etapa e limpa qualquer fixação de atualização pós-reversão (skipVersion). Mesmo nível de permissão whoCanInstall da instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Reverter uma skill instalada para a versão anterior

Define desiredVersion como o previousVersion da linha da instalação (mantido a cada mudança de versão) e deixa o caminho normal de entrega reinstalá-la. Em uma etapa: as versões são trocadas, então reverter duas vezes volta ao ponto de partida. Também fixa as atualizações (skipVersion = a versão da qual se reverteu) para que as políticas auto/notify mantenham a reversão; a fixação é limpa quando uma versão estritamente mais nova é publicada, em update-approve ou em set-policy.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Desinstalar uma skill do Agente de IA de uma instalação

Marca a linha da instalação como pending-uninstall e envia o estado desejado; a linha é excluída assim que o dispositivo confirma a remoção (leitura de retorno da reconciliação). Mesmo nível de permissão whoCanInstall da instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Definir a política de atualização por instalação de uma skill em um dispositivo

auto (a reconciliação aplica automaticamente as novas versões publicadas, a menos que o updatePosture da organização exija aprovação), notify (o proprietário é notificado uma vez por nova versão e a aplica manualmente) ou pinned (nunca muda sem um update-approve explícito). Alterar a política limpa qualquer fixação de atualização pós-reversão (skipVersion). Mesmo nível de permissão whoCanInstall da instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Instalações de skills no Agente de IA de uma instalação (aba Skills)

As linhas do ciclo de vida das instalações de um dispositivo, cada uma anotada com os campos de listagem da skill e se existe uma versão publicada mais nova. Requer acesso 'open' por dispositivo (a aba Skills fica dentro do painel do agente).

Parâmetros

club `string` (obrigatório) device `string` (obrigatório)

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"

{}

Versões de skills aguardando aprovação na organização desta instalação

A fila de aprovação dos administradores da organização: todas as versões com aprovação pendente nas skills da organização, com a listagem da skill e os resumos da verificação/LLM. Somente administradores da organização.

Parâmetros

club `string` (obrigatório)

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"

{}

Aprovar uma versão de skill pendente (publica-a)

Somente administradores da organização. A versão passa a ser publicada, o latestVersion da skill é atualizado e o publicador é notificado. As instalações com política 'auto' aplicam a versão na próxima varredura de reconciliação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Rejeitar uma versão de skill pendente

Somente administradores da organização. A versão passa a ser rejeitada com o motivo do revisor e o publicador é notificado; ele pode corrigir os problemas encontrados e enviar uma nova versão (as versões são imutáveis).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Governança de Agent Skills em vigor na organização desta instalação

A política armazenada da organização mesclada sobre os padrões da plataforma (uma organização sem linha armazenada vê apenas os padrões). Somente administradores da organização.

Parâmetros

club `string` (obrigatório)

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"

{}

Atualizar a governança de Agent Skills na organização desta instalação

Atualização parcial: somente os campos informados mudam; todo o resto mantém o valor armazenado/padrão. Somente administradores da organização. As substituições por dispositivo ficam na linha de registro, por meio das rotas de configuração de dispositivo existentes.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Obter dados ambientais de uma instalação

Retorna as condições meteorológicas atuais, incluindo nascer/pôr do sol (via Open-Meteo), e a temperatura interna da instalação (dos sensores de Duress) do clube especificado. Armazenado em cache no Redis por 30 minutos.

Parâmetros

clubId `string` (obrigatório) ID interno do clube/instalação

GET /api/clubs/{clubId}/environment

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

{}

Adiciona/associa um dispositivo IoT genérico a um clube.

Parâmetros

club `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo. body `string` (obrigatório) Objeto JSON da nova tela a associar.

POST /api/devices/addGenericDevice/{club}

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

{}

Remover e restaurar as configurações de fábrica de uma tela

Remove a associação ativa da tela com a instalação e programa uma restauração de fábrica persistente. Uma tela desligada aplica a restauração depois que for ligada e se reconectar, e então volta à página de pareamento HDMI. Os registros históricos de faturamento são mantidos.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Associa um controlador de porta a uma instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Atualiza as configurações do controlador de porta de uma instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Desativa um controlador de porta de uma instalação.

Parâmetros

club `string` (obrigatório)

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"

{}

Retorna a configuração dos relés de um controlador de porta.

Parâmetros

uuid `string` (obrigatório)

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"

{}

Retorna os metadados do dispositivo

Parâmetros

uuid `string` (obrigatório) ID exclusivo do dispositivo

GET /api/devices/metadata/{uuid}

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

{}

Retorna os metadados do dispositivo. A resposta é a linha de metadados no nível superior (formato legado) mais `detectedType` (camera | ai-edge-processor | door-controller | ph-ai-agent | null) e `online` (true quando atualizado nos últimos 5 minutos).

Parâmetros

deviceSerialNumber `string` (obrigatório) Número de série do dispositivo

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"

{}

Retorna os dados de Smart Club do clube.

Parâmetros

club_id `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo.

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"

{}

Retorna todos os dispositivos associados a um clube específico.

Parâmetros

club `string` (obrigatório) ID interno do clube cujos dispositivos você deseja listar.

GET /api/devices/list/{club}

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

{}

Retorna todas as versões de aplicativos para os nossos dispositivos balena.

GET /api/devices/listReleases

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

{}

Move um dispositivo para uma nova instalação (clube) e atualiza os sistemas relacionados.

Parâmetros

club `string` (obrigatório) ID da instalação de origem (clube atual do dispositivo) body `object` (obrigatório) Parâmetros da transferência

POST /api/devices/move/{club}

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

{}

Tenta estabelecer uma conexão com o roteador de uma instalação selecionando o melhor dispositivo do clube e enviando um comando MQTT para criar um túnel.

Parâmetros

facilityID `string` (obrigatório) ID interno da instalação com cujo roteador a conexão está sendo tentada.

GET /api/devices/openRouterWebpage/{facilityID}

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

{}

Catálogo de Cloud Agents (zonas, tamanhos, preços de venda ao vivo)

Parâmetros

club `string` (obrigatório)

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"

{}

Fazer uma cotação de Cloud Agent (software + hospedagem)

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"

Iniciar um Cloud Agent (enfileirar provisionamento + associação automática)

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

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

Status do job do 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"

Eliminar um Cloud Agent (VM + balena + registro)

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"

Resolver uma remoção de Cloud Agent pendente (tentar o backup novamente, excluir sem backup ou cancelar)

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"

Listar os Connected Apps de um agente (suítes + apps com contas conectadas)

Retorna o estado dos Connected Apps do agente: a flag de ativação, os resumos por suíte (Google Workspace, Microsoft 365) e o catálogo selecionado de apps com as contas conectadas de cada app (várias contas: um agente pode ter várias contas por app, cada uma com um alias opcional), resolvidos a partir da sessão upstream do agente.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

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"

{}

Catálogo completo do marketplace de Connected Apps de um agente

Retorna todos os apps conectáveis (o catálogo completo de toolkits com autenticação gerenciada, em cache no servidor por ~12h) com os níveis de destaque/suíte e as contas conectadas do agente por app, mais os resumos por suíte e as solicitações de conexão pendentes do agente: um único payload para o marketplace de apps pesquisável no lado do cliente.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

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"

{}

Dispensar uma solicitação de conexão pendente do agente

Marca como dispensada a solicitação de conexão pendente do agente para um toolkit (ela desaparece da seção "Requested by your agent" do marketplace). Idempotente: dispensar uma solicitação que não está pendente não tem efeito.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Ativar ou desativar os Connected Apps de um agente

Persiste a chave de Connected Apps do agente e envia a variável de dispositivo Balena PH_APPS_MCP_ENABLED somente para esse dispositivo (melhor esforço: a flag no PH é o bloqueio definitivo na retransmissão MCP).

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Iniciar a conexão de um único app a um agente (fluxo OAuth Connect Link)

Inicia um fluxo hospedado Connect Link para um toolkit e retorna a URL para a qual enviar o usuário. Um alias opcional identifica a nova conta (várias contas: conectar um app já conectado adiciona OUTRA conta, até 10 por app). Passa pelo mesmo callback encadeado das conexões de suítes (uma suíte com um único toolkit), então a conclusão volta para a página do applet ph-ai-agent.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Payload de preparação da conexão de um app (modo, campos de credenciais, guia de configuração)

Tudo o que a caixa de diálogo de conexão precisa antes de iniciar uma conexão: como o app se conecta (oauth = fluxo de consentimento hospedado, credentials = formulário no produto), os campos de credenciais a coletar no modo de credenciais e o guia de configuração no produto (escrito para apps prioritários; caso contrário, gerado a partir dos metadados dos campos do app, nunca um link para documentação externa). Apps OAuth do tipo bring-your-own também informam se o app OAuth do cliente já está registrado para ESTE agente (byoConfigured) e a URL de redirecionamento a registrar no provedor.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente. toolkit `string` (obrigatório)

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"

{}

Conectar um app com credenciais fornecidas pelo usuário (chave de API etc., sem OAuth)

Cria uma conta conectada para um app no modo de credenciais diretamente a partir do formulário no produto, sem fluxo de consentimento hospedado. Os campos de credenciais vêm do payload connect-info do app; todos os campos obrigatórios precisam ser informados. As credenciais são validadas com o provedor quando há suporte (melhor esforço: alguns apps só rejeitam uma chave errada na primeira chamada de ferramenta do agente). Um alias opcional identifica a nova conta (várias contas: conectar um app já conectado adiciona OUTRA conta).

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Registrar o app OAuth próprio do cliente para um app BYO e iniciar o fluxo de conexão dele

Para apps OAuth do tipo bring-your-own (Xero, Shopify...): recebe o client ID e o client secret do app OAuth que o cliente criou no provedor (com a ajuda do guia de configuração do app), registra-o para ESTE agente (o secret é armazenado apenas na plataforma de integração upstream, nunca no Performance Hub) e inicia imediatamente o fluxo de login hospedado com ele. Retorna a URL de consentimento para a qual enviar o usuário, com o mesmo contrato do endpoint de conexão. Enviar novamente substitui o app registrado do agente (por exemplo, após a rotação do secret); as contas conectadas existentes continuam funcionando.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Iniciar a conexão de uma suíte com um clique para um agente (fluxos Connect Link encadeados)

Inicia o fluxo de conexão encadeado para uma suíte inteira (por exemplo, google-workspace). A URL retornada abre a tela de consentimento do primeiro toolkit; cada conclusão redireciona (302) diretamente para o fluxo do próximo toolkit, terminando na página do applet ph-ai-agent. Os membros que já têm uma conta conectada são IGNORADOS, então tentar novamente após uma falha no meio da cadeia retoma com os apps que faltam, em vez de criar contas duplicadas. Quando todos os membros já estão conectados, a cadeia completa é executada novamente: esse é o fluxo explícito de "adicionar outra conta".

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Desconectar uma conta conectada de um agente

Exclui uma única conta conectada (várias contas: as outras contas do mesmo app continuam conectadas). Antes da exclusão, é validado que a conta pertence a este agente; quando era a ÚLTIMA conta do app, o toolkit é removido do conjunto conectado do agente (a sessão é recriada sob demanda para que a lista de ferramentas do agente seja atualizada).

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Renomear (alterar o alias de) uma das contas conectadas de um agente

Define o alias de exibição de uma única conta conectada. Normalmente, os aliases são definidos automaticamente após o OAuth (a partir da identidade conectada); este endpoint dá suporte à renomeação manual na caixa de diálogo de detalhes do app. Um alias vazio limpa o rótulo. Antes da atualização upstream, é validado que a conta pertence a este agente.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente.

Corpo da solicitação

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

{}

Ativar ou desativar um serviço integrado do Performance Hub para um agente

Ativa ou desativa, para este agente, um serviço integrado sempre ativo (Smart Search, Weather...). Os serviços integrados não precisam de conexão nem de OAuth: vêm incluídos em todos os agentes e ativados por padrão; esta opção persiste a substituição por agente e recria imediatamente a sessão upstream do agente para que o conjunto de ferramentas seja atualizado. Observe que a chave separada "External apps" (a rota /enable) é um desligamento definitivo de todo o servidor MCP de apps: quando está desativada, os serviços integrados também ficam indisponíveis, independentemente das opções individuais.

Parâmetros

facilityId `string` (obrigatório) deviceId `string` (obrigatório) O UUID balena do dispositivo do agente. slug `string` (obrigatório) Slug do serviço integrado.

Corpo da solicitação

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

{}

Associar um dispositivo de Agente de IA a uma instalação

Associação baseada primeiro nos metadados. Procura o dispositivo pelo número de série nos metadados ao vivo dos dispositivos, exige que esteja online e então cria sob demanda a linha de registro, atribui uma região de retransmissão Chisel + porta do túnel + secret, registra esse slot na retransmissão e envia a configuração da instalação + do túnel ao dispositivo via Balena. Os novos dispositivos também recebem uma conta de serviço MCP padrão (ativada, restrita a esta instalação, com todos os recursos); o novo pareamento mantém qualquer concessão MCP existente. Configurações avançadas opcionais substituem os padrões aplicados no momento do pareamento (configuração de backup, MCP ativado/desativado, restrição de acesso), e `restoreFrom` inicializa o novo dispositivo a partir do backup na nuvem de outro dispositivo da instalação (origem ativa ou desativada; coloca na fila uma restauração entre repositórios, retornada como `restoreRequest` para acompanhar o progresso).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Listar os dispositivos de Agente de IA de uma instalação

Retorna os dispositivos de Agente de IA da instalação com o status ao vivo de conexão + túnel (usado pelo seletor de dispositivos do applet).

Parâmetros

club `string` (obrigatório)

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"

{}

Atualização + status online do Agente de IA

Informa se o dispositivo está online, se há uma atualização disponível/pendente e a versão oferecida (a versão fixada da frota quando ela está fixada; a mais alta bem-sucedida quando a frota acompanha a mais recente).

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Status ao vivo + métricas do dispositivo de Agente de IA

Retorna um instantâneo selecionado para a faixa de métricas e o painel de gerenciamento do applet: campos de identidade + registro, atividade + conexão, versões de software e as métricas de heartbeat mais recentes (CPU, temperatura, memória, armazenamento por ponto de montagem, tempo de atividade, rede). Combina o beacon de metadados do dispositivo + o status de atualização do Balena; qualquer uma das metades pode faltar durante uma interrupção temporária.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Narrativa de IA para o relatório de integridade do dispositivo

Retorna uma breve explicação, voltada ao operador, dos problemas de integridade identificados no momento. Os fatos e as etapas do playbook estão sempre em device-status; este parágrafo extra é de melhor esforço e pode ser null.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Emitir um token de acesso direto à retransmissão para um Agente de IA

Retorna uma URL assinada de curta duração que o navegador usa para se conectar DIRETAMENTE ao gateway de retransmissão regional do dispositivo (eliminando o salto global PH/Sydney), mais o token HS256. O PH continua sendo a autoridade (Google SSO + verificações de módulo/instalação aqui); o relay-gateway verifica o token. O proxy /ai-agent-ui continua sendo a alternativa.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Enviar uma mensagem de chat para uma sessão do Agente de IA (resposta direta na notificação)

Retransmissão no servidor usada pela ação de resposta direta da notificação web push: o service worker faz POST aqui (mesma origem, cookies de SSO) para que a resposta funcione sem nenhuma aba do Performance Hub aberta. O PH resolve o destino de retransmissão do dispositivo (mesma consulta do proxy /ai-agent-ui), adiciona x-ph-user para atribuir o turno (o push de conclusão resultante volta para este usuário) e encaminha para /api/chat/start do dispositivo com o ID da sessão.

Corpo da solicitação

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

{}

Ler as configurações de controle de acesso de um Agente de IA (proprietário)

Retorna o bloco de acesso do dispositivo (modo, lista de permissões, visibilidade, opção PH Support) mais as solicitações de acesso pendentes. Pode ser lido pelo proprietário do dispositivo; os outros usuários recebem 403.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Atualizar as configurações de controle de acesso de um Agente de IA (proprietário)

Grava o modo (org/restricted), a lista de permissões restrita, a visibilidade da lista (all/admins) e a opção "permit access from Performance Hub Support". Permitido para o proprietário do dispositivo. O próprio proprietário só pode ser alterado via reallocate-owner. As solicitações de acesso aprovadas são persistentes: os solicitantes ainda aprovados são incluídos novamente na lista de permissões salva; remover um deles da lista enviada revoga a aprovação (a solicitação passa a negada; ele pode solicitar novamente).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Reatribuir o proprietário de um Agente de IA

Reatribui a propriedade do dispositivo a outro usuário do Performance Hub. Restrito aos proprietários da conta (acesso ao módulo de faturamento SaaS): a saída de emergência quando o proprietário de um agente restrito sai. O proprietário anterior e o novo são notificados (no app + push + e-mail).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

POST /api/devices/ph-ai-agent/reallocate-owner/{club}

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

{}

Lista de usuários da instalação para os seletores de lista de permissões / proprietário do Agente de IA

Retorna o e-mail + nome (+ flags isOrgAdmin) de todos os usuários cuja função dá acesso a ESTA instalação. Restrito ao proprietário do dispositivo e a quem pode reatribuí-lo (proprietário da conta), para que usuários comuns não possam enumerar a base de usuários.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Solicitar acesso a um Agente de IA restrito

Cria (ou reabre) a solicitação de acesso do solicitante a um dispositivo restrito; idempotente por usuário+dispositivo. O proprietário é notificado no app, por web push e por e-mail, com um link direto para o módulo do agente.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Aprovar ou negar uma solicitação de acesso a um Agente de IA (proprietário)

Resolução de uma solicitação pendente pelo proprietário do dispositivo. Aprovar adiciona o solicitante à lista de permissões do dispositivo; em qualquer dos casos, o solicitante é notificado (no app + push + e-mail).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Permitir + aplicar uma atualização do Agente de IA

Fixa o dispositivo na versão oferecida (a versão fixada da frota ou a mais alta bem-sucedida quando a frota acompanha a mais recente) e libera o bloqueio de atualização para que o supervisor do balena a aplique. O estado no volume de dados do dispositivo é preservado na atualização.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Agendar uma atualização do Agente de IA para mais tarde

Armazena um horário de instalação agendado no registro do dispositivo. Um job recorrente do back-end (a cada 5 minutos) aplica a atualização (fixação + desbloqueio) assim que o horário agendado passa. O agendamento substitui qualquer agendamento existente do dispositivo.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Cancelar uma atualização agendada do Agente de IA

Limpa a instalação agendada pendente do dispositivo (sem efeito quando não há nada agendado).

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Executar um comando remoto em um dispositivo de Agente de IA

Publica um comando MQTT da lista de permissões (reinicializar, reiniciar um contêiner, bloquear/desbloquear atualizações, gerenciamento de Wi-Fi) no device-controller em execução no Agente de IA. O dispositivo precisa estar associado à instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Atualizar a configuração de um Agente de IA voltada para a instalação

Salva as configurações editáveis pelo operador de um Agente de IA associado: o nome do dispositivo, a localização física do dispositivo e a frequência da reinicialização agendada. O agendamento de reinicialização também é enviado ao dispositivo como a variável de ambiente REBOOT_DEVICE do Balena (2h no horário local), igual ao comportamento das Display Screens.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Instalações para as quais um Agente de IA desta instalação pode ser movido

Retorna as instalações da mesma organização que o usuário conectado pode acessar (exceto a instalação atual), para o seletor "Mover para outra instalação". A movimentação em si é feita por POST /api/devices/move/:club, que aplica no servidor as mesmas regras de mesma organização e de acesso ao destino.

Parâmetros

club `string` (obrigatório)

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"

{}

O conjunto de acesso MCP que o solicitante pode conceder aos Agentes de IA de uma instalação

Retorna o que o usuário conectado pode conceder a uma conta de serviço MCP de Agente de IA na organização desta instalação: as instalações e regiões dentro do próprio acesso dele, se ele pode conceder escopo para toda a organização, o conjunto de módulos que ele possui e o catálogo completo de ferramentas MCP (para a máscara avançada por ferramenta). A interface usa isso para que os usuários vejam apenas opções dentro do próprio conjunto de permissões; o endpoint POST mcp-access aplica a mesma atenuação no servidor.

Parâmetros

club `string` (obrigatório)

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"

{}

Obter a configuração da conta de serviço MCP de um Agente de IA

Retorna a configuração de acesso MCP do dispositivo (escopo, módulos, máscara de ferramentas, campos de auditoria).

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Configurar a conta de serviço MCP de um Agente de IA

Salva a configuração de acesso MCP do dispositivo com atenuação no momento da concessão. Os solicitantes só podem conceder instalações e regiões dentro do próprio acesso, escopo de organização apenas quando possuem uma função para toda a organização e módulos que eles mesmos possuem na organização da instalação. O sinalizador enabled também é enviado ao dispositivo como a variável de ambiente PH_MCP_ENABLED do Balena.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Obter a configuração de VPN de um Agente de IA (com dados ocultados)

Retorna o sinalizador de suporte a VPN do dispositivo e a lista de conexões. O conteúdo dos perfis e os valores das credenciais nunca são retornados, apenas os metadados da importação (remotos, rotas, DNS) e sinalizadores has-credential. O estado em tempo real de cada conexão vem do endpoint device-status (beacon metadata.vpn).

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Ativar ou desativar o suporte a VPN de um Agente de IA

Ativa ou desativa o recurso de VPN do dispositivo. Envia a variável de dispositivo PH_VPN_ENABLED do Balena e notifica o dispositivo (MQTT vpnConfigChanged); as conexões são mantidas quando o recurso é desativado (os túneis param; a configuração permanece para reativação).

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

Corpo da solicitação

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

{}

Importar perfis OpenVPN para um Agente de IA

Aceita uploads codificados em base64: arquivos .ovpn/.conf únicos, pacotes de arquivos separados (configuração + certificados/chaves) e arquivos compactados (.zip, exportações .tar/.tgz do Pritunl, .tblk do Tunnelblick, .visc/.visz do Viscosity). Os perfis são normalizados para um formato inline canônico; cada perfil se torna uma conexão (importada desconectada: informe as credenciais e depois conecte). Retorna erros 400 com orientação para uploads inutilizáveis.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

Corpo da solicitação

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

{}

Atualizar uma conexão VPN de um Agente de IA (nome / credenciais / DNS dividido)

Atualiza a conexão armazenada. Os campos de credenciais são somente gravação (omitido = manter o valor armazenado; string vazia = limpar). Alterações de credenciais ou de DNS dividido incrementam a revisão da conexão para que um túnel ativo reinicie com os novos valores.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

Corpo da solicitação

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

{}

Excluir uma conexão VPN de um Agente de IA

Remove a conexão do registro e notifica o dispositivo, que desativa o túnel e apaga o perfil e as credenciais em cache.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) connectionId `string` (obrigatório)

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"

{}

Conectar / desconectar uma conexão VPN de um Agente de IA

Modelo de estado desejado: define o sinalizador enabled da conexão no registro e notifica o dispositivo (MQTT vpnConfigChanged sem payload); o dispositivo obtém o estado oficial por meio da chamada universal-api autenticada por JWT e reconcilia os túneis. Uma notificação perdida é compensada na sincronização periódica.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

Corpo da solicitação

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

{}

Obter a configuração e o status do backup em nuvem de um Agente de IA

Retorna as configurações de backup do dispositivo (ativado, retenção, região de armazenamento), o status contínuo do backup (último backup, tamanho, erros), a região automática resolvida e as regiões de armazenamento disponíveis para o seletor. A senha do repositório restic nunca é retornada.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Atualizar a configuração de backup em nuvem de um Agente de IA

Salva ativação, retenção e região. Entra em vigor no próximo ciclo de backup por hora do dispositivo (o dispositivo solicita ao PH o contexto de execução antes de cada execução), portanto não é necessário reiniciar o dispositivo.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Listar origens de restauração de backup para emparelhar um novo Agente de IA

Visão de toda a instalação para a opção "restaurar a partir de um backup" da caixa de diálogo de adição de agente: todos os registros da instalação (ativos E desativados/substituídos) que ainda têm um repositório de backup descriptografável e pelo menos um ponto de restauração utilizável, com os snapshots mais recentes. Também retorna as listas de opções de configuração de backup (allowedRetentionDays, availableRegions) para que a caixa de diálogo não precise de um UUID de dispositivo para preencher os seletores.

Parâmetros

club `string` (obrigatório)

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"

{}

Listar os pontos de restauração de backup de um Agente de IA

Retorna o índice de snapshots do dispositivo (mais recentes primeiro) a partir do DynamoDB, sem ida e volta ao dispositivo ou ao repositório, além do estado atual das solicitações de backup manual e de restauração para a consulta periódica do painel lateral. Solicitações obsoletas (nunca recebidas ou sem sinal de progresso) são apresentadas como falhas para que a interface sempre possa enviar uma nova.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório)

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"

{}

Solicitar agora um backup manual de um Agente de IA

Grava uma solicitação de execução manual (com a observação do usuário) na linha de registro e notifica o dispositivo via MQTT. O dispositivo obtém a solicitação verificada por meio da chamada run-context da universal-api autenticada por JWT; mesmo sem MQTT, ela é recebida no próximo ciclo do agendador. É rejeitada enquanto outro backup ou restauração estiver em andamento.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Fixar ou desafixar um ponto de restauração de um Agente de IA

Pontos de restauração fixados são protegidos da limpeza por retenção (a manutenção noturna do dispositivo recebe os IDs dos snapshots fixados pela chamada run-context e os exclui do restic forget), e as linhas de índice deles nunca expiram por TTL. Desafixar restaura o comportamento normal de retenção.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Restaurar um Agente de IA a partir de um ponto de restauração de backup

Grava uma solicitação de restauração na linha de registro e notifica o dispositivo. Restaurações completas sobrescrevem /data e /home/hermeswebui (o dispositivo primeiro cria um snapshot de segurança automático pré-restauração e interrompe o agente durante a restauração) e exigem que o nome do dispositivo seja digitado como confirmação. Informar `paths` executa, em vez disso, uma restauração não disruptiva no nível de arquivo apenas desses caminhos. Opcionalmente, fixa o dispositivo de volta na versão de software do snapshot quando a restauração dos dados é concluída (consulte backup-restore-release).

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Aplicar a versão de software registrada em uma restauração concluída

Etapa final de uma restauração que solicitou a versão de software do snapshot: assim que o dispositivo informa que a restauração dos dados foi concluída, fixa o dispositivo na versão armazenada e desbloqueia as atualizações (mesma mecânica do endpoint de atualização). Acionada pela consulta periódica do painel lateral; idempotente: a fixação armazenada é limpa após a aplicação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Navegar pelos arquivos de um ponto de restauração de backup

Lista um nível de diretório de um snapshot restic, fornecido inteiramente pelo servidor a partir do repositório Wasabi (funciona com o dispositivo off-line). Apenas os metadados da árvore são lidos; nenhum dado de arquivo é baixado para as listagens.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) takenAt `number` (obrigatório) path `string` (opcional)

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"

{}

Pesquisar nomes de arquivo em um ponto de restauração de backup

Pesquisa de nomes de arquivo sem diferenciar maiúsculas e minúsculas a partir de um diretório para baixo, feita no servidor com os metadados da árvore restic (nenhum dado de arquivo é lido; funciona com o dispositivo off-line). Transmite a listagem e para nas primeiras 200 correspondências.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) takenAt `number` (obrigatório) q `string` (obrigatório) path `string` (opcional)

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"

{}

O que mudou entre dois pontos de restauração de backup

Executa no servidor um restic diff entre dois snapshots do dispositivo (somente metadados da árvore) e retorna a lista de arquivos adicionados/removidos/modificados (limitada a 500 alterações), além de estatísticas resumidas. Os resultados ficam em cache, pois os snapshots são imutáveis.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) fromTakenAt `number` (obrigatório) toTakenAt `number` (obrigatório)

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"

{}

Histórico de versões de um arquivo em todos os pontos de restauração

Um único restic find no servidor em todos os snapshots do repositório do dispositivo, agrupado em versões DISTINTAS (ocorrências consecutivas com tamanho e mtime idênticos são mescladas) e associado às linhas do índice de snapshots para datas, tipos e observações.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) path `string` (obrigatório)

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"

{}

Pesquisar por nome de arquivo em todos os pontos de restauração dos backups de um dispositivo

O caminho de recuperação de arquivos excluídos: um único restic find no servidor em TODOS os snapshots do repositório (sem diferenciar maiúsculas e minúsculas, por substring ou glob), agrupado por caminho com os pontos de restauração em que cada arquivo aparece. Um arquivo excluído do dispositivo ainda pode ser encontrado aqui enquanto algum ponto de restauração o contiver.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) q `string` (obrigatório)

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"

{}

Baixar um único arquivo de um ponto de restauração de backup

Transmite um arquivo diretamente do repositório restic para o navegador (como anexo). Diretórios são transmitidos como um arquivo tar. Com limite de tamanho; fornecido pelo servidor, portanto funciona com o dispositivo off-line.

Parâmetros

club `string` (obrigatório) uuid `string` (obrigatório) takenAt `number` (obrigatório) path `string` (obrigatório)

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"

{}

Desativar um Agente de IA de uma instalação

Parâmetros

club `string` (obrigatório)

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"

{}

Remover um Agente de IA de uma instalação e restaurar o hardware para as configurações de fábrica

Desassocia totalmente o dispositivo para que ele possa ser emparelhado em QUALQUER instalação e apaga todos os dados do NUC. A limpeza é armada pela variável de dispositivo PH_FACTORY_RESET do Balena (um nonce de uso único) ANTES da desmontagem na nuvem, então ela é mantida mesmo que o dispositivo esteja off-line no momento da remoção: a limpeza é executada na próxima conexão. Uma notificação MQTT factoryReset torna o caso on-line imediato. Em seguida, a desmontagem na nuvem revoga todas as credenciais e concessões, limpa o vínculo de instalação no Balena (variáveis do dispositivo + tag club) e o clubID dos metadados, e exclui as solicitações de acesso e o registro DNS da LAN. Os backups em nuvem são MANTIDOS: o índice de snapshots e a senha do repositório permanecem no registro excluído logicamente, utilizáveis como origem de restauração ao adicionar um substituto. Exige que o nome do dispositivo seja digitado como confirmação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Substituir um Agente de IA inoperante por um novo NUC (recuperação de desastres)

Substituição do dispositivo em uma única etapa: associa o NUC substituto (slot de túnel, segredos, variáveis do Balena, semente de backup), transfere o nome, a localização, o agendamento de reinicialização, as configurações de backup, o bloqueio de acesso e a concessão MCP do dispositivo antigo, reatribui o índice de snapshots antigo ao novo dispositivo (para que todo o histórico de backup continue navegável), desativa o registro antigo (marcado com replacedBy / replacedFrom) e, a menos que `restore` seja false, enfileira uma restauração completa do ponto de restauração escolhido a partir do repositório de backup do dispositivo ANTIGO para o novo hardware. Funciona com o dispositivo antigo inoperante/off-line; exige que o nome do dispositivo antigo seja digitado como confirmação. Somente na mesma instalação.

Parâmetros

club `string` (obrigatório)

Corpo da solicitação

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

{}

Resolve um link curto de QR de dispositivo do Performance Hub para o link direto ao qual ele aponta, para que o leitor de Adicionar dispositivo possa detectar o tipo de dispositivo. Apenas hosts performancehub.co são seguidos.

Parâmetros

url `string` (obrigatório) O link curto lido

GET /api/devices/resolve-qr

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

{}

Testa a conectividade com o controlador Unifi de uma instalação e se as credenciais estão corretas.

Parâmetros

facilityID `string` (obrigatório) ID interno da instalação com a qual você quer testar a conectividade 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"

{}

Atualiza um dispositivo IoT genérico com uma instalação.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

PUT /api/devices/updateGenericDevice/{club}

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

{}

Lista o número de contratos pendentes que exigem ação, com base no usuário e nos clubes associados a ele

GET /api/agreements/agreements-outstanding

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

{}

Lista todos os contratos disponíveis para um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. contracts-sort `string` (opcional) Ordena os contratos por date-effective ou alphabetical. Padrão: date-effective. contracts-acknowledgement `string` (opcional) Filtra os contratos por all, acknowledged ou unacknowledged. Padrão: all. contracts-requirement `string` (opcional) Filtra os contratos por all, signature, checkbox, popup ou none. Padrão: all. contracts-status `string` (opcional) Filtra os contratos por all, active ou archived. Padrão: 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"

{}

Assina um contrato com base no ID dele.

Parâmetros

club `string` (obrigatório) ID interno do clube que está assinando o contrato. agreementid `string` (obrigatório) ID do contrato que está sendo assinado. body `string` (obrigatório) Objeto JSON com o contrato e os parâmetros a adicionar/enviar ao sistema...

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"

{}

Resumo do Model Router da instalação (configuração, saldo, gastos).

Parâmetros

clubID `string` (obrigatório) tz `string` (opcional) Fuso horário IANA do visualizador, usado como alternativa nas janelas de gastos por dia/mês quando a instalação não tem dados de fuso horário.

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"

{}

Catálogo dos modelos disponíveis com o estado de ativação por instalação (por padrão, todos ativados).

Parâmetros

clubID `string` (obrigatório)

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 disponíveis e modelos predefinidos do PH.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Serviços conectados ao Model Router. Inclui dispositivos de Agente de IA pareados, agentes externos com tipo explícito e o serviço de Workflow da instalação. A configuração é editada via PATCH /keys/{keyHash}.

Parâmetros

clubID `string` (obrigatório) tz `string` (opcional) Fuso horário IANA do visualizador, usado como alternativa nas janelas de gastos por dia/mês quando a instalação não tem dados de fuso horário.

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"

{}

Ativa o Model Router para uma instalação e provisiona o acesso de inferência dela.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Atualiza o plano, a lista de modelos permitidos, os guardrails, os filtros de conteúdo (ocultação/bloqueio por regex no PH), o limite de gastos e a configuração de recarga automática.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Zera o contador do limite rígido vitalício (nova linha de base no gasto atual) e registra o período encerrado no histórico.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Histórico de redefinições do limite rígido (mais recentes primeiro): limite, valor gasto e timestamps de cada período encerrado.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Cria uma nova chave de API phk_ para a instalação (o texto simples é retornado uma única vez). Aceita, opcionalmente, limites de gastos, lista de modelos permitidos, guardrails, filtros de conteúdo e limites de taxa rpmLimit/tpmLimit.

Parâmetros

clubID `string` (obrigatório)

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"

Atualiza os campos editáveis da chave: rótulo, limites de gastos por chave, lista de modelos permitidos, guardrails, filtros de conteúdo e limites de taxa rpmLimit/tpmLimit (sincronizados com a chave).

Parâmetros

clubID `string` (obrigatório) keyHash `string` (obrigatório)

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"

{}

Registros de inferência por solicitação da instalação (ao vivo, somente metadados).

Parâmetros

clubID `string` (obrigatório) page `string` (opcional) pageSize `string` (opcional) status `string` (opcional) model `string` (opcional) provider `string` (opcional) source `string` (opcional) `key` ou `agent` keyHash `string` (opcional) Filtra por uma única chave/agente pelo keyHash do PH. q `string` (opcional) Pesquisa de texto livre em ID da solicitação, rótulo da chave/agente, modelo, provedor e usuário final. minutes `string` (opcional) Janela menor que um dia (por exemplo, Live=1440); substitui startDate/endDate. startTs `string` (opcional) Início da janela em segundos epoch (clicar para ampliar); substitui minutes/dates. endTs `string` (opcional) Fim da janela em segundos epoch (clicar para ampliar); substitui minutes/dates.

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"

{}

Histograma de solicitações ao longo do tempo para a visualização de registros. Mesmos filtros da rota de lista, mas agregados no servidor em intervalos de tempo (contagens de sucesso/falha), para que a resposta seja pequena independentemente do volume de registros. O tamanho do intervalo é escolhido automaticamente para o período.

Parâmetros

clubID `string` (obrigatório) status `string` (opcional) model `string` (opcional) provider `string` (opcional) source `string` (opcional) keyHash `string` (opcional) q `string` (opcional) minutes `string` (opcional) startDate `string` (opcional) endDate `string` (opcional) startTs `string` (opcional) endTs `string` (opcional)

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"

{}

Intervalos de análise de uso + totais por modelo de um período (ao vivo).

Parâmetros

clubID `string` (obrigatório) range `string` (opcional) 24h | 7 | 30 | 90 | year | all (ignorado se startDate/endDate forem informados) startDate `string` (opcional) endDate `string` (opcional) groupBy `string` (opcional) model (padrão) | key | source | provider | status: dimensão para intervalos + grupos subgroupBy `string` (opcional) segunda dimensão opcional aninhada em cada grupo (Explore) keyHash `string` (opcional) filtro de análise detalhada: restringe a uma única chave/agente model `string` (opcional) filtro de análise detalhada: restringe a um único modelo provider `string` (opcional) source `string` (opcional) compare `string` (opcional) defina como "prev" para retornar também groupsPrev (período imediatamente anterior de mesma duração)

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"

{}

Calendário de atividade diária do último ano móvel (~53 semanas, no estilo do GitHub).

Parâmetros

clubID `string` (obrigatório)

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"

{}

Cobra o cartão armazenado do faturamento SaaS para adicionar crédito pré-pago do Model Router.

Parâmetros

clubID `string` (obrigatório) body `object` (opcional)

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"

{}

Finaliza uma recarga depois que o applet conclui a autenticação 3DS.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Resumo do cartão armazenado do faturamento SaaS que será cobrado nas recargas / recarga automática.

Parâmetros

clubID `string` (obrigatório)

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"

{}

Transações do livro-razão da instalação, mais recentes primeiro. Opcionalmente filtradas por tipo (por exemplo, `types=topup,adjustment` para o histórico de movimentações financeiras ou `types=charge-reconcile` com `from`/`to` para as deduções de uso de um mês).

Parâmetros

clubID `string` (obrigatório) limit `integer` (opcional) Máximo de linhas (padrão 50, máximo 200) types `string` (opcional) Tipos de transação separados por vírgula (topup, charge-reconcile, refund, adjustment, trueup-shortfall) from `integer` (opcional) Somente transações com createdAt >= from (segundos unix) to `integer` (opcional) Somente transações com createdAt <= to (segundos 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"

{}

Meses `YYYY-MM` distintos (UTC, mais recentes primeiro) que contêm pelo menos uma transação dos tipos solicitados. Alimenta os menus suspensos de filtro de ano/mês baseados em dados, para que a interface ofereça apenas períodos que realmente têm dados.

Parâmetros

clubID `string` (obrigatório) types `string` (opcional) Tipos de transação separados por vírgula (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"

{}

Recibo de pagamento em PDF com a marca para uma única transação do Model Router.

Parâmetros

clubID `string` (obrigatório) txId `string` (obrigatório)

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"

{}

Pacote de recibos de pagamento em PDF com a marca para as transações de recarga selecionadas, em um ZIP. Cada ID precisa ser uma recarga pertencente à instalação; deduções de uso e ajustes administrativos não têm recibos e são rejeitados.

Parâmetros

clubID `string` (obrigatório) ids `string` (obrigatório) IDs de transação separados por vírgula (máximo 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"

{}

Consolidações por mês civil (UTC) das deduções de uso da instalação, mais recentes primeiro. O mês atual é sempre incluído e marcado com `isCurrentMonth` (mês até a data).

Parâmetros

clubID `string` (obrigatório) months `integer` (opcional) Período retroativo em meses (padrão 12, máximo 24; ignorado quando `year` é definido) year `integer` (opcional) Restringe as consolidações a um ano civil UTC (por exemplo, 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 mensal do demonstrativo de uso com a marca: um resumo das deduções de uso do mês (subtotais diários + total). Explicitamente não é uma fatura nem um recibo; nenhum pagamento é cobrado pelas deduções de uso.

Parâmetros

clubID `string` (obrigatório) month `string` (obrigatório) Mês civil 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"

{}

Itens brutos de dedução de uso de um mês em CSV (ID da transação, timestamp UTC, valor, saldo posterior, instantâneo do gasto vitalício): a exportação detalhada que concilia com o total do demonstrativo do mês.

Parâmetros

clubID `string` (obrigatório) month `string` (obrigatório) Mês civil 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"

{}

Resumo de uso/gastos da instalação (ao vivo mais o livro-razão conciliado).

Parâmetros

clubID `string` (obrigatório) tz `string` (opcional) Fuso horário IANA do visualizador, usado como alternativa nas janelas de gastos por dia/mês quando a instalação não tem dados de fuso horário.

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"

{}

Associa/atualiza um dispositivo AI Edge Processor a um clube

Parâmetros

body `string` (obrigatório) Objeto JSON para atualizar o registro do dispositivo 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"

{}

Associa um dispositivo AI Edge Processor a um clube. Resolve o dispositivo priorizando os metadados (o heartbeat ao vivo prevalece), preenche a linha de registro se o dispositivo nunca se registrou sozinho e remove linhas de registro obsoletas deixadas por hardware reprovisionado.

Parâmetros

body `string` (obrigatório) Objeto JSON para atualizar o registro do dispositivo 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"

{}

Retorna uma lista dos registros de envio de bbox de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Índice de pesquisa do banco de dados de câmeras

Faz proxy do índice de pesquisa público camera-db da documentação (fabricantes, séries, modelos, aliases) usado pela caixa de diálogo Find my camera ao adicionar câmeras de rede. Armazenado em cache no servidor por 12 horas.

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"

{}

Modelos de fabricantes do banco de dados de câmeras

Faz proxy dos modelos de URL RTSP e dos padrões de um único fabricante a partir do banco de dados público de câmeras da documentação. O slug é validado para evitar path traversal. Armazenado em cache no servidor por 12 horas.

Parâmetros

slug `string` (obrigatório) Slug do fabricante (por exemplo, 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"

{}

Retorna uma lista de dados de check-ins de uma instalação

Parâmetros

club `string` (obrigatório) ID interno do clube/instalação que você deseja acessar. startDate `string` (opcional) Data de início no formato YYYY-MM-DD endDate `string` (opcional) Data de término no formato YYYY-MM-DD timezone `string` (opcional) Fuso horário para interpretar as datas (padrão Australia/Brisbane) nextToken `string` (opcional) Token de paginação para buscar a próxima página

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"

{}

Recuperar a configuração do front-end ou da interface de CFTV

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

GET /api/cctv/config/:club

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

{}

Obter a configuração de entrega de conteúdo de CFTV

Retorna o domínio de conteúdo usado pelos clientes de CFTV para resolver recursos de mídia. O domínio é definido pela variável de ambiente CONTENT_DOMAIN e, na falta dela, por um padrão que depende do estágio (produção serve /cctv, os outros estágios servem /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"

{}

Alterar a configuração do front-end ou da interface de CFTV

Parâmetros

body `object` (obrigatório) Objeto JSON do novo bloco de configuração a adicionar ao sistema.

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"

{}

Retorna uma lista da disponibilidade de regiões de bucket para a configuração do provedor de armazenamento de CFTV

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Redefinir a coleção de rostos não identificados

Redefine a coleção CompreFace de não identificados da instalação, excluindo todos os sujeitos. Os registros de pessoas no DynamoDB, as detecções de rostos e os blocos da linha do tempo no OpenSearch NÃO são afetados. Somente os dados subjacentes de reconhecimento facial são apagados. Novos perfis sombra serão criados automaticamente à medida que o sistema processar novas detecções das câmeras.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Obter informações da coleção de não identificados

Retorna a contagem atual de sujeitos da coleção CompreFace de não identificados da instalação.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Adiciona uma câmera de rede (câmera OEM/IP) por URL de stream (RTSP, HTTP, HTTPS)

Parâmetros

body `string` (obrigatório) Objeto JSON para adicionar uma câmera de rede.

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"

{}

Adicionar câmeras de rede em massa a um Edge Processor

Registra várias câmeras de rede RTSP/HTTP em um Edge Processor e depois envia FEED_CONFIG uma única vez, para que o dispositivo recarregue a configuração uma só vez.

Parâmetros

body `object` (obrigatório)

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"

{}

Associa/atualiza um dispositivo a um clube

Parâmetros

body `string` (obrigatório) Objeto JSON para atualizar o registro do dispositivo de CFTV.

POST /api/cctv/devices

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

{}

Associa um dispositivo a um clube

Parâmetros

body `string` (obrigatório) Objeto JSON para atualizar o registro do dispositivo de CFTV.

POST /api/cctv/devices/associate

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

{}

Dispara uma solicitação MQTT para o UUID de um dispositivo específico e espera uma resposta (via websocket) com os recursos disponíveis da câmera.

Parâmetros

club `string` (obrigatório) ID interno do clube proprietário do dispositivo que você está consultando. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Listar os registros de dispositivos

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

GET /api/cctv/devices/:club

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

{}

Remove uma câmera de rede marcando-a como excluída e retirando-a do FEED_CONFIG do Edge Processor

Parâmetros

club `string` (obrigatório) ID interno do clube proprietário do dispositivo. balenaUUID `string` (obrigatório) UUID da câmera de rede a remover.

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"

{}

Salva todos os recursos de câmera configurados e os aplica ao dispositivo como variável de ambiente (via balena)

Parâmetros

club `string` (obrigatório) ID interno do clube proprietário do dispositivo que você está consultando. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Salva uma máscara de movimento (se configurada) para a câmera e a aplica ao dispositivo como variável de ambiente (via balena)

Parâmetros

club `string` (obrigatório) ID interno do clube proprietário do dispositivo que você está consultando. body `string` (obrigatório) Objeto JSON da máscara da câmera.

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"

{}

Envia um comando v4l2 específico (como brilho ou contraste) ao dispositivo físico

Parâmetros

club `string` (obrigatório) ID interno do clube proprietário do dispositivo que você está consultando. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Testar a URL de stream de uma câmera de rede

Envia um comando de teste a um Edge Processor para validar a URL de stream de uma câmera usando o ffprobe

Corpo da solicitação

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

{}

Exclui permanentemente um único registro de detecção de rosto do banco de dados. Usado para remover entradas de rastreamento incorretas ou não correspondentes do registro de atividades de uma pessoa.

Parâmetros

club `string` (obrigatório) fdID `string` (obrigatório)

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"

{}

Retorna uma lista de dados de detecções de rosto de uma pessoa

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personID `string` (obrigatório) ID da pessoa no sistema de identificação facial

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"

{}

Retorna as detecções de rosto que fazem referência a uma determinada imagem recortada da pessoa, consultadas pelo GSI personCropImage.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personCropImage `string` (obrigatório) URL da imagem recortada da pessoa armazenada no registro de detecção de rosto. limit `string` (opcional) Número máximo de detecções a retornar. nextToken `string` (opcional) Token de paginação de uma resposta anterior.

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"

{}

Retorna uma lista de dados de detecções de rosto de um clube, agrupados por intervalo em relação à hora atual

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna uma lista de dados de detecções de rosto de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Pesquisar blocos da linha do tempo de detecções de rosto em uma instalação usando o OpenSearch

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação na qual pesquisar timezone `string` (obrigatório) Fuso horário IANA para conversão de datas (por exemplo, Pacific/Auckland) startDate `string` (opcional) Filtro de data de início (YYYY-MM-DD), convertido em startUnix usando o fuso horário endDate `string` (opcional) Filtro de data de término (YYYY-MM-DD), convertido em endUnix usando o fuso horário personId `string` (opcional) Filtrar por um ID de pessoa específico query `string` (opcional) Pesquisa de texto livre (por exemplo, nome da pessoa) limit `string` (opcional) Resultados por página (padrão 20, máximo 100) filters `string` (opcional) Objeto de filtros codificado em JSON (por exemplo, {"matchType":"identified"}) sortBy `string` (opcional) Campo de ordenação (startUnix, endUnix, created). O padrão é endUnix. page `string` (opcional) Número da página para paginação (padrão 1) sortOrder `string` (opcional) Direção da ordenação (asc ou desc). O padrão é 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"

{}

Retorna uma lista de relatórios sobre a instalação do clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Aciona a geração de mapas de calor sob demanda. Invoca a mesma lógica do Starter usada pelo cron agendado, mas permite direcionar a uma instalação específica, data/hora e conjunto de períodos. Quando chamado sem corpo, comporta-se exatamente como o cron: verifica todas as instalações elegíveis e coloca todos os dispositivos na fila.

Corpo da solicitação

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

{}

Resolve a localização de um PNG de mapa de calor composto em janela móvel para um único dispositivo. Retorna apenas metadados JSON: os bytes do PNG ficam no domínio de conteúdo, e o front-end monta a URL assim: `${contentDomain}/cctv/${storageService}/${region}/${filePath}?s=${token}` Ordem de resolução: 1. Acerto no índice `composed#…` do DynamoDB → retorna imediatamente (~10 ms). 2. HEAD no Wasabi na chave de cache determinística. Em caso de acerto, grava uma linha de índice de preenchimento e retorna. 3. Alternativa obsoleta: existe algum registro composto para esta tupla (dispositivo, intervalo, hora), mesmo de outra data. Retornado imediatamente com `cache: 'HIT-STALE'` para que o FE possa exibir *alguma coisa*. Uma nova composição é disparada de forma assíncrona. 4. Caminho frio: não existe nenhum registro. A Lambda de composição é colocada na fila via `InvocationType: 'Event'` e o endpoint retorna `202 { cache: 'PENDING' }`. O FE consulta periodicamente até que um registro chegue (normalmente de 3 a 5 segundos). Tratamento do dia atual: quando `endDate` é o "hoje" local da instalação, o endpoint serve o PNG de ontem: as fatias de hoje ainda estão sendo gravadas pelo cron do Starter e uma nova composição ficaria incompleta. A resposta repete o `endDate` solicitado e inclui `endDateUsed` (= ontem). Enum `cache`: - `HIT`: servido do índice do DDB para a data solicitada. - `HIT-FALLBACK`: hoje solicitado; servida a linha de índice de ontem. - `HIT-BACKFILL`: ausente no DDB, mas o Wasabi tinha o PNG; a linha acabou de ser gravada. - `HIT-FALLBACK-BACKFILL`: preenchimento na alternativa de ontem. - `HIT-STALE`: nenhum registro para a data solicitada, mas existe um registro de outra data para esta tupla; servido imediatamente e uma nova composição é colocada na fila em segundo plano. - `PENDING`: nenhum registro; a composição foi colocada na fila. O FE deve consultar periodicamente. A resposta é `202 Accepted`, sem `filePath`.

Parâmetros

facilityId `string` (obrigatório) deviceUUID `string` (obrigatório) Dispositivo para o qual compor. As composições são por dispositivo. hour `integer` (obrigatório) Hora do dia (0–23) a compor ao longo da janela retroativa. endDate `string` (opcional) Última data da janela (YYYY-MM-DD). Padrão: hoje (fuso horário da instalação). range `string` (opcional) Janela retroativa. Precisa ser um dos intervalos permitidos. nocache `integer` (opcional) Defina como `1` para ignorar as camadas de cache DDB + HEAD e forçar uma nova composição.

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"

{}

Descobre quais horas do dia têm registros de fatias de `1h` para um dispositivo em uma janela retroativa móvel. O front-end usa isso para preencher o seletor de hora junto com um seletor de data + intervalo antes de chamar o endpoint de composição (`/api/cctv/heatmaps/hourly/...`). Exemplo: `GET /api/cctv/heatmaps/query-hourly/Birkdale?deviceUUID=abc123&endDate=2026-04-16&range=30d` Internamente: uma consulta de intervalo do DynamoDB em `cctvheatmaps` (`sk BETWEEN 1h#{start}-00 AND 1h#{end}-23`), agrupada por hora. Retorna uma entrada por hora que tenha pelo menos uma fatia, incluindo um JPEG de referência representativo (obtido do dia mais recente da janela; a referência é compartilhada por dispositivo por dia).

Parâmetros

facilityId `string` (obrigatório) deviceUUID `string` (obrigatório) Dispositivo a consultar. As fatias por hora são por dispositivo. endDate `string` (opcional) Última data da janela (YYYY-MM-DD). Padrão: hoje (fuso horário da instalação). range `string` (opcional) Janela retroativa. Precisa ser um dos intervalos permitidos.

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"

{}

Consulta registros de mapas de calor pré-gerados de uma instalação. **Todos os registros de um tipo de período:** - `/api/cctv/heatmaps/Birkdale?periodType=1y` - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&periodType=1d` **Intervalo de datas, um único tipo de período:** - `/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` **Intervalo de datas, todos os tipos de período aplicáveis (omita periodType):** - `/api/cctv/heatmaps/Birkdale?from=2026-03-01&to=2026-03-31` Retorna registros anuais, semestrais, trimestrais etc., até os de 6h, que se sobrepõem ao intervalo informado. **Momento específico, todos os 9 tipos de período de um dispositivo:** - `/api/cctv/heatmaps/Birkdale?deviceUUID=abc123&date=2026-03-15T14:30` Retorna até 9 registros (1y, 6m, 3m, 2m, 1m, 1w, 1d, 12h, 6h).

Parâmetros

facilityId `string` (obrigatório) O identificador da instalação. deviceUUID `string` (opcional) Consulta um dispositivo específico. Quando omitido, consulta todos os dispositivos (GSI). periodType `string` (opcional) Filtra por um único tipo de período. Quando omitido com from/to, consulta todos os tipos. from `string` (opcional) Data de início (yyyy-mm-dd). Precisa ser usada com `to`. to `string` (opcional) Data de término (yyyy-mm-dd). Precisa ser usada com `from`. date `string` (opcional) Consulta de um momento específico (yyyy-mm-dd ou yyyy-mm-ddTHH:mm). Requer deviceUUID. Retorna um registro por tipo de período.

GET /api/cctv/heatmaps/{facilityId}

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

{}

Obter a miniatura da transmissão ao vivo do dispositivo

Parâmetros

club `string` (obrigatório) ID interno do clube. deviceId `string` (obrigatório) ID interno do dispositivo de CFTV.

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"

{}

Informar ao sistema de CFTV que você vai assistir a uma transmissão ao vivo

Parâmetros

club `string` (obrigatório) ID interno do clube. deviceId `string` (obrigatório) ID interno do dispositivo de CFTV.

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"

{}

Aprovar uma correspondência de interseção

Define o status da correspondência como confirmado e registra o revisor.

Parâmetros

club `string` (obrigatório) matchId `string` (obrigatório)

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"

{}

Obter uma única correspondência de interseção com os detalhes da visita

Retorna o registro da correspondência e o detalhamento de horários por visita.

Parâmetros

club `string` (obrigatório) matchId `string` (obrigatório)

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"

{}

Vincular manualmente uma pessoa sem correspondência a um membro

Associa um personId de CFTV a um membro específico, definindo a correspondência como confirmada.

Parâmetros

club `string` (obrigatório) matchId `string` (obrigatório)

Corpo da solicitação

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

{}

Listar as correspondências de interseção de uma instalação

Retorna correspondências paginadas filtradas por status.

Parâmetros

club `string` (obrigatório) status `string` (opcional) limit `integer` (opcional) nextToken `string` (opcional)

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"

{}

Rejeitar uma correspondência de interseção

Define o status da correspondência como rejeitado e registra o revisor.

Parâmetros

club `string` (obrigatório) matchId `string` (obrigatório)

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"

{}

Obter as contagens resumidas das correspondências de interseção

Retorna as contagens de correspondências agrupadas por status para a instalação.

Parâmetros

club `string` (obrigatório) ID da instalação

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"

{}

Desvincular uma correspondência de perfil aprendida automaticamente

Reverte uma correspondência vinculada para o status rejeitado e limpa autoLearnedFrom no registro do membro.

Parâmetros

club `string` (obrigatório) matchId `string` (obrigatório)

Corpo da solicitação

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

{}

Lê o status de uma operação "upsert identified person" em andamento (abrange criação e edição). Lê a linha diretamente da tabela `people-ops`, pertencente ao cctv-rekognition-api, sem passar por uma Lambda. Usado pelo front-end de CFTV para acompanhar o progresso após POST /api/cctv/people/{facility}/identified. O caminho é irmão de `/cctv/people/...` (não aninhado nele) para que o roteador do express não confunda `operationId` com `:personID` em `/cctv/people/:club/:personID`. Consulte a ordem dos globs em createAPIRouter. Retorna um marcador `pending` enquanto a Lambda upsertIdentifiedPerson ainda não gravou a primeira entrada de etapa (janela de inicialização a frio). O hook de consulta do FE trata o marcador e pending da mesma forma, o que mantém o contrato estável para quem chama.

Parâmetros

operationId `string` (obrigatório)

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"

{}

Adiciona uma imagem de rosto (de uma detecção de rastreamento existente) ao sujeito de reconhecimento CompreFace da pessoa e armazena uma referência na tabela de fotos sombra. NÃO envia a imagem ao Wasabi, pois ela já está lá como captura de detecção de rosto.

Parâmetros

club `string` (obrigatório) personID `string` (obrigatório) body `string` (obrigatório)

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"

{}

Adicionar fotos sombra ao registro de uma pessoa

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personID `string` (obrigatório) ID do registro da pessoa body `string` (obrigatório) Objeto JSON do novo bloco de configuração a adicionar ao sistema.

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"

{}

Consultar as fotos sombra de uma pessoa

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personID `string` (obrigatório) ID do registro da pessoa

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"

{}

Remove permanentemente um registro de foto sombra da CCTVShadowPhotosTable e remove o rosto correspondente do CompreFace (se o faceId estiver armazenado).

Parâmetros

club `string` (obrigatório) personID `string` (obrigatório) id `string` (obrigatório) O ID do registro da foto sombra (chave primária)

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"

{}

Exclui as referências e os registros de reconhecimento associados por um personID

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personID `string` (obrigatório) ID exclusivo da pessoa no CFTV.

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"

{}

Retorna o registro de uma pessoa de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. personID `string` (obrigatório) ID da pessoa no banco de dados.

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"

{}

Obter as zonas de acesso correspondentes ao perfil de associação de uma pessoa

Resolve o tipo de membro, as tags e os planos de associação da pessoa e depois retorna as zonas de acesso reais (origin=membership-plan, não absorvidas) correspondentes às regras de inclusão/exclusão. O accessRestriction de cada zona é reduzido apenas às regras que corresponderam à pessoa. As câmeras das zonas filhas são mescladas nas zonas pai.

Parâmetros

club `string` (obrigatório) ID interno da instalação personID `string` (obrigatório) ID da pessoa na tabela de pessoas do CFTV

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"

{}

Retorna o status atual de um job de mesclagem, incluindo os resultados por origem. Consulte este endpoint a cada 3 a 5 segundos enquanto o status for IN_PROGRESS.

Parâmetros

club `string` (obrigatório) mergeJobID `string` (obrigatório)

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"

{}

Inicia em segundo plano a mesclagem de vários perfis de pessoas não identificadas em um único perfil sobrevivente. Responde 202 imediatamente com um mergeJobID. Consulte /merge-status/:mergeJobID para acompanhar o progresso.

Parâmetros

club `string` (obrigatório) body `string` (obrigatório)

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"

Adicionar um rosto à coleção da lista de bloqueio de uma instalação

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação

Corpo da solicitação

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

{}

Cria ou atualiza uma pessoa identificada em uma instalação: cria um novo registro ou atualiza um existente. Faz proxy para a Lambda upsertIdentifiedPerson, que grava o registro da pessoa, envia ao Wasabi a foto fornecida e reindexa o rosto no CompreFace. Quando `isNewRecord` é true (padrão), a Lambda executa o ramo de criação (cctvPeople.save) e um `personID` é gerado se não for informado. Quando `isNewRecord` é false, a Lambda executa o ramo de atualização (cctvPeople.update): `personID` é obrigatório e precisa identificar um registro existente.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

Atualiza o conjunto de campos opcionais de parceiros sincronizados com a tabela de pessoas do CFTV de uma instalação.

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação

Corpo da solicitação

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

{}

Retorna uma lista de dados de pessoas de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

GET /api/cctv/people/:club

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

{}

Pesquisa pessoas em uma instalação por imagem de rosto. Invoca a Lambda imageFaceSearch do cctv-rekognition-api com a imagem base64 enviada e o ID da instalação do caminho. Retorna correspondências classificadas mais um resumo de atributos do DeepFace.

Parâmetros

club `string` (obrigatório) ID da instalação / clube body `string` (obrigatório)

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"

{}

Pesquisar pessoas em uma instalação usando o OpenSearch

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação na qual pesquisar query `string` (opcional) Termo de pesquisa (por exemplo, nome) page `string` (opcional) Número da página (padrão 1) limit `string` (opcional) Resultados por página (padrão 20, máximo 100) filters `string` (opcional) Objeto de filtros codificado em JSON (por exemplo, {"membershipStatus":"active"}) sortBy `string` (opcional) Campo de ordenação (created, lastName, firstName, membershipUpdatedOn). O padrão é created. sortOrder `string` (opcional) Direção da ordenação (asc ou desc). O padrão é 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"

{}

Atualiza itens de detecção de rosto com um novo personID e associa os registros de reconhecimento

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. body `string` (obrigatório) Objeto JSON do novo bloco de configuração a adicionar ao sistema.

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"

{}

Retorna um objeto com todos os filtros disponíveis para os dados de gravações de CFTV de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Transmitir a gravação.

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"

{}

Atualizar as informações sobre a gravação.

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"

{}

Retorna um resumo dos dados de gravações de CFTV de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna uma lista de dados de gravações de CFTV de um clube com base em um intervalo relativo à hora atual

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna uma lista de dados de gravações de CFTV de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

GET /api/cctv/recordings/:club

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

{}

As gravações são excluídas automaticamente após um período definido; use esta função para reter gravações

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Pesquisar instantâneos de relatórios de uma instalação em um intervalo de datas

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação startDate `string` (obrigatório) Filtro de data de início (YYYY-MM-DD) endDate `string` (obrigatório) Filtro de data de término (YYYY-MM-DD) deviceIds `string` (opcional) Lista separada por vírgulas de IDs de câmeras/dispositivos pelos quais filtrar view `string` (opcional) Visualização alternativa do relatório a calcular (encaminhada à Lambda de relatórios)

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"

{}

Pesquisa vetorial nas mídias de CFTV indexadas de uma instalação. Responde com um text/event-stream retransmitido da Lambda searchAnything, para que o cliente possa exibir o progresso enquanto um contêiner frio carrega o codificador. Os eventos são `status` e depois `result` ou `error`. Há três formas de consultar, duas delas neste verbo. Envie `query` para pesquisar por texto livre. Envie `seedIndex` + `seedKey` para pesquisar por exemplo ("mais como este") usando o vetor de uma linha que já está no índice; é assim que você encontra mais resultados parecidos com o que o usuário está vendo. Para pesquisar por uma imagem que o usuário tem, faça `POST` dos bytes neste mesmo caminho. Envie palavras com uma imagem para restringir uma pela outra: **o texto filtra, a imagem classifica**. Os candidatos vêm da semente, as palavras decidem quais deles permanecem e a semelhança visual decide a ordem; assim, os resultados continuam parecidos com a imagem e as palavras descartam os que não correspondem. Os dois nunca são combinados em um único vetor, e é por isso que `queryKind` continua `similar` em uma pesquisa combinada; a presença de `query` no resultado é o que indica que um filtro de texto foi aplicado. Espere que pesquisas combinadas não retornem nada com certa frequência e trate isso como um resultado distinto: `perIndex..textGated` conta os candidatos que corresponderam à imagem, mas não às palavras, então uma página vazia pode ser explicada como "remova as palavras" em vez de "tente outra imagem". Uma pesquisa com semente e sem palavras não carrega nenhum codificador, então nunca sofre uma inicialização a frio; adicionar palavras abre mão disso. De qualquer forma, ela pesquisa todos os índices por padrão: os vetores de recortes, gravações e timelapses compartilham o mesmo espaço, então um recorte de pessoa pode encontrar gravações correspondentes. As pontuações com semente são bem mais altas que as de texto (imagem para imagem não atravessa diferença de modalidade) e são filtradas por um piso separado, ainda não calibrado; `result.queryKind` indica qual escala você está lendo, e uma pontuação de uma nunca deve ser comparada com a da outra. Pesquisa todos os índices por padrão e retorna uma única lista mesclada e ordenada por pontuação; cada resultado traz `index` e `kind` para que quem chama possa distinguir um resultado de imagem de um de vídeo (este último adiciona `offsetMs`). Índices sem tabela para a instalação são informados em `skipped` em vez de falhar. Resultados abaixo do piso de relevância calibrado de cada índice são descartados, então uma consulta sem correspondência real retorna uma lista vazia em vez de bobagens com aparência confiável; `perIndex` informa o que cada índice contribuiu e por quê. Os resultados podem ser restringidos por horário de captura e por câmera. Prefira `cameraId` a `camera`: é o balenaUUID da câmera, o único valor que todos os índices armazenam da mesma forma, então um único filtro restringe todos eles. Um filtro que um índice não consegue atender é informado em `perIndex..filtersIgnored` e esse índice é pesquisado sem restrição, em vez de ser retirado da pesquisa. Os resultados de gravações são **um por clipe, não um por quadro correspondente**: os quadros são amostrados a cada 2 s, então um sujeito que permanece no local corresponde a dez quadros quase idênticos da mesma gravação. Cada clipe retorna o melhor quadro, mais `matchCount` e `offsetsMs`, que listam todos os momentos correspondentes dentro dele e podem ser usados diretamente como pontos de busca. Recortes de pessoas nunca são agrupados, pois dois recortes da mesma pessoa são duas aparições distintas.

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação na qual pesquisar query `string` (opcional) Descrição em texto livre do que procurar. Obrigatória, a menos que warm=1 ou uma semente seja enviada. Combinada com uma semente, deixa de ser o que é classificado e passa a ser um filtro sobre os candidatos da semente, descartando aqueles cuja pontuação de texto fica abaixo do piso de relevância do índice. seedIndex `string` (opcional) Pesquisa por exemplo em vez de por texto: o índice em que a linha semente está (person-crops, recording-frames, timelapse-frames). É o `index` do resultado em que o usuário clicou. Precisa ser enviado com seedKey. seedKey `string` (opcional) A `key` da linha semente, copiada literalmente do resultado. A semente é excluída dos próprios resultados; no caso de uma gravação, isso significa o clipe inteiro, já que os outros quadros dele têm 2s de intervalo e são quase idênticos. seedFrameId `string` (opcional) Obrigatório quando seedIndex é recording-frames: esse índice armazena uma linha por quadro amostrado e todas compartilham a chave do clipe, então a chave sozinha identifica um clipe, e não um momento. Envie o `frameId` do resultado. Linhas mais antigas não têm esse valor; nesse caso, envie seedOffsetMs. seedOffsetMs `string` (opcional) Identificador de quadro alternativo para sementes de recording-frames cuja linha é anterior a `frame_id`. Envie o `offsetMs` do resultado. Ignorado quando seedFrameId é informado. warm `string` (opcional) Prepara um contêiner Lambda sem executar uma pesquisa. Chame ao carregar a página. warmTarget `string` (opcional) Qual codificador `warm` carrega: `text` (padrão), `image` ou `both`. A torre de visão tem 355 MB, contra 283 MB da torre de texto, então prepará-la é opcional: peça `image` somente quando o usuário tiver de fato selecionado uma imagem, e não ao carregar a página. index `string` (opcional) Conjuntos de dados a pesquisar, separados por vírgula: person-crops, recording-frames, timelapse-frames. Os resultados são mesclados em uma única lista ordenada por pontuação. Os três são pesquisados por padrão; passe uma lista explícita para restringir. timelapse-frames abrange câmeras que não gravam nada e só produzem um quadro por minuto, e o piso de relevância dele ainda não está calibrado. model `string` (opcional) Codificador usado na consulta. Precisa corresponder ao codificador com que o conjunto de dados foi indexado. limit `string` (opcional) Resultados a retornar por índice (padrão 50, máximo 100). Não é um total, então pesquisar os três índices pode retornar até o triplo disso. Para gravações, conta clipes em vez de quadros correspondentes. from `string` (opcional) Corresponde apenas a mídias capturadas neste horário ou depois dele, em milissegundos desde o epoch. Observe que é o horário de captura, não o de envio. to `string` (opcional) Corresponde apenas a mídias capturadas antes deste horário (exclusivo), em milissegundos desde o epoch. cameraId `string` (opcional) balenaUUIDs de câmeras, separados por vírgula, aos quais restringir: o campo `balenaUUID` de cada entrada retornada por /api/cctv/recordings/filters/:club. É o filtro de câmera preferido: todos os índices armazenam esse mesmo valor, então um único filtro restringe todos eles. Observe que só os recortes cuja junção com a detecção de rosto foi resolvida o têm (~1% hoje), então restringir recortes por câmera retornará poucos ou nenhum até que o preenchimento dos recortes seja executado; as gravações estão totalmente preenchidas e filtram com exatidão. camera `string` (opcional) Nomes de câmeras, separados por vírgula, aos quais restringir. Na prática, só vale para gravações: person-crops armazena um nome de câmera vazio em todas as linhas, então qualquer valor aqui exclui todos os recortes. Prefira cameraId. cameraGroup `string` (opcional) Grupos de câmeras, separados por vírgula, aos quais restringir. Preenchido em todas as gravações, mas em apenas ~1% dos recortes, pelo mesmo motivo de cameraId. minScore `string` (opcional) Substitui o piso de cosseno por índice que filtra o ruído. Omita em produção; cada índice tem um padrão calibrado (e outro separado, não calibrado, para pesquisas com semente). Passe 0 para ver os vizinhos mais próximos sem filtro ao depurar a relevância.

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"

{}

Pesquisa por uma imagem que o usuário tem, em vez de por palavras ou por um resultado já exibido na tela. Idêntico ao GET em todos os outros aspectos (mesmos parâmetros de consulta, mesmo fluxo de eventos, mesmo formato de resultado), então aqui está documentado apenas o que difere. Envie os **bytes originais do arquivo** como corpo da solicitação, com um Content-Type `image/*`. Não redimensione, recorte nem recodifique a imagem no navegador antes: o servidor reproduz um redimensionamento muito específico (uma compressão para 256x256 com um kernel bilinear com antialiasing) com o qual os vetores indexados foram criados, e o dimensionamento do canvas usa outro. Na medição, essa substituição fica a cerca de 0,93 de cosseno da resposta certa, mais distante do que duas imagens realmente diferentes; assim, os resultados voltam classificados de forma plausível e errada, sem nenhum erro. Limitado a 4 MB, o que é uma restrição de transporte, e não de qualidade: os bytes viajam dentro do payload de invocação da Lambda, limitado a 6 MB, e o base64 os aumenta em um terço. Os resultados são pontuados de imagem para imagem, então `queryKind` é `image` e as pontuações estão na mesma escala, muito mais alta, de uma pesquisa com semente; nunca são comparáveis com pontuações de texto. Espere que fiquem um pouco *abaixo* de uma pesquisa com semente equivalente: o vetor de uma semente foi gravado pelo próprio dispositivo, enquanto um envio é recodificado aqui por outro mecanismo, o que o coloca alguns centésimos longe de onde o dispositivo o teria colocado. Na medição, os resultados têm a mesma qualidade apesar disso; apenas não são exatamente o mesmo conjunto. Adicionar `query` filtra os resultados por essas palavras, exatamente como acontece com uma semente. Enviar uma semente *e* uma imagem é rejeitado: as duas são o que está sendo classificado, então o par não faz sentido. Esta é a solicitação mais cara atendida pelo endpoint. Uma imagem enviada carrega a torre de visão, e adicionar palavras carrega também a torre de texto, ambas em um contêiner frio. Usar `warm=1&warmTarget=image` assim que o usuário selecionar uma imagem tira isso do caminho crítico.

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação na qual pesquisar body `string` (obrigatório) Bytes brutos da imagem, sem modificação, no máximo 4 MB query `string` (opcional) Palavras opcionais para restringir os resultados da imagem, descartando correspondências cuja pontuação de texto fica abaixo do piso de relevância do índice.

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"

{}

Retorna os detalhes de armazenamento e outros dados de métricas do CFTV do clube

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"

{}

Retorna uma lista dos registros de envio de timelapses de um clube

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

GET /api/cctv/timelapse/:club

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

{}

Listar as ações dos usuários realizadas nas gravações no front-end ou na interface de CFTV

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Registrar uma ação do usuário realizada nas gravações no front-end ou na interface de CFTV

Parâmetros

body `string` (obrigatório) Objeto JSON do novo bloco de configuração a adicionar ao sistema.

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"

{}

Obter o token do usuário para o front-end ou a interface de CFTV

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Gerar um token para acesso temporário ou de convidado

Parâmetros

club `string` (obrigatório) O identificador exclusivo do clube. body `string` (obrigatório) Objeto JSON dos detalhes do token a emitir.

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

Retorna uma lista de registros de tokens de acesso temporário ou de convidado

Parâmetros

club `string` (obrigatório) O identificador exclusivo do clube.

GET /api/cctv/token/{club}

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

{}

Obter o token de acesso pelo ID de acesso

Parâmetros

accessID `string` (obrigatório) ID do registro do token no banco de dados.

POST /guest/cctv/token/:accessID

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

{}

Excluir um horário de acesso da instalação

Parâmetros

facilityId `string` (obrigatório) body `object` (obrigatório) Objeto JSON do novo horário de acesso.

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"

{}

Retorna uma lista dos horários de acesso da instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualiza ou cria um horário de acesso da instalação

Parâmetros

facilityId `string` (obrigatório) body `object` (obrigatório) Objeto JSON do novo horário de acesso.

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"

{}

Excluir uma zona de acesso da instalação

Parâmetros

facilityId `string` (obrigatório) body `object` (obrigatório) Objeto JSON da nova zona de acesso.

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"

{}

Retorna uma lista das zonas de acesso da instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualiza ou cria uma zona de acesso da instalação

Parâmetros

facilityId `string` (obrigatório) body `object` (obrigatório) Objeto JSON da nova zona de acesso.

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"

{}

Retorna a união de todos os IDs de módulos de administração entre as marcas e instalações de uma organização, preenchidos como objetos de módulo.

Parâmetros

organisationId `string` (obrigatório) ID da organização

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"

{}

Retorna uma lista de todas as organizações

Parâmetros

includeBrands `string` (opcional) Incluir as marcas associadas à organização includeFacilities `string` (opcional) Incluir as instalações associadas à organização includeRegions `string` (opcional) Incluir as regiões associadas à organização

GET /api/organisations

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

{}

Um auxiliar de IA simples que analisa o conteúdo de um chamado de suporte e cria sugestões com base nos tópicos disponíveis, além de sugerir tópicos de pesquisa no Algolia...

Parâmetros

messageBody `string` (obrigatório) Corpo da mensagem a enviar topicData `string` (obrigatório) Objeto/array JSON do topicData retornado pelo osTicket (sistema de chamados/suporte) facilityId `string` (opcional) O ID interno do clube, necessário para determinar o índice correto do Algolia a ser pesquisado.

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"

{}

Uma API simples de geração de imagens

Parâmetros

type `string` (obrigatório) Tipo de imagem a gerar name `string` (obrigatório) Nome da imagem maxSize `string` (opcional) Tamanho máximo opcional da resposta, por exemplo 200KB, 1MB ou uma contagem simples de bytes. A imagem é reduzida/comprimida para caber.

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"

{}

Consulta simples a LLM

Endpoint leve para consultas simples e sem estado a LLMs. Usa um modelo barato, sem raciocínio (gpt-4o-mini), com limites rígidos de tokens. Sem histórico de conversa, sem ferramentas, sem streaming: apenas prompt de entrada e texto de saída.

Corpo da solicitação

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

{}

Retorna a configuração do Algolia, incluindo o nome do índice, o ID do app e a chave de API.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Inicializa o índice de impressos de marketing do Algolia

Parâmetros

organisationId `string` (obrigatório)

PUT /api/algolia/index

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

{}

Pesquisar materiais impressos de marketing

Corpo da solicitação

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

{}

Pesquisar materiais impressos de marketing

Parâmetros

club `string` (opcional) ID do clube searchTerms `string` (opcional) Termos de pesquisa algoliaArgs `object` (opcional) Argumentos adicionais de pesquisa do 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"

{}

Atualizar em massa os objetos de impressos de marketing de um clube específico

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"

{}

Busca os recursos de impressos de marketing no Algolia.

Parâmetros

organisationId `string` (obrigatório) search `string` (opcional) limit `string` (opcional) brand `string` (opcional) tag `string` (opcional)

GET /api/algolia/marketing/assets

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

{}

Inicializa o índice de impressos de marketing do Algolia com a configuração da instalação.

Parâmetros

organisationId `string` (obrigatório)

POST /api/algolia/marketing/assets

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

{}

Realiza uma pesquisa em um índice do Algolia especificado com base em termos de pesquisa, clube e/ou localidade. A pesquisa pode ser personalizada ainda mais com argumentos adicionais do Algolia.

Parâmetros

searchTerms `string` (obrigatório) Os termos a pesquisar no índice do Algolia. club `string` (opcional) ID interno do clube que está fazendo a solicitação. Se especificado, a pesquisa será filtrada com base na região associada ao clube. locale `string` (opcional) A localidade usada para determinar a região se nenhum clube for especificado. Derivada de navigator.languages. algoliaArgs `string` (opcional) Argumentos adicionais/personalizados a repassar para a solicitação de pesquisa do 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"

{}

Lista todos os anúncios

GET /api/announcements/list

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

{}

Envia um recurso para um BUCKET S3 PÚBLICO (pela Upload API), que depois fará o pós-processamento/otimização do arquivo, gerará miniaturas etc. *Observação: os recursos ficarão disponíveis publicamente*

Parâmetros

file `string` (opcional) Nome do arquivo/recurso a ser enviado.

POST /api/asset-upload

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

{}

Retorna o status do envio pelo UUID informado do registro de envio

Parâmetros

uuid `string` (obrigatório) UUID do registro de envio

GET /api/asset-upload/:uuid

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

{}

Enviar um comando ao Sonos do clube

Parâmetros

body `object` (obrigatório) Objeto JSON do comando e da entrada a enviar ao 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"

{}

Recuperar a configuração do front-end do Controle de áudio

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Alterar a configuração do front-end do Controle de áudio

Parâmetros

body `object` (obrigatório) Objeto JSON do novo bloco de configuração a adicionar ao sistema.

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"

{}

Recupera as configurações da marca de uma região específica

Parâmetros

brandId `string` (opcional) O ID da marca regionCode `string` (opcional) O código ISO da região cujas configurações serão recuperadas

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"

{}

Atualiza várias configurações da marca de uma região específica

Parâmetros

brandId `string` (opcional) O ID da marca a atualizar regionCode `string` (opcional) O código ISO da região cujas configurações serão atualizadas acceptFreeTrialBookingsVisibility `string` (opcional) customTrackingCodeVisibility `string` (opcional) displayDataSources `string` (opcional) displayDefaultDataSource `string` (opcional) displayDefaultUI `string` (opcional) displayUIOptions `string` (opcional) defaultAboutBusiness `string` (opcional) defaultAboutBusinessFacebook `string` (opcional) facilityCoverImage `string` (opcional) digitalProfileSettingsVisibility `string` (opcional) facilityHoursVisibility `string` (opcional) facilityLocationVisibility `string` (opcional) facilityPaymentMethods `string` (opcional) facilityPrimaryLogo `string` (opcional) facilityStatusVisibility `string` (opcional) landingPagesVisibility `string` (opcional) lineChatIntegrationVisibility `string` (opcional) whatsAppIntegrationVisibility `string` (opcional) defaultWhatsAppMessage `string` (opcional) socialUrlsVisibility `string` (opcional) yextApiKey `string` (opcional) Chave de API usada pela integração com o Yext para esta marca-região. Só é consultada quando `directorySyncMode` é `yext`. directorySyncMode `string` (opcional) Qual back-end de sincronização deve ser executado para as instalações desta marca-região. Quando ausente, o padrão é `yext`, para compatibilidade com marcas anteriores à implantação dos Directory Publishers. websiteUrl `string` (opcional) androidAppUrl `string` (opcional) iosAppUrl `string` (opcional) featuredMessageDescription `string` (opcional) yextCategoryIds `string` (opcional) Chave de armazenamento legada: na verdade, são IDs de categoria do Google Business Profile (por exemplo, gcid:gym). O prefixo "yext" é anterior à descontinuação do Yext; mantido para compatibilidade com as linhas existentes no banco de dados. customInputFields `string` (opcional) customInputFieldsToRemove `string` (opcional)

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"

{}

Recupera as configurações da marca de uma instalação específica

Parâmetros

facilityId `string` (opcional) O ID da instalação cujas configurações da marca serão recuperadas

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"

{}

Cria uma nova marca

Parâmetros

name `string` (obrigatório) O nome da marca organisationId `string` (obrigatório) O ID da organização à qual a marca pertence redirectDashboard `string` (opcional) A URL para a qual redirecionar após o login, em vez do painel padrão

POST /api/brands

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

{}

Retorna a lista de todas as marcas

GET /api/brands

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

{}

Retorna o objeto da marca

Parâmetros

brandId `string` (obrigatório) O ID da marca a recuperar includeOrganisation `boolean` (opcional) Se os dados da organização devem ser incluídos na resposta

GET /api/brands/{brandId}

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

{}

Atualiza uma marca pelo ID

Parâmetros

brandId `string` (opcional) O ID da marca a atualizar name `string` (obrigatório) O nome da marca brandOrganisationId `string` (opcional) O ID da organização à qual a marca pertence redirectDashboard `string` (opcional) A URL para a qual redirecionar após o login, em vez do painel padrão yextApiKey `string` (opcional) A chave de API usada para acessar a API do Yext para esta marca customMenuLayout `object` (opcional) Árvore de layout do menu lateral por marca (seções / grupos / itens com referências a módulos do sistema ou URLs personalizadas). Só pode ser definida por um administrador da organização desta marca.

PUT /api/brands/{brandId}

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

{}

Listar as instalações de uma marca

Retorna uma lista simplificada das instalações (ID, nome, código ISO da região) pertencentes à marca. Usada para preencher os seletores de instalações de destino na configuração da marca.

Parâmetros

brandId `string` (obrigatório) O ID da marca cujas instalações serão listadas

GET /api/brands/{brandId}/facilities

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

{}

Retorna a lista de todas as marcas associadas à organização do clube.

GET /api/clubs/{club}/brands

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

{}

Retorna a lista de todos os tipos de calendário

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"

{}

Excluir um banner do painel

Faz a exclusão lógica de um banner do painel pertencente à marca.

Parâmetros

brandId `string` (obrigatório) O ID da marca à qual o banner pertence bannerId `string` (obrigatório) O ID do banner a excluir

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"

{}

Listar os banners do painel de uma marca

Retorna todos os banners do painel (não excluídos) configurados para a marca, para gerenciamento administrativo.

Parâmetros

brandId `string` (obrigatório) O ID da marca cujos banners serão listados

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"

{}

Criar ou atualizar um banner do painel

Cria um novo banner do painel para a marca ou atualiza um existente quando `bannerId` é informado no corpo. Os banners podem ser agendados (início/fim em segundos unix, null = sem limite) e direcionados à marca inteira, a regiões específicas (códigos ISO) ou a instalações específicas.

Parâmetros

brandId `string` (obrigatório) O ID da marca à qual o banner pertence

Corpo da solicitação

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

{}

Obter os banners ativos do painel de uma instalação

Determina os banners do painel que devem ser exibidos no momento para uma instalação, com base na marca, na região (código de país ISO) da instalação e no sinalizador de ativação, na janela de agendamento e na segmentação de cada banner. Usado pelas interfaces do painel.

Parâmetros

facilityId `string` (obrigatório) O ID da instalação para a qual os banners serão determinados

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"

{}

Retorna o arquivo KYC de um clube.

Parâmetros

clubId `string` (obrigatório) O ID do clube. key `string` (obrigatório) A chave do arquivo 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"

{}

Retorna as informações KYC do clube.

GET /api/clubs/{clubId}/kyc

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

{}

Atualiza as informações KYC do clube.

Parâmetros

clubId `string` (obrigatório) O ID do clube a atualizar. body `object` (obrigatório)

PUT /api/clubs/{clubId}/kyc

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

{}

Envia um arquivo KYC de um clube.

Parâmetros

clubId `string` (obrigatório) O ID do clube. file `string` (obrigatório) O arquivo a enviar.

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"

{}

Retorna as configurações de preferências do clube.

GET /api/club/preferences/:club

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

{}

Cria ou atualiza a entrada de preferências do clube.

Corpo da solicitação

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

{}

Retorna a lista de membros com contrato.

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"

{}

Retorna a lista de membros com contrato.

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"

{}

Retorna uma lista dos usuários do clube especificado

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar

GET /api/clubs/{club}/members

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

{}

Informa se o clube está aberto na data especificada.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. date `string` (obrigatório) Data a verificar, em formato 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"

{}

Retorna todos os metadados do clube exibidos nos sites do Example Club.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Atualiza os metadados de um clube com novos dados fornecidos pelo front-end. Os campos ausentes do corpo da solicitação são preservados (sem SET, sem REMOVE). Os campos enviados como `null` ou string vazia são apagados. Passe `updateAll: false` para usar o caminho dedicado de mesclagem parcial; de qualquer forma, quem chama nunca precisa enviar campos que não são seus.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. body `string` (obrigatório) Objeto JSON dos dados do clube que você deseja atualizar.

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"

{}

adicionar um novo registro de rastreamento personalizado

Parâmetros

club `string` (obrigatório) ID do clube body `string` (obrigatório) Array de itens de rastreamento personalizado.

POST /api/clubs/{club}/customtracking

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

{}

Retorna o rastreamento personalizado de um clube específico

GET /api/clubs/customtracking/:clubID

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

{}

Atualizar entradas de rastreamento personalizado

Parâmetros

club `string` (obrigatório) ID do clube body `string` (obrigatório) Objeto JSON dos dados do clube que você deseja atualizar.

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"

{}

Retorna a imagem padrão da fachada de um clube.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Listar as portas disponíveis na instalação

Parâmetros

body `object` (obrigatório) Objeto JSON dos dados do clube que você deseja atualizar.

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"

{}

Destrancar uma porta específica da instalação

Parâmetros

body `object` (obrigatório) Objeto JSON dos dados do clube que você deseja atualizar.

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"

{}

Retorna todas as integrações e os detalhes de configuração do clube especificado.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Atualiza os metadados de um clube com novos dados fornecidos pelo front-end.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. body `object` (obrigatório) Objeto JSON dos dados do clube que você deseja atualizar.

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"

{}

Retorna um booleano indicando se o clube está ou não em um país europeu

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. date `string` (obrigatório) Data a verificar, em formato 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"

{}

Retorna uma lista geral de todos os clubes do nosso banco de dados.

GET /api/clubs/listclubs

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

{}

Informa se o clube está aberto na data especificada.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. date `string` (obrigatório) Data a verificar, em formato 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"

{}

Obter as avaliações do clube no DynamoDB.

Parâmetros

club `string` (obrigatório) ID do clube

GET /api/clubs/{club}/reviews

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

{}

Obter as configurações de avaliações do clube no DynamoDB.

Parâmetros

facilityId `string` (obrigatório) ID da instalação

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"

{}

Atualizar as configurações de avaliações do clube no DynamoDB.

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Reativar a publicação automática nas configurações de avaliações.

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Publica uma avaliação

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. review `string` (obrigatório) ID interno da avaliação que você deseja publicar.

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"

{}

Reativar a publicação automática nas configurações de avaliações.

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Publica uma resposta a uma avaliação pelo publicador de origem (Google etc.).

Parâmetros

club `string` (obrigatório) ID da instalação reviewId `string` (obrigatório) ID da avaliação no PH (consultado na tabela club-social-reviews) body `string` (obrigatório)

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"

{}

Cancela a publicação de uma avaliação

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. review `string` (obrigatório) ID interno da avaliação cuja publicação você deseja cancelar.

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"

{}

Retorna uma lista dos proprietários do clube especificado a partir do banco de dados do PH

Parâmetros

clubID `string` (obrigatório) ID interno do clube que você deseja acessar

GET /api/clubs/{clubID}/owners

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

{}

Retorna todos os planos de associação da instalação.

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação

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"

{}

Atualiza um registro de plano de associação.

Parâmetros

facilityId `string` (obrigatório) ID interno da instalação body `object` (obrigatório) Objeto JSON dos dados do plano de associação que você deseja atualizar.

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"

{}

Reativar a publicação automática nas configurações de avaliações.

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Reativar a publicação automática nas configurações de avaliações.

Parâmetros

club `string` (obrigatório) ID do clube

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"

{}

Retorna a lista de todas as moedas disponíveis

GET /api/currencies

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

{}

Retorna a localização geográfica com base no endereço IP.

Parâmetros

ip `string` (obrigatório) Endereço IP a consultar

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"

{}

Retorna a localização geográfica do usuário atual com base no IP dele.

GET /api/geo/ip-current

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

{}

Retorna apenas o endereço IP público do cliente solicitante (sem consulta de geolocalização e sem chamada a APIs de terceiros). Usado pelo aplicativo de Agente de IA para comparar o IP público do navegador com o IP WAN informado pelo dispositivo, para detectar se estão na mesma rede.

GET /api/geo/client-ip

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

{}

Analisador de números de telefone.

Parâmetros

body `string` (obrigatório) Objeto JSON com o número que você quer analisar.

POST /api/phone/parser

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

{}

Retorna o dispositivo de relógio principal

Parâmetros

club_id `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo.

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"

{}

Retorna o dispositivo Sonos principal

Parâmetros

club_id `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo.

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"

{}

obter as notificações de bateria fraca do Duress de um clube.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna dados de análise da rede

Parâmetros

club_id `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo.

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"

{}

enviar as notificações de bateria fraca do Duress de um clube.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna dados de teste de velocidade dos dispositivos para cada tipo de dispositivo

Parâmetros

club_id `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo.

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"

{}

Obtém os insights de listagem de uma instalação. Por padrão, retorna totais diários agregados de todos os publicadores, ou de um único publicador quando `publisherId` é informado.

Parâmetros

facilityId `string` (obrigatório) publisherId `string` (opcional) startDate `string` (obrigatório) endDate `string` (obrigatório)

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"

{}

Obtém os insights de listagem agregados de uma marca em todos os publicadores.

Parâmetros

brandId `string` (obrigatório) startDate `string` (obrigatório) endDate `string` (obrigatório)

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"

{}

Principais palavras-chave de pesquisa (com divisão entre com marca e sem marca) de uma instalação, atualmente obtidas do Google Business Profile.

Parâmetros

facilityId `string` (obrigatório) publisherId `string` (opcional) O padrão é "google"; atualmente apenas o Google é compatível. startDate `string` (obrigatório) endDate `string` (obrigatório) limit `string` (opcional)

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"

{}

Principais palavras-chave de pesquisa de uma marca, agregadas em todas as instalações.

Parâmetros

brandId `string` (obrigatório) startDate `string` (obrigatório) endDate `string` (obrigatório) limit `string` (opcional)

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"

{}

Listar as perguntas e respostas de uma instalação.

Parâmetros

facilityId `string` (obrigatório)

GET /api/facilities/{facilityId}/qna

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

{}

Responder a uma pergunta.

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"

{}

Excluir uma resposta.

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"

{}

Retorna os publicadores ativados para a organização da instalação, com o status de conexão de cada um.

Parâmetros

facilityId `string` (obrigatório) organisationId `string` (obrigatório)

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"

{}

Obter as configurações compartilhadas do Door & Gate Access de uma instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualizar as configurações compartilhadas do Door & Gate Access de uma instalação

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Obter as Access Policies de uma instalação

A configuração de acesso existente é convertida automaticamente em políticas aplicadas equivalentes na primeira leitura.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Substituir as Access Policies com verificação otimista de revisão

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Criar uma Access Policy

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualizar uma Access Policy

Parâmetros

facilityId `string` (obrigatório) policyId `string` (obrigatório)

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"

{}

Excluir uma Access Policy

Parâmetros

facilityId `string` (obrigatório) policyId `string` (obrigatório) revision `integer` (obrigatório)

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"

{}

Duplicar uma Access Policy com um novo ID estável

Parâmetros

facilityId `string` (obrigatório) policyId `string` (obrigatório)

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"

{}

Contar os usuários e as portas afetados por todas as Access Policies

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Contar os usuários e as portas afetados por uma Access Policy

Parâmetros

facilityId `string` (obrigatório) policyId `string` (obrigatório)

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"

{}

Listar os tipos de pessoa, status e tags da instalação

Retorna os valores distintos de tipo de pessoa, status de associação e tag presentes nas linhas de acesso de usuários da instalação (ph-door-access-users), derivados da sincronização com parceiros e da entrada manual. O aplicativo door-gate-access usa esses valores para preencher as listas suspensas das regras de acesso. As tags são a união das `tags` sincronizadas com as `customTags` do administrador, igual ao avaliador de regras.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Listar os controladores de porta de uma instalação com as regras efetivas do Door & Gate Access

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Salvar as substituições por porta, o ícone e a configuração do lado do dispositivo

Ponto único de gravação para tudo o que o aplicativo de administração do DGA edita em uma porta: - `accessRulesOverride` / `geofenceOverride`: informe `null` para limpar e voltar ao padrão da instalação. - `icon`: chave estável de transmissão (consulte services/door-access/door-icons.js); valores desconhecidos retornam 400. - `holdTimeSeconds` (1–30), `maintenanceMode` (`off` / `force-open` / `force-closed`), `doorLocation` (texto livre, ≤64 caracteres), `playNotificationSoundOnRelayToggle` (booleano), `autoUnlockSchedule` (grade de janelas semanais). Antes eram campos exclusivos do Gerenciamento de dispositivos, mas agora o aplicativo os grava diretamente para que os administradores não precisem sair do painel lateral da porta para alterações de configuração do dia a dia. Quando algum dos campos do lado do dispositivo é alterado, a rota também envia as variáveis de ambiente correspondentes do Balena (`RELAY_NOTIFICATION_SOUND`, `DOOR_MAINTENANCE_MODE`, `DOOR_AUTO_UNLOCK_SCHEDULE`) e dispara um comando MQTT `unlockUpdates` para que o dispositivo receba a nova configuração sem esperar a próxima atualização de ambiente do Balena. Melhor esforço: a resposta é 200 mesmo que o Balena esteja temporariamente inacessível.

Parâmetros

facilityId `string` (obrigatório) doorId `string` (obrigatório)

Corpo da solicitação

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

{}

Verificação leve do status do Balena para o aviso de recarga no painel lateral da porta

O painel lateral do aplicativo DGA busca isso sob demanda quando um administrador abre uma porta, para mostrar o texto correto de "salvar recarregará o controlador": a variante padrão "alguns segundos" ou a variante mais forte "vários minutos" quando também há uma atualização de versão pendente. Retorna um snapshot simples derivado de `balena.models.device.get()`. Em caso de falha, retorna `data: null` (em vez de um erro 5xx) para que uma indisponibilidade do Balena apenas degrade o texto do aviso em vez de impedir a abertura do painel lateral.

Parâmetros

facilityId `string` (obrigatório) doorId `string` (obrigatório)

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"

{}

Substituição pelo administrador: destravar uma porta pelo aplicativo

Aciona brevemente o relé usando o `holdTimeSeconds` atual da porta, gravando uma linha de auditoria `admin-override` em ph-door-app-access-events para que a ação seja atribuível nos Registros de acesso. Sempre funciona, independentemente de `maintenanceMode === 'force-closed'`: esta é a saída de emergência do administrador. Retorna 200 assim que a publicação MQTT é despachada; os estados confirmado / com falha / expirado não são aguardados aqui (o fluxo legado /api/devices/door-controllers + /api/ics/devices/command também é do tipo disparar e esquecer).

Parâmetros

facilityId `string` (obrigatório) doorId `string` (obrigatório)

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"

{}

Tocar um padrão de bipes de localização no controlador de porta

Publica um comando MQTT `beep` para que o controlador emita três bipes de duração média (~500 ms cada, intervalo de ~350 ms, ~2 s no total). Usado pelos administradores para localizar fisicamente um controlador de porta no local. O botão legado do Gerenciamento de dispositivos usa uma sequência de ~30 s de bipes curtos, mas o driver do buzzer do firmware só emite o primeiro de forma confiável, por isso o aplicativo envia um padrão mais curto e confiável. Sem linha de auditoria: é uma ação de diagnóstico sem efeito colateral no controle de acesso.

Parâmetros

facilityId `string` (obrigatório) doorId `string` (obrigatório)

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"

{}

Reiniciar remotamente um controlador de porta

Publica o mesmo comando MQTT `rebootDevice` do tipo disparar e esquecer que o botão legado "Remotely Reboot Device" do Gerenciamento de dispositivos envia, mas controlado pelo módulo `door-gate-access` para que os administradores do DGA possam reiniciar um controlador na seção Advanced do painel lateral da porta sem uma concessão `device-management` separada. Retorna 200 assim que a publicação é despachada; o dispositivo fica off-line durante a reinicialização.

Parâmetros

facilityId `string` (obrigatório) doorId `string` (obrigatório)

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"

{}

Listar as linhas de acesso de usuários de uma instalação

Retorna todas as linhas de acesso de usuários não excluídas da instalação. Aceita filtros do lado do cliente (source, search, accessEnabled, hasGrants). O cálculo `hideExcluded` no servidor, da Fase 4, será adicionado quando o avaliador de concessões híbridas for lançado; por enquanto, o parâmetro é aceito, mas retorna o conjunto completo.

Parâmetros

facilityId `string` (obrigatório) search `string` (opcional) source `string` (opcional) accessEnabled `string` (opcional) hasGrants `string` (opcional) hideExcluded `boolean` (opcional) Quando true, os usuários sincronizados (source != manual) que não poderiam passar por nenhuma porta em nenhum momento nesta instalação ficam ocultos. A resposta inclui um envelope `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"

{}

Criar manualmente uma linha de acesso de usuário em uma instalação

Cria uma nova linha com `source: 'manual'`. Retorna 409 com `existingUserId` se o telefone ou e-mail informado já corresponder a uma linha nesta instalação.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

Obter uma única linha de acesso de usuário

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Atualização parcial de uma linha de acesso de usuário

Edita qualquer subconjunto dos campos de identidade / autorização. Informe `null` para limpar um campo opcional. Retorna 409 se o novo telefone ou e-mail coincidir com outra linha na mesma instalação. `appMessage` aceita o mesmo formato da mensagem para toda a instalação em PUT /api/door-access/rules/{facilityId}: texto do corpo, gravidade, link opcional e agendamento opcional de início/fim. O aplicativo móvel mostra isso no painel apenas para o usuário em questão.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

Corpo da solicitação

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

{}

Excluir logicamente uma linha de acesso de usuário

Marca a linha como `deleted: true` e desativa o acesso. O vínculo do registro de auditoria com o userId é preservado; os administradores podem reativá-la manualmente.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Atribuição de acesso por porta de um usuário

Para cada porta, retorna a autorização determinística atual (`allowedNow`, `allowedVia`, `deniedReason`) e os caminhos configurados para Access Policies, concessões permanentes, agendamentos de políticas, concessões de janela de tempo do administrador e janelas de origem de parceiros mapeadas e recentes. Também retorna a disponibilidade ativa/próxima e a atualidade das origens. O blockAllAccess e a manutenção da porta são avaliados antes de todos os caminhos de permissão.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Criar em massa linhas de acesso de usuários a partir de uma importação CSV

Cria várias linhas `source: 'manual'` em uma única solicitação, reutilizando a mesma validação, normalização de telefone/e-mail, verificação de conflito por instalação, mensagens automáticas e lógica de convite (opcional) da criação individual. As linhas são processadas em ordem, portanto uma linha posterior que conflite com outra criada antes é informada como duplicada. As concessões são fornecidas como IDs de porta/grupo já resolvidos (o cliente converte os nomes em IDs). Concessões de janela de tempo são rejeitadas intencionalmente em massa e devem ser adicionadas pelo endpoint de substituição por usuário após a importação. Nunca gera exceção por linha; o resultado de cada linha é informado individualmente.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Substituir as concessões de autorização híbrida em uma linha de acesso de usuário

Conexão do avaliador híbrido da Fase 3. As concessões coexistem com as regras de tag da instalação: um usuário é autorizado quando qualquer uma delas corresponde no momento do destravamento.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

Corpo da solicitação

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

{}

Substituir as concessões adicionais de Access Time Windows em uma linha de acesso de usuário

Substitui apenas `timeWindowGrants`; as `grants` permanentes e as `sourceTimeWindows` de integrações não são alteradas. Cada item exige um escopo (`facilityWide`, `doors` ou `groups`) e uma `window` absoluta ou semanal. Enviar uma matriz vazia limpa explicitamente todas as janelas do administrador.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

Corpo da solicitação

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

{}

Congelar uma linha de acesso de usuário contra atualizações de sincronização da origem

Define `decoupledFromSource: true`, limpa todas as `sourceTimeWindows` pertencentes a integrações e faz com que a sincronização (cron + streams) registre e ignore esta linha até que um administrador limpe o sinalizador via /recouple.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Reconectar uma linha de acesso de usuário às atualizações de sincronização da origem

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Revogar todos os tokens de atualização do aplicativo Door & Gate Access de um usuário

Revoga pelo telefone/e-mail armazenado do usuário (a tabela de tokens de atualização é indexada por `sha256(plaintext)`; os GSIs byMobilePhone / byEmail permitem excluir em cascata a partir de um único usuário). Outros usuários que compartilham o mesmo telefone/e-mail em outra instalação também seriam desconectados.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

(Re)enviar a um usuário o e-mail de convite do aplicativo Door & Gate Access

Força o envio do e-mail de convite para baixar o aplicativo ao endereço de e-mail armazenado do usuário (somente e-mail, sem SMS). Ignora as verificações de elegibilidade e de envio anterior usadas no caminho de sincronização automática: esta é uma ação explícita do administrador. Retorna 400 se o usuário não tiver e-mail cadastrado.

Parâmetros

facilityId `string` (obrigatório) userId `string` (obrigatório)

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"

{}

Visualizar os destinatários de um envio em massa de convites do aplicativo

Calcula o conjunto de usuários que receberiam um e-mail de convite do aplicativo. O grupo base são todos os usuários não excluídos com e-mail que nunca usaram o aplicativo (`appLastSeenAt` vazio). Por padrão, o grupo é restrito aos usuários que têm acesso no momento (correspondência de regra ou concessão) e nunca foram convidados; `includeAlreadyInvited` e `includeNoAccess` o ampliam. Nenhum e-mail é enviado: retorna contagens, uma pequena amostra e os userIds candidatos para o endpoint de execução.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Enviar e-mails de convite do aplicativo a um lote de usuários

Envia o e-mail de convite para baixar o aplicativo a cada um dos userIds informados (máximo de 50 por solicitação; o cliente divide em lotes a lista completa de candidatos da visualização). Cada usuário é revalidado no momento do envio: linhas que não existem mais, não têm e-mail ou usaram o aplicativo desde a visualização são ignoradas, nunca marcadas como falha. Os resultados por usuário são informados individualmente para que o cliente possa resumir enviados / com falha / ignorados.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Listar os grupos de portas de uma instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Criar um grupo de portas

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

Obter um único grupo de portas

Parâmetros

facilityId `string` (obrigatório) groupId `string` (obrigatório)

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"

{}

Atualizar um grupo de portas

Parâmetros

facilityId `string` (obrigatório) groupId `string` (obrigatório)

Corpo da solicitação

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

{}

Excluir logicamente um grupo de portas

Parâmetros

facilityId `string` (obrigatório) groupId `string` (obrigatório)

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"

{}

Listar as integrações de parceiros configuradas em uma instalação

Retorna as integrações de parceiros da instalação (id, nome, logotipo, ativado) combinando ph-facility-partner-config com o catálogo ph-partners. Restrito ao escopo do Door & Gate Access (para que administradores sem acesso a external-integrations ainda possam exibir os selos de parceiros e a lista de sincronização por parceiro).

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Ler a configuração de sincronização de acesso de usuários de uma instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualizar a configuração de sincronização de acesso de usuários de uma instalação

Somente os campos controlados pelo administrador (`enabled`, `requireIdentifier` e o mapa `partners` do parceiro) são aceitos; `lastRunAt` e `lastRunCounts` são gravados pelo próprio mecanismo de sincronização. `partner.partners` é um mapa de ativação por parceiro indexado por partnerId (exclusão voluntária): quando o `partner.enabled` principal está ativado, um parceiro é sincronizado, a menos que tenha aqui uma entrada explícita `{ enabled: false }`.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Ler a configuração de mensagens automáticas por usuário de uma instalação

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualizar a configuração de mensagens automáticas por usuário de uma instalação

Salva as regras e, em seguida, reavalia imediatamente todas as linhas de acesso de usuários da instalação para que os usuários existentes recebam ou percam a mensagem automática na hora. Mensagens manuais e linhas desvinculadas não são alteradas.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Status da reavaliação em segundo plano das mensagens automáticas

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Executar sob demanda uma sincronização de acesso de usuários para uma instalação

Percorre de forma síncrona todas as origens ativadas (partner / cctv) da instalação e consolida as linhas de ph-door-access-users por meio da cascata de desduplicação. Retorna contagens por origem. Origens desativadas aparecem como `skippedSyncDisabled: 1` em vez de ausentes, para que a interface possa exibir as duas linhas de forma consistente.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Simulação de uma exclusão em massa de usuários sincronizados por parceiros

Retorna a contagem + uma amostra das linhas de acesso de usuários que seriam excluídas logicamente, além de um confirmToken que deve ser enviado de volta ao endpoint de execução. Nenhum dado é modificado. Os registros de acesso nunca são afetados.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Executar uma exclusão em massa de usuários sincronizados por parceiros (exclusão lógica)

Exclui logicamente todas as linhas de acesso de usuários sincronizadas por parceiros no escopo. Exige o confirmToken retornado pela visualização; se o conjunto atual tiver mudado desde a visualização, o token não corresponderá e a solicitação será rejeitada (409) para que o administrador revise novamente. Os registros de acesso são preservados.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Atividade recente de sincronização de acesso de usuários (registro para solução de problemas)

Retorna os resultados de sincronização mais recentes de uma instalação (criado / ignorado / desativado) com o motivo, para que os administradores possam ver por que um membro foi ou não sincronizado. Mais recentes primeiro.

Parâmetros

facilityId `string` (obrigatório) limit `integer` (opcional)

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"

{}

Listar os eventos do Door & Gate Access de uma instalação

Retorna os eventos de destravamento pelo celular, por substituição do administrador e pela Partner API externa em um único feed em ordem cronológica inversa.

Parâmetros

facilityId `string` (obrigatório) from `integer` (opcional) to `integer` (opcional) limit `integer` (opcional)

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"

{}

Simular uma avaliação de geofence para o pino do modo de teste do administrador

Corpo da solicitação

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

{}

Obter o status de integração / ativação de uma instalação

Alimenta a página inicial "Get Started" e o banner de progresso da configuração do aplicativo. Retorna as contagens atuais de portas e usuários, as duas etapas principais derivadas (existe um usuário, existe uma porta), os sinalizadores opcionais "reviewed" salvos e se a instalação está ativada (ambas as etapas principais concluídas). Na primeira vez que uma instalação é ativada, o carimbo de data/hora activatedAt é registrado.

Parâmetros

facilityId `string` (obrigatório)

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"

{}

Atualizar os sinalizadores opcionais de integração "reviewed" de uma instalação

Salva os sinalizadores opcionais da lista de configuração que um administrador marca (regras de acesso, configurações de sincronização, geofencing). As etapas principais e a ativação são derivadas em tempo real das contagens de dados e não podem ser definidas aqui. Retorna o status de integração completo e atualizado.

Parâmetros

facilityId `string` (obrigatório)

Corpo da solicitação

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

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

GET /clubs/{clubId}/lead-events

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

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

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"

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

GET /clubs/{clubId}/analytics/referrers

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

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

GET /clubs/{clubId}/analytics/socials

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

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

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"

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

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"

{}

Retorna uma resposta JSON com os dados de análise da instalação.

Parâmetros

clubId `string` (opcional) O ID da instalação cujos dados de análise serão obtidos. fromDate `string` (opcional) A data de início dos dados de análise a obter. toDate `string` (opcional) A data de término dos dados de análise a obter.

GET /clubs/{clubId}/analytics/traffic

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

{}

Gera um JWT (JSON Web Token) temporário de front-end para os gráficos incorporáveis do Google Analytics na página 'analytics' do front-end.

GET /api/ga/onetimetoken

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

{}

Retorna widgets do painel do 'The Training Camp' se a instalação tiver membros ativos.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna todos os feriados da instalação ainda não revisados.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Marcar como revisados todos os feriados da instalação ainda não revisados.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna o relatório de KPIs em formato CSV, detalhado mês a mês nos últimos 12 meses. *OBSERVAÇÃO* Isso cria um único relatório para TODAS as instalações do sistema. Não execute isso várias vezes em paralelo, ou você sobrecarregará o GymMaster!

Parâmetros

months `string` (opcional) Número de meses (a partir da data atual) a buscar (padrão: 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"

{}

Retorna os gráficos de receita do MMS de uma determinada instalação.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. range `string` (opcional) Intervalo em dias (contando a partir da data atual para trás) que queremos buscar

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"

{}

Retorna os dados/análises do MMS (Member Management System) do painel para uma determinada instalação. Os dados incluem estatísticas do GymMaster/Perfect Gym, além de outras métricas internas coletadas pelo nosso sistema.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar. range `string` (opcional) Intervalo em dias (contando a partir da data atual para trás) que queremos buscar

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"

{}

Retorna os dados do widget Myzone do painel para uma determinada instalação.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna um objeto com os serviços considerados off-line por um ou mais dos nossos endpoints de página de status/monitoramento, configurados pela ferramenta interna '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"

{}

Retorna as reservas de treino dos próximos 7 dias.

Parâmetros

club `string` (obrigatório) ID interno do clube que você deseja acessar.

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"

{}

Retorna a lista de feriados históricos de uma instalação.

Parâmetros

clubId `string` (opcional) ID do clube fromDate `string` (opcional) Carimbo de data/hora Unix da data de início do intervalo de feriados a retornar. toDate `string` (opcional) Carimbo de data/hora Unix da data de término do intervalo de feriados a retornar.

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"

{}

Retorna as automações de dispositivos associadas à instalação.

Parâmetros

club `string` (obrigatório) ID interno do clube cujos dispositivos você deseja listar.

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"

{}

Atualiza a configuração de uma tela/dispositivo existente.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Adiciona/associa à sua instalação um dispositivo de tela ou computador físico.

Parâmetros

club `string` (obrigatório) ID interno do clube ao qual você deseja adicionar o dispositivo. body `string` (obrigatório) Objeto JSON da nova tela a associar.

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"

{}

Instrui o dispositivo a se conectar a um novo SSID com base nos parâmetros.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Atualiza a configuração de uma tela/dispositivo existente.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Carrega uma URL/página da web na tela de um dispositivo específico.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Atualiza a configuração de uma tela/dispositivo existente.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON dos parâmetros de atualização.

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"

{}

Renomeia uma tela/dispositivo. Altera apenas o registro: diferentemente do endpoint de atualização, nada é enviado ao dispositivo, por isso também está disponível para telas que executam uma versão de software em fim de vida útil.

Parâmetros

club `string` (obrigatório) ID interno da instalação à qual o dispositivo pertence. body `string` (obrigatório) Objeto JSON com os parâmetros de renomeação.

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"

{}

Obtém os widgets e os links para mídia off-line de uma instalação, com base na data informada.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer alterar o programa de treino. date `string` (obrigatório) Data para a qual retornar as URLs dos widgets. Use o formato `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"

{}

Obtém os widgets e os links para mídia off-line de uma instalação, com base na data informada.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer alterar o programa de treino.

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"

{}

Altera o programa de treino de uma determinada instalação.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer alterar o programa de treino. body `string` (obrigatório) Objeto JSON com o novo treino a ser alterado.

POST /api/ics/loadprogram/{club}

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

{}

Obtém a configuração de programa de uma tela/dispositivo existente.

Parâmetros

club `string` (obrigatório) ID interno da instalação cujos dados de programa você quer obter.

GET /api/ics/programs/{club}

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

{}

Atualiza a configuração de programa de uma tela/dispositivo existente.

Parâmetros

club `string` (obrigatório) ID interno da instalação na qual você quer atualizar o dispositivo. body `string` (obrigatório) Objeto JSON com os parâmetros de atualização.

PUT /api/ics/programs/{club}

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

{}

Obtém as opções de configuração de programa.

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"

{}

Chat com contexto RAG. Não tem acesso a ferramentas, apenas a uma ferramenta simples de solicitação|resposta de API que permite obter conhecimento diretamente da base de conhecimento.

Parâmetros

organisationId `string` (opcional) O ID da organização (detectado automaticamente se não for informado)

Corpo da solicitação

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

{}

Excluir os embeddings de artigos do repositório de vetores e atualizar o status de rastreamento de embeddings

Corpo da solicitação

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

{}

Listar os registros do rastreador de embeddings por organização e status

Parâmetros

organisationId `string` (opcional) ID da organização (determinado automaticamente se omitido) status `string` (obrigatório) Status pelo qual filtrar (deve ser um de in_queue, done, anomaly, fail, deleted) Limit `string` (opcional) Máximo de itens por página LastEvaluatedKey `string` (opcional) JSON do LastEvaluatedKey do DynamoDB para paginação

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"

{}

Listar os registros do rastreador de embeddings por organização (opcionalmente filtrados por tipo de recurso)

Parâmetros

organisationId `string` (opcional) ID da organização (determinado automaticamente se omitido) resourceType `string` (opcional) Tipo de recurso opcional (por exemplo, "article"). Quando informado, filtra os itens em que resourceTypeId começa com "{type}#". Limit `string` (opcional) Máximo de itens por página LastEvaluatedKey `string` (opcional) JSON do LastEvaluatedKey do DynamoDB para paginação

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"

{}

Inicializar a coleção do banco de dados de vetores da organização

Parâmetros

organisationId `string` (opcional) O ID da organização (detectado automaticamente se não for informado)

POST /api/llm/init-org

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

{}

Pesquisa semântica na base de conhecimento

Parâmetros

organisationId `string` (opcional) O ID da organização (detectado automaticamente se não for informado)

Corpo da solicitação

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

{}

Iniciar o processamento em streaming dos artigos na fila para embedding, com atualizações de progresso em tempo real

Parâmetros

organisationId `string` (opcional) O ID da organização (detectado automaticamente se não for informado)

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"

{}

Inserir ou atualizar os embeddings de artigos no banco de dados de vetores

Trata o embedding do artigo com base no estado atual: - Se o artigo não estiver publicado OU for privado: exclui os embeddings - Se o artigo estiver publicado E for público: refaz os embeddings com o conteúdo completo Sempre exige o corpo completo do artigo.

Parâmetros

organisationId `string` (opcional) O ID da organização (detectado automaticamente se não for informado)

Corpo da solicitação

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

{}

Endpoint de teste para excluir em lote os embeddings de artigos por organização e, opcionalmente, por status

Parâmetros

organisationId `string` (opcional) ID da organização (determinado automaticamente a partir do contexto do usuário se omitido) status `string` (opcional) Status pelo qual filtrar (opcional; se omitido, exclui TODOS os artigos da organização, independentemente do status) hardDelete `string` (opcional) Se os registros de rastreamento de embeddings devem ser excluídos definitivamente (true) ou excluídos logicamente com a atualização do status (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"

{}

Transformar e dividir texto em blocos com estatísticas detalhadas

Endpoint de teste que transforma o texto e o divide em blocos, depois fornece estatísticas detalhadas sobre a distribuição dos blocos, incluindo contagens de caracteres, porcentagens e métricas de qualidade, para ajudar a avaliar a eficácia da divisão.

Corpo da solicitação

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

{}