La API de Validación de Check-in fue diseñada para ser simple y directa. El objetivo principal es permitir que tu sistema de gestión (ERP) reciba la solicitud de ingreso del usuario y valide el acceso directamente en tu torniquete o sistema propio.
Conoce a continuación el flujo completo de funcionamiento:
1. Autenticación y Generación de Token
El primer paso para tu ERP es autenticar la sucursal de tu cliente en tu sistema.
Realiza la petición a través del endpoint de autenticación para que TotalPass reconozca la vinculación.
La respuesta de este endpoint devolverá los planes activos de la sucursal en TotalPass y un token de acceso.
Este token debe usarse para utilizar todos los endpoints relacionados con los webhooks.
⚠️ Atención a la validez del Token: Expira cada 24 horas. Solo necesitas generar un nuevo token si vas a realizar alguna modificación o consulta en la dirección de recepción de los webhooks.
2. Registro y Gestión de Webhooks
Para que TotalPass sepa a dónde enviar la información cuando un usuario haga check-in, necesitarás registrar una URL de recepción (webhook) en esa sucursal.
Realiza el registro a través del endpoint de creación de webhook.
Consejo de Arquitectura: Puedes usar la misma dirección de webhook para todas las sucursales vinculadas a tu ERP. Sin embargo, es fundamental que exista un tratamiento a nivel de código en tu sistema para identificar las sucursales a través de sus credenciales.
Para la gestión de estas URLs, disponemos de endpoints específicos de:
3. El Flujo de Recepción y Validación del Check-in
Con la sucursal autenticada y el webhook registrado, el flujo de acceso pasa a funcionar de la siguiente manera:
Siempre que un usuario de TotalPass realice el check-in en la aplicación, nosotros enviaremos un webhook a tu URL con toda la información de ese acceso y un enlace exclusivo para la validación.
Para liberar el ingreso (validar el check-in), tu sistema necesita hacer una petición de tipo
POSTen el enlace enviado dentro de la variable"endpoint"del payload del webhook.
⌛️ Tiempo Límite de Validación: Todos los check-ins tienen 90 minutos para ser validados a través del
POST. Pasado este tiempo límite, el check-in será considerado expirado por TotalPass.
4. Errores Comunes y Hardware de Terceros
Como ERP, puedes utilizar el flujo de validación de nuestra API para activar integraciones con torniquetes, sistemas de reconocimiento facial o biometría de la sucursal. Importante: TotalPass se responsabiliza y asiste exclusivamente en la integración con nuestras APIs, por lo que no ofrecemos soporte para integraciones con hardware de terceros.
Entendiendo el Error HTTP 422: Nuestra integración no bloquea el uso del Portal de Academias y Aliados por parte del cliente. El cliente siempre podrá validar el check-in manualmente desde nuestra plataforma.
En caso de que recepción valide el check-in manualmente antes que tu sistema, tu intento de validación vía API devolverá el error 422 - Check-in no disponible (pues ya ha sido validado).
Recuerda siempre alinear previamente con tu cliente cuál será el flujo operativo oficial (manual o automatizado vía ERP) para evitar este conflicto.
Observaciones Finales sobre las APIs de TotalPass
Acuerdo de Adhesión: Para obtener el acuerdo e iniciar la integración, envía el Nombre de tu ERP, RFC y el nombre de tu representante legal al correo tp.integraciones@totalpass.com.mx
Credenciales de Acceso: Las claves de acceso (
partner_api_keyyplace_api_key) son exactamente las mismas tanto para la API de Check-in como para la API de Booking. Sin embargo, los endpoints son diferentes.Confidencialidad: Tu
partner_api_keyes proporcionada por TotalPass, es estrictamente confidencial y nunca debe ser solicitada a tus clientes.Clave del Cliente: La
place_api_keyes generada y proporcionada por el propio cliente, y se obtiene directamente en el Portal de Academias y Aliados de TotalPass en la pestaña "Integraciones".