Introducción

Esta es la API principal que se usa para los sitios y sistemas públicos. **Si eres un desarrollador externo y quieres usar esta API, comunícate con el soporte de Performance Hub para que agreguen tus IP a la lista de permitidos; de lo contrario, se limitará la frecuencia de tus solicitudes o se bloquearán si hay demasiadas desde el mismo referente o IP.**

URL base

https://uapi.gymsystems.co/

Autenticación

La Universal API usa autenticación con clave de API mediante encabezados HTTP.

Incluye tu clave de API en el encabezado X-API-Key en cada solicitud.

Maneja tus claves de API con cuidado: ¡otorgan acceso completo a tu cuenta! Nunca expongas estas claves en repositorios públicos, aplicaciones del lado del cliente ni en ningún lugar donde puedan verse comprometidas.

La API solo acepta conexiones HTTPS seguras. Las solicitudes HTTP sin cifrar se rechazan, al igual que cualquier solicitud que no incluya las credenciales de autenticación correspondientes.

Solicitud de ejemplo

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

Formulario de contacto general

La API que se usa para los mensajes de 'contacto general' de los sitios web de Example Club y de otros servicios externos (como el campamento de entrenamiento, etc.).

Parámetros

organisationId `string` (opcional) El ID de la organización cuyos datos de instalaciones quieres obtener. Se usa para garantizar que solo se devuelvan instalaciones de la misma organización. leadForwarding `string` (opcional) ¿Se deben reenviar los correos electrónicos a algún sistema de gestión de prospectos (gymsales, gymleads, etc.)? Ten en cuenta que, con `onlyForwardIfConfigured`, los prospectos se reenvían a cualquier CRM, pero no al correo electrónico principal de la instalación...

Cuerpo de la solicitud

Cuerpo del contacto general

Endpoint

POST /api/v1/support/contact-submission

Solicitud de ejemplo

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

Respuesta

{}

Prueba gratuita

Genera una solicitud de página de destino de 'prueba gratuita' para la instalación especificada

Cuerpo de la solicitud

Cuerpo de la prueba gratuita

Endpoint

POST /api/v1/leads/free-trial

Solicitud de ejemplo

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

Respuesta

{}

Reservar un entrenamiento

La API que se usa para el formulario 'reservar un entrenamiento' de los sitios web de Example Club.

Cuerpo de la solicitud

Cuerpo de la reserva de entrenamiento

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Envíos de prospectos de Training Camp

Registra los envíos de nuestros sitios web principales con los que el usuario indica su interés en Training Camp. Esta información se usa después para remitir al usuario a la aplicación o el sitio de trainingcamp.com y para que las instalaciones inscriban al miembro en el campamento de entrenamiento.

Cuerpo de la solicitud

Cuerpo de la página

Endpoint

POST /api/v1/leads/training-camp

Solicitud de ejemplo

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

Respuesta

{}

Obtiene los metadatos de una instalación o de todas las instalaciones

Esta API devuelve los metadatos que se usan para mostrar la página de una instalación individual, o los de todas las instalaciones de la base de datos.

Parámetros

organisationId `string` (opcional) El ID de la organización cuyos datos de instalaciones quieres obtener. Se usa para garantizar que solo se devuelvan instalaciones de la misma organización. club `string` (opcional) El ID de la instalación que quieres obtener... *NB* Puedes omitirlo si quieres devolver TODAS las instalaciones como un solo objeto JSON.

Endpoint

GET /api/v1/club/data

Solicitud de ejemplo

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

Respuesta

{}

Obtiene los metadatos de una instalación o de todas las instalaciones

Esta API devuelve los metadatos que se usan para mostrar la página de una instalación individual, o los de todas las instalaciones de la base de datos.

Parámetros

organisationId `string` (opcional) El ID de la organización cuyos datos de instalaciones quieres obtener. Se usa para garantizar que solo se devuelvan instalaciones de la misma organización. club `string` (opcional) El ID de la instalación que quieres obtener... *NB* Puedes omitirlo si quieres devolver TODAS las instalaciones como un solo objeto JSON.

Endpoint

GET /api/v2/club/data

Solicitud de ejemplo

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

Respuesta

{}

Buscar instalaciones por ciudad y latitud/longitud

Realiza una búsqueda de instalaciones cercanas según tu latitud, longitud y términos de búsqueda (como un barrio, pueblo o ciudad)

Parámetros

