Descripción general
La API de Hotspot proporciona la lista de huéspedes alojados al sistema de hotspot (portal cautivo). Para cada huésped que ha hecho el check-in y todavía no el check-out, HMS devuelve el número de habitación, el nombre, el número de identidad, la fecha de nacimiento y las horas de check-in y check-out. El software de hotspot usa la lista para verificar el acceso de un huésped al Wi-Fi con el número de habitación y el apellido, para cortar el acceso cuando termina la estancia y para vincular a una identidad los registros de acceso que conserva según la Ley turca n.º 5651.
URL base#
El endpoint está bajo la URL base siguiente, en la ruta /public/json/…. Solo se acepta HTTPS.
https://test.hms.gen.trResumen del flujo#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueLa clave se genera una sola vez en el panel de administración de HMS del hotel y se envía en el encabezado ApiKey en cada solicitud. El endpoint de la lista devuelve todos los huéspedes alojados en una sola llamada; el software de hotspot compara con esta lista el número de habitación y el apellido que el huésped escribe en el portal, abre la cuenta hasta la fecha de salida prevista y actualiza la lista a intervalos regulares para cerrar las cuentas de los huéspedes que se han ido. Los detalles están en la guía Flujo de verificación de huéspedes.
Recursos#
| Recurso | Endpoints |
|---|---|
| Huéspedes alojados | POST /public/json/customer/inhotel |
Reglas generales#
- Todas las solicitudes llevan el encabezado
ApiKey. No hay paso de inicio de sesión ni token. - El endpoint se llama con
POST; no hay cuerpo, cadena de consulta ni parámetros de filtro. - Las respuestas son JSON y el campo
successes el número1o0. Un error de autenticación devuelve HTTP401con{"success": 0}. - Las horas son marcas de tiempo Unix (segundos). La fecha de nacimiento es una cadena
DD.MM.YYYY. - La lista abarca todo el hotel; no hay filtro por habitación ni por fecha. Haz la comparación en tu sistema y guarda la lista en caché.
- La respuesta contiene datos personales (número de identidad, fecha de nacimiento). Guarda solo los campos que necesites y envía la solicitud desde tu propio servidor, nunca desde el dispositivo del huésped.
Versiones#
Este endpoint pertenece al grupo de API personalizadas de HMS y no lleva número de versión. Se pueden añadir campos nuevos sin previo aviso; programa tu cliente para que ignore los campos que no conozca. La eliminación de un campo existente o el cambio de su significado se anuncian con antelación en el registro de cambios.