Introdução

Esta é a API principal usada por sites e sistemas voltados ao público. **Se você é um desenvolvedor terceiro e quer usar esta API, entre em contato com o suporte do Performance Hub para incluir seus IPs na lista de permissões; caso contrário, você terá a taxa limitada e/ou será bloqueado se houver solicitações demais do mesmo referenciador / IP.**

URL base

https://uapi.gymsystems.co/

Autenticação

A Universal API usa autenticação por chave de API por meio de cabeçalhos HTTP.

Inclua sua chave de API no cabeçalho X-API-Key em cada solicitação.

Trate suas chaves de API com cuidado: elas dão acesso total à sua conta. Nunca exponha essas chaves em repositórios públicos, aplicativos do lado do cliente ou em qualquer lugar onde possam ser comprometidas.

A API aceita apenas conexões HTTPS seguras. Solicitações HTTP simples são rejeitadas, assim como qualquer solicitação sem as credenciais de autenticação adequadas.

Exemplo de solicitação

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

Formulário de contato geral

A API usada para mensagens de 'contato geral' dos sites do Example Club e de outros serviços externos (como o training camp etc.).

Parâmetros

organisationId `string` (opcional) O ID da organização para a qual você quer obter os dados das instalações. Isso garante que retornemos apenas instalações que fazem parte da mesma organização. leadForwarding `string` (opcional) Os e-mails devem ser encaminhados para algum sistema de gestão de leads (gymsales, gymleads etc.)? Observação: definir como `onlyForwardIfConfigured` encaminha os leads para qualquer CRM, mas não para o e-mail principal da instalação...

Corpo da solicitação

Corpo do contato geral

Endpoint

POST /api/v1/support/contact-submission

Exemplo de solicitação

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

Resposta

{}

Avaliação gratuita

Gera uma solicitação de página de destino de 'avaliação gratuita' para a instalação especificada

Corpo da solicitação

Corpo da avaliação gratuita

Endpoint

POST /api/v1/leads/free-trial

Exemplo de solicitação

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

Resposta

{}

Reservar um treino

A API usada para o formulário 'reservar um treino' dos sites do Example Club.

Corpo da solicitação

Corpo da reserva de treino

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Envios de leads do Training Camp

Rastreia os envios de registro de interesse do usuário no Training Camp a partir dos nossos sites principais. Essas informações são usadas para encaminhar o usuário ao aplicativo/site trainingcamp.com e para que as instalações inscrevam o membro no training camp.

Corpo da solicitação

Corpo da página

Endpoint

POST /api/v1/leads/training-camp

Exemplo de solicitação

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

Resposta

{}

Obtém os metadados de uma instalação individual ou de todas as instalações

Esta API retorna os metadados usados para renderizar a página de uma instalação individual ou de todas as instalações do banco de dados.

Parâmetros

organisationId `string` (opcional) O ID da organização para a qual você quer obter os dados das instalações. Isso garante que retornemos apenas instalações que fazem parte da mesma organização. club `string` (opcional) O ID da instalação que você quer obter... *Observação* Você pode omitir isso se quiser retornar TODAS as instalações como um único objeto JSON.

Endpoint

GET /api/v1/club/data

Exemplo de solicitação

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

Resposta

{}

Obtém os metadados de uma instalação individual ou de todas as instalações

Esta API retorna os metadados usados para renderizar a página de uma instalação individual ou de todas as instalações do banco de dados.

Parâmetros

organisationId `string` (opcional) O ID da organização para a qual você quer obter os dados das instalações. Isso garante que retornemos apenas instalações que fazem parte da mesma organização. club `string` (opcional) O ID da instalação que você quer obter... *Observação* Você pode omitir isso se quiser retornar TODAS as instalações como um único objeto JSON.

Endpoint

GET /api/v2/club/data

Exemplo de solicitação

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

Resposta

{}

Pesquisar instalações por cidade e lat/lng

Faz uma pesquisa de instalações próximas, com base na sua latitude, longitude e nos termos de pesquisa (como um bairro, município ou cidade)

Parâmetros