geogroup `string` (opcional) Devuelve una lista 'agrupada' de las ciudades, estados y países en los que hay instalaciones search `string` (opcional) El término que se buscará. Por lo general será un pueblo, una ciudad, un barrio o un código postal limit `string` (opcional) Número máximo de resultados origin `string` (opcional) La latitud y la longitud desde las que se realiza la búsqueda. Es fundamental al buscar pueblos o barrios con el mismo nombre, pero en distintos países o ciudades donde tenemos varias instalaciones, p. ej., `Southbank Example City` o `Southbank Example City 2` organisationId `string` (opcional) El ID de la organización por el que se filtrarán las instalaciones. Se usa para garantizar que solo se devuelvan instalaciones de la misma organización.

Endpoint

GET /api/v1/club/geosearch

Solicitud de ejemplo

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

Respuesta

{}

Lista las reseñas fijadas de una instalación

Esta API devuelve las reseñas fijadas de la instalación.

Parámetros

club `string` (opcional) El ID de la instalación que quieres obtener

Endpoint

GET /api/v2/club/reviews

Solicitud de ejemplo

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

Respuesta

{}

Obtener la configuración de una aplicación establecida en la instalación indicada

Obtener la configuración de una aplicación establecida en la instalación indicada

Parámetros

clubID `string` (opcional) El ID de la instalación que quieres obtener appID `string` (opcional) El ID de la aplicación que quieres obtener

Endpoint

GET /api/v1/club/apps/config

Solicitud de ejemplo

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

Respuesta

{}

Latitud y longitud según la IP del usuario

Devuelve la latitud y la longitud estimadas de la IP de un usuario según la base de datos GeoIP de Maxmind.

Endpoint

GET /api/v1/geo/ip

Solicitud de ejemplo

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

Respuesta

{}

Analiza una cadena de dirección y la devuelve como un objeto.

Convierte la cadena de dirección en un objeto compuesto por calle, ciudad, estado y código postal.

Cuerpo de la solicitud

Cuerpo de la página

Endpoint

POST /api/v1/user/address-parser

Solicitud de ejemplo

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

Respuesta

{}

Registra en nuestra base de datos central los correos electrónicos enviados.

Registra en nuestra tabla central de DynamoDB los correos electrónicos enviados a las distintas partes de nuestro sitio web _(p. ej., API internas, Mailchimp, Hubspot, etc.)_ o a API de terceros, lo que nos permite realizar análisis y segmentaciones más detallados de los miembros del ecosistema de Example Club.

Cuerpo de la solicitud

Cuerpo de la página

Endpoint

POST /api/v1/analytics/track-email

Solicitud de ejemplo

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

Respuesta

{}

Envía datos a Graylog

Envía datos de varios servicios de front-end a nuestro sistema interno de gestión de registros (Graylog).

Cuerpo de la solicitud

Cuerpo de la página

Endpoint

POST /api/v1/analytics/beacon

Solicitud de ejemplo

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

Respuesta

{}

Comprueba si un ID de cinturón Myzone está registrado en una instalación

Devuelve true o false según si un ID de cinturón Myzone está asociado al ID de la instalación indicado.

Parámetros

club `string` (opcional) El ID de la instalación que se consultará beltid `string` (opcional) El ID del cinturón Myzone que se buscará

Endpoint

GET /api/v1/myzone/belt-registered

Solicitud de ejemplo

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

Respuesta

{}

Obtener la frecuencia de registros de visitas

Obtener la lista de registros de visitas de los miembros durante un período determinado

Parámetros

start_date `string` (opcional) La fecha de inicio del período que se usa para filtrar las visitas de los miembros end_date `string` (opcional) La fecha de fin del período que se usa para filtrar las visitas de los miembros club `string` (opcional) La instalación específica en la que el miembro tiene la suscripción, para filtrar en qué instalación registró su entrada email `string` (opcional) El correo electrónico específico que se usó en el registro de visita

Endpoint

GET /api/v1/members/swipes/frequency

Solicitud de ejemplo

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

Respuesta

{}

Webhook para los eventos de registro de entrada de GymMaster

Webhook para los eventos de registro de entrada de GymMaster

Endpoint

POST /api/v1/webhooks/gymmaster/checkin

Solicitud de ejemplo

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

Respuesta

{}

Registrar o enviar el ID del dispositivo

Guarda en la base de datos el UUID, la IP y el ID de pantalla (ID del dispositivo) de una computadora de Display Screens, lo que permite asociar el dispositivo mediante Performance Hub.

Cuerpo de la solicitud

Se debe enviar a este endpoint un objeto JSON con información sobre el dispositivo, como su IP y su UUID

