Autenticación

La API de Hotspot se autentica con un único encabezado HTTP: ApiKey. No hay un paso de inicio de sesión aparte ni token; la clave se envía en cada solicitud.

Encabezados#

POST /public/json/customer/inhotel HTTP/1.1
Host: test.hms.gen.tr
ApiKey: 017f1daf2d139
HotelCode: 1000
Content-Length: 0

De dónde sale la clave#

La clave se genera en la pestaña Custom API de la página API del panel de administración de HMS del hotel. El campo de descripción sirve para anotar dónde se usa la clave; se pueden generar varias claves. Una clave eliminada en esa misma página deja de ser válida de inmediato.

Autenticación fallida#

Si el encabezado falta o está vacío, o la clave no existe en HMS, la respuesta es HTTP 401 con este cuerpo:

{
    "success": 0
}

No se da ningún detalle del error. Comprueba, en este orden, que el nombre del encabezado sea ApiKey, que el valor sea exactamente la clave copiada del panel y que la clave siga apareciendo en el panel. No reintentes un 401; el resultado no cambiará hasta que corrijas la clave.

Contexto del hotel#

Una clave está vinculada a un hotel; la respuesta solo contiene los huéspedes de ese hotel. Si tu instalación da servicio a varios hoteles, obtén una clave del propio panel de cada hotel y guárdalas por hotel. Enviar un HotelCode distinto no devuelve datos de otro hotel; la clave siempre determina el hotel.

Protección de la clave#

• Guarda la clave en la configuración del servidor de hotspot o en una variable de entorno; nunca la pongas en el HTML del portal cautivo ni en JavaScript del lado del cliente.
• El componente que obtiene la lista debe ejecutarse en el servidor. Los dispositivos de los huéspedes no deben llamar directamente a HMS; la respuesta contiene los datos de identidad de todos los huéspedes.
• Si sospechas que la clave se ha filtrado, elimínala en el panel y genera una nueva. La clave antigua devuelve 401 en cuanto se elimina.