geogroup `string` (opcional) Retorna uma lista 'agrupada' das cidades/estados/países em que as instalações estão localizadas search `string` (opcional) O termo a pesquisar. Geralmente será um município, cidade, bairro ou código postal limit `string` (opcional) Número máximo de resultados origin `string` (opcional) A latitude e a longitude a partir das quais a pesquisa será feita. Isso é fundamental ao pesquisar municípios/bairros com o mesmo nome, mas em países/cidades diferentes onde temos várias instalações, por exemplo, `Southbank Example City` ou `Southbank Example City 2` organisationId `string` (opcional) O ID da organização pelo qual filtrar as instalações. Isso garante que retornemos apenas instalações que fazem parte da mesma organização.

Endpoint

GET /api/v1/club/geosearch

Exemplo de solicitação

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

Resposta

{}

Lista as avaliações fixadas de uma instalação individual

Esta API retorna as avaliações fixadas da instalação.

Parâmetros

club `string` (opcional) O ID da instalação que você quer obter

Endpoint

GET /api/v2/club/reviews

Exemplo de solicitação

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

Resposta

{}

Obter a configuração de um aplicativo definida na instalação informada

Obter a configuração de um aplicativo definida na instalação informada

Parâmetros

clubID `string` (opcional) O ID da instalação que você quer obter appID `string` (opcional) O ID do aplicativo que você quer obter

Endpoint

GET /api/v1/club/apps/config

Exemplo de solicitação

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

Resposta

{}

Latitude e longitude com base no IP do usuário

Retorna a latitude e a longitude estimadas do IP de um usuário com base no banco de dados GeoIP da Maxmind.

Endpoint

GET /api/v1/geo/ip

Exemplo de solicitação

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

Resposta

{}

Analisa uma string de endereço e a retorna como um objeto.

Converte a string de endereço em um objeto composto por rua, cidade, estado e código postal.

Corpo da solicitação

Corpo da página

Endpoint

POST /api/v1/user/address-parser

Exemplo de solicitação

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

Resposta

{}

Rastreia os e-mails enviados no nosso banco de dados central.

Rastreia os e-mails enviados às várias partes do nosso site _(por exemplo, APIs internas, Mailchimp, Hubspot etc.)_ e/ou a APIs de terceiros na nossa tabela central do DynamoDB, permitindo análises e segmentação mais detalhadas dos membros do ecossistema do Example Club.

Corpo da solicitação

Corpo da página

Endpoint

POST /api/v1/analytics/track-email

Exemplo de solicitação

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

Resposta

{}

Envia dados ao Graylog

Envia dados de vários serviços de front-end ao nosso sistema interno de gerenciamento de logs (Graylog).

Corpo da solicitação

Corpo da página

Endpoint

POST /api/v1/analytics/beacon

Exemplo de solicitação

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

Resposta

{}

Verifica se um ID de cinta Myzone está registrado em uma instalação

Retorna uma resposta true ou false indicando se um ID de cinta Myzone está associado ao ID da instalação informado.

Parâmetros

club `string` (opcional) O ID da instalação a consultar beltid `string` (opcional) O ID da cinta Myzone a pesquisar

Endpoint

GET /api/v1/myzone/belt-registered

Exemplo de solicitação

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

Resposta

{}

Obter a frequência de registros de entrada

Obter uma lista dos registros de entrada dos membros durante um determinado período

Parâmetros

start_date `string` (opcional) A data de início do período usada para filtrar as visitas dos membros end_date `string` (opcional) A data de término do período usada para filtrar as visitas dos membros club `string` (opcional) A instalação específica na qual o membro está inscrito, para filtrar em qual instalação o membro registrou a entrada email `string` (opcional) O e-mail específico usado no registro de entrada

Endpoint

GET /api/v1/members/swipes/frequency

Exemplo de solicitação

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

Resposta

{}

Webhook para eventos de check-in do GymMaster

Webhook para eventos de check-in do GymMaster

Endpoint

POST /api/v1/webhooks/gymmaster/checkin

Exemplo de solicitação

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

Resposta

{}

Registrar/enviar o ID do dispositivo

Armazena no banco de dados o UUID, o IP e o Screen ID (ID do dispositivo) de um computador das Display Screens, permitindo a associação do dispositivo pelo Performance Hub.

Corpo da solicitação

Deve ser enviado a este endpoint um objeto JSON com informações sobre o dispositivo, como o IP e o UUID

Endpoint

POST /api/v1/devices/dashkiosk/register

Exemplo de solicitação

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

Resposta

{}

Define o estado de um botão de pânico

Define como `true|false` o estado de um botão de pânico associado a uma instalação. Observação: só é possível alterar o estado de um botão registrado em uma instalação. Isso não funciona para dispositivos que ainda não foram configurados.