Endpoint

POST /api/v1/devices/dashkiosk/register

Solicitud de ejemplo

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

Respuesta

{}

Establece el estado de un botón de pánico

Establece en `true|false` el estado de un botón de pánico asociado a una instalación. Ten en cuenta que solo puedes cambiar el estado de un botón registrado en una instalación. No funciona con dispositivos que aún no están configurados.

Cuerpo de la solicitud

Objeto JSON del estado de alarma del botón de pánico

Endpoint

POST /api/v1/devices/duress/setAlarmState

Solicitud de ejemplo

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

Respuesta

{}

Devuelve los botones de pánico asociados a la instalación

Devuelve un array de botones de pánico asociados a una instalación para buscar actualizaciones en ellos.

Parámetros

clubID `string` (obligatorio) ID de la instalación que se consultará

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Actualiza los metadatos del dispositivo

Actualiza los metadatos del dispositivo de un UUID. Ten en cuenta que no se requiere autenticación para enviar datos a esta función, por lo que los datos no deben contener información confidencial.

Cuerpo de la solicitud

Se debe enviar a este endpoint un objeto JSON con información sobre el dispositivo, como la información del sistema operativo, las métricas de Wi-Fi, etc...

Endpoint

POST /api/v1/devices/metadata/beacon

Solicitud de ejemplo

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

Respuesta

{}

Devuelve información sobre una pantalla según el UUID del dispositivo.

Obtiene la configuración de un dispositivo según su UUID y devuelve información como la ronda asociada al dispositivo y el contenido que debe mostrarse.

Parámetros

uuid `string` (obligatorio) UUID del dispositivo cuya configuración se obtiene

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Devuelve la información de configuración de un dispositivo según su UUID.

Obtiene la configuración de un dispositivo desde varias tablas (Display Screens, dispositivos IoT, dispositivos CCTV) mediante el UUID del dispositivo y devuelve los detalles de configuración pertinentes como JSON.

Parámetros

uuid `string` (obligatorio) UUID del dispositivo cuya configuración se obtendrá

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Registrar un dispositivo de baliza BLE

Guarda en nuestra base de datos la información del dispositivo de baliza BLE

Cuerpo de la solicitud

Datos del dispositivo de baliza BLE

Endpoint

POST /api/v1/devices/blebeacon/register

Solicitud de ejemplo

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

Respuesta

{}

Lista los dispositivos CCTV asociados al ClubID

Lista los detalles generales de los dispositivos CCTV asociados a un ClubID. Ten en cuenta que esta API solo devuelve información genérica o general, como las direcciones IP locales de los dispositivos y si están en línea o desconectados. Para obtener detalles avanzados de los dispositivos, se debe usar la API de Performance Hub.

Parámetros

clubID `string` (obligatorio) ID de la instalación que se consultará

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Registrar un dispositivo CCTV

Guarda en nuestra base de datos la información del dispositivo CCTV

Cuerpo de la solicitud

Datos del dispositivo CCTV

Endpoint

POST /api/v1/devices/cctv/register

Solicitud de ejemplo

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

Respuesta

{}

Registrar un dispositivo AI Edge Processor

Guarda en nuestra base de datos la información del dispositivo AI Edge Processor

Cuerpo de la solicitud

Datos del dispositivo AI Edge Processor

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Genera una URL firmada para aceptar cargas de grabaciones de CCTV

Genera una URL firmada de S3 que permite al cliente cargar directamente una grabación de CCTV en S3 para su procesamiento posterior.

Cuerpo de la solicitud

Metadatos del dispositivo

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Indica a S3 que se completó la carga en varias partes

Indica a S3 que el cliente completó la carga en varias partes

Cuerpo de la solicitud

Metadatos del dispositivo

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Enviar un comando de Sonos a los dispositivos Sonos de la instalación

Enviar un comando de Sonos a los dispositivos Sonos de la instalación

Parámetros

clubID `string` (obligatorio) ID de la instalación que se consultará

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Obtener la configuración de control de audio de la instalación

Obtener la configuración de control de audio de la instalación

Parámetros

clubID `string` (obligatorio) ID de la instalación que se consultará

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Crear un token de acceso temporal

Crear un token de acceso temporal

Endpoint

POST /api/v1/temporary-access/token

Solicitud de ejemplo

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

Respuesta

{}

Obtener los elementos de transmisión de música en vivo

Obtener los elementos de transmisión de música en vivo

Endpoint

GET /api/v1/streams

Solicitud de ejemplo

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

Respuesta

{}

Obtener los datos de un elemento de transmisión de música en vivo

Obtener los datos de un elemento de transmisión de música en vivo

Parámetros

id `string` (obligatorio) ID único que identifica un elemento de transmisión

Endpoint

GET /api/v1/streams/{id}

Solicitud de ejemplo

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

Respuesta

{}

Obtener los elementos de preguntas frecuentes

Obtener los elementos de preguntas frecuentes

Parámetros

location `string` (opcional) La ubicación en la que quieres que aparezca el elemento de preguntas frecuentes, p. ej., el sitio web principal (website_main). categories `string` (opcional) Categorías del elemento de preguntas frecuentes. status `string` (opcional) El estado del elemento

Endpoint

GET /api/v1/faqs

Solicitud de ejemplo

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

Respuesta

{}

Obtener los elementos de preguntas frecuentes

Obtener los elementos de preguntas frecuentes

Parámetros

category `string` (obligatorio) Filtro de categorías

Endpoint

GET /api/v1/faqs/{category}

Solicitud de ejemplo

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

Respuesta

{}

Obtener los elementos de prensa

Obtener los elementos de prensa

Parámetros

location `string` (opcional) La ubicación en la que quieres que aparezca el elemento de prensa, p. ej., el sitio web principal (website_main). status `string` (opcional) El estado del elemento

Endpoint

GET /api/v1/press

Solicitud de ejemplo

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

Respuesta

{}

Obtener la asignación de correos electrónicos

Obtener la asignación de correos electrónicos

Endpoint

GET /api/v1/email-mapping

Solicitud de ejemplo

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

Respuesta

{}

Obtener los códigos de seguimiento personalizados

Obtener los códigos de seguimiento personalizados

Parámetros

clubID `string` (obligatorio) El ID o la ubicación de la instalación, p. ej., Milton

Endpoint

GET /api/v1/customtracking/{clubID}

Solicitud de ejemplo

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

Respuesta

{}

Obtener los elementos de las páginas de destino

Obtener los elementos de las páginas de destino

Parámetros

region `string` (opcional) La región a la que pertenece una instalación, p. ej., AU, NZ, US club `string` (opcional) ID de la instalación, identificador único de la instalación slug `string` (opcional) La última parte de la dirección URL, que sirve como identificador único de la página

Endpoint

GET /api/v1/landing-pages

Solicitud de ejemplo

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

Respuesta

{}

Formulario de contacto del sitio web de Performance Hub

Recibe los envíos de formularios del sitio web de Performance Hub (solicitudes de demostración, consultas de ventas, pedidos de acceso anticipado) y envía correos electrónicos de notificación mediante SES.

Endpoint

POST /api/v1/performancehub/website-contact

Solicitud de ejemplo

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

Respuesta

{}

Solicitar un OTP de Door & Gate Access

Envía un código de verificación de un solo uso al teléfono o correo electrónico proporcionado. Siempre responde 200 para evitar la enumeración de identificadores. Tiene un límite de frecuencia por identificador y por IP (ventana deslizante en Redis).

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Verificar un OTP de Door & Gate Access y emitir tokens

Verifica el OTP, resuelve los perfiles de persona vinculados en todas las instalaciones y devuelve un JWT de corta duración + un token de actualización opaco y rotativo.

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Rotar un token de actualización de Door & Gate Access

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Revocar un token de actualización de Door & Gate Access

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Sesión actual de Door & Gate Access

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Actualizar los campos editables del perfil

Actualiza firstName / lastName en cada fila de ph-door-access-users que coincide con el identificador del JWT. El correo electrónico y el teléfono no se pueden cambiar aquí.

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Listar las instalaciones del usuario de Door & Gate Access

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Establecer la instalación seleccionada actualmente por el usuario

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Listar las puertas que el usuario puede abrir en una instalación

Parámetros

facilityId `string` (opcional) Identificador de la instalación (clubID).

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Intentos de desbloqueo recientes del usuario actual

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}

Desbloquear una puerta desde la aplicación móvil de Door & Gate Access

Comprobaciones estrictas en el servidor antes de publicar en MQTT. El servidor es la fuente de verdad de las reglas permanentes, las Access Time Windows adicionales, los bloqueos explícitos de puertas, el modo de mantenimiento y la geovalla. El estado del cliente solo afecta a la experiencia de usuario.

Parámetros

doorId `string` (obligatorio) balenaUUID del controlador de puerta.

Endpoint

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

Solicitud de ejemplo

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

Respuesta

{}