Corpo da solicitação

Objeto JSON do estado de alarme do botão de pânico

Endpoint

POST /api/v1/devices/duress/setAlarmState

Exemplo de solicitação

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

Resposta

{}

Retorna os botões de pânico associados à instalação

Retorna uma matriz dos botões de pânico associados a uma instalação, para verificar se há atualizações..

Parâmetros

clubID `string` (obrigatório) ID da instalação a consultar

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Atualiza os metadados do dispositivo

Atualiza os metadados do dispositivo para um UUID. Observação: nenhuma autenticação é necessária para enviar dados a esta função, portanto os dados não devem conter informações confidenciais.

Corpo da solicitação

Deve ser enviado a este endpoint um objeto JSON com informações sobre o dispositivo, como informações do sistema operacional, métricas de Wi-Fi etc...

Endpoint

POST /api/v1/devices/metadata/beacon

Exemplo de solicitação

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

Resposta

{}

Retorna informações sobre uma tela com base no UUID do dispositivo.

Obtém a configuração de um dispositivo com base no UUID dele e retorna informações como qual rodada está associada ao dispositivo e qual conteúdo deve ser exibido.

Parâmetros

uuid `string` (obrigatório) UUID do dispositivo cuja configuração está sendo obtida

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Retorna as informações de configuração de um dispositivo com base no UUID.

Obtém a configuração de um dispositivo em várias tabelas (Display Screens, dispositivos IoT, dispositivos de CFTV) usando o UUID do dispositivo e retorna os detalhes de configuração relevantes em JSON.

Parâmetros

uuid `string` (obrigatório) UUID do dispositivo cuja configuração será obtida

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Registrar um dispositivo BLE Beacon

Salva as informações do dispositivo BLE Beacon no nosso banco de dados

Corpo da solicitação

Dados do dispositivo BLE Beacon

Endpoint

POST /api/v1/devices/blebeacon/register

Exemplo de solicitação

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

Resposta

{}

Lista os dispositivos de CFTV associados ao ClubID

Lista os detalhes gerais dos dispositivos de CFTV associados a um ClubID. Observação: esta API retorna apenas informações genéricas/gerais, como os endereços IP locais dos dispositivos e se estão on-line|off-line. Para detalhes avançados dos dispositivos, use a API do Performance Hub.

Parâmetros

clubID `string` (obrigatório) ID da instalação a consultar

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Registrar um dispositivo de CFTV

Salva as informações do dispositivo de CFTV no nosso banco de dados

Corpo da solicitação

Dados do dispositivo de CFTV

Endpoint

POST /api/v1/devices/cctv/register

Exemplo de solicitação

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

Resposta

{}

Registrar um dispositivo AI Edge Processor

Salva as informações do dispositivo AI Edge Processor no nosso banco de dados

Corpo da solicitação

Dados do dispositivo AI Edge Processor

Endpoint

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

Exemplo de solicitação

curl -X POST https://uapi.gymsystems.co//api/v1/devices/ai-edge-processor/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Resposta

{}

Gera uma URL assinada para aceitar uploads de gravações de CFTV

Gera uma URL assinada do S3 para permitir que o cliente envie uma gravação de CFTV diretamente ao S3 para pós-processamento.

Corpo da solicitação

Metadados do dispositivo

Endpoint

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

Exemplo de solicitação

curl -X POST https://uapi.gymsystems.co//api/v1/devices/cctv/generate-upload-token \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Resposta

{}

Informa ao S3 que o upload multipart foi concluído

Informa ao S3 que o upload multipart foi concluído pelo cliente

Corpo da solicitação

Metadados do dispositivo

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Enviar um comando Sonos aos dispositivos Sonos da instalação

Enviar um comando Sonos aos dispositivos Sonos da instalação

Parâmetros

clubID `string` (obrigatório) ID da instalação a consultar

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Obter as configurações de Controle de áudio da instalação

Obter as configurações de Controle de áudio da instalação

Parâmetros

clubID `string` (obrigatório) ID da instalação a consultar

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Criar um token de acesso temporário

Criar um token de acesso temporário

Endpoint

POST /api/v1/temporary-access/token

Exemplo de solicitação

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

Resposta

{}

Obter os itens de transmissão de música ao vivo

Obter os itens de transmissão de música ao vivo

Endpoint

GET /api/v1/streams

Exemplo de solicitação

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

Resposta

{}

Obter os dados de um item de transmissão de música ao vivo

Obter os dados de um item de transmissão de música ao vivo

Parâmetros

id `string` (obrigatório) ID exclusivo que identifica um item de stream

Endpoint

GET /api/v1/streams/{id}

Exemplo de solicitação

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

Resposta

{}

Obter os itens de perguntas frequentes

Obter os itens de perguntas frequentes

Parâmetros

location `string` (opcional) O local em que você quer que o item de perguntas frequentes apareça, por exemplo, site principal (website_main). categories `string` (opcional) Categorias do item de perguntas frequentes. status `string` (opcional) O status do item

Endpoint

GET /api/v1/faqs

Exemplo de solicitação

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

Resposta

{}

Obter os itens de perguntas frequentes

Obter os itens de perguntas frequentes

Parâmetros

category `string` (obrigatório) Filtro de categorias

Endpoint

GET /api/v1/faqs/{category}

Exemplo de solicitação

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

Resposta

{}

Obter os itens de imprensa

Obter os itens de imprensa

Parâmetros

location `string` (opcional) O local em que você quer que o item de imprensa apareça, por exemplo, site principal (website_main). status `string` (opcional) O status do item

Endpoint

GET /api/v1/press

Exemplo de solicitação

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

Resposta

{}

Obter o mapeamento de e-mails

Obter o mapeamento de e-mails

Endpoint

GET /api/v1/email-mapping

Exemplo de solicitação

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

Resposta

{}

Obter os códigos de rastreamento personalizados

Obter os códigos de rastreamento personalizados

Parâmetros

clubID `string` (obrigatório) O ID ou a localização da instalação, por exemplo, Milton

Endpoint

GET /api/v1/customtracking/{clubID}

Exemplo de solicitação

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

Resposta

{}

Obter os itens das páginas de destino

Obter os itens das páginas de destino

Parâmetros

region `string` (opcional) A região à qual uma instalação pertence, por exemplo, AU, NZ, US club `string` (opcional) ID da instalação, identificador exclusivo da instalação slug `string` (opcional) A última parte do endereço URL, que serve como identificador exclusivo da página

Endpoint

GET /api/v1/landing-pages

Exemplo de solicitação

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

Resposta

{}

Formulário de contato do site do Performance Hub

Recebe os envios de formulários do site do Performance Hub (solicitações de demonstração, consultas de vendas, pedidos de acesso antecipado) e envia e-mails de notificação via SES.

Endpoint

POST /api/v1/performancehub/website-contact

Exemplo de solicitação

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

Resposta

{}

Solicitar um OTP do Door & Gate Access

Envia um código de verificação de uso único para o telefone ou e-mail informado. Sempre responde 200 para impedir a enumeração de identificadores. Com limite de taxa por identificador e por IP (janela deslizante no Redis).

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Verificar um OTP do Door & Gate Access e emitir tokens

Verifica o OTP, resolve os perfis de pessoa vinculados em todas as instalações e retorna um JWT de curta duração + um token de atualização opaco e rotativo.

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Trocar um token de atualização do Door & Gate Access

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Revogar um token de atualização do Door & Gate Access

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Sessão atual do Door & Gate Access

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Atualizar os campos editáveis do perfil

Atualiza firstName / lastName em todas as linhas de ph-door-access-users que correspondem ao identificador do JWT. O e-mail e o telefone não podem ser alterados aqui.

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Listar as instalações do usuário do Door & Gate Access

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Definir a instalação selecionada no momento pelo usuário

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Listar as portas que o usuário pode abrir em uma instalação

Parâmetros

facilityId `string` (opcional) Identificador da instalação (clubID).

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Tentativas recentes de destravamento do usuário atual

Endpoint

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

Exemplo de solicitação

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

Resposta

{}

Destravar uma porta pelo aplicativo móvel Door & Gate Access

Verificações rigorosas no servidor antes de publicar no MQTT. O servidor é a fonte oficial para regras permanentes, Access Time Windows adicionais, bloqueios explícitos de portas, modo de manutenção e geofence. O estado do cliente serve apenas para a experiência do usuário.

Parâmetros

doorId `string` (obrigatório) balenaUUID do controlador de porta.

Endpoint

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

Exemplo de solicitação

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

Resposta

{}