Visão geral
A API Hotspot fornece a lista de hóspedes no hotel ao sistema de hotspot (captive portal). Para cada hóspede que fez check-in e ainda não fez check-out, o HMS retorna o número do quarto, o nome, o número do documento, a data de nascimento e os horários de check-in/check-out. O software de hotspot usa essa lista para validar o login do hóspede no Wi-Fi pelo número do quarto e pelo sobrenome, encerrar o acesso quando a estadia termina e associar a uma identidade os registros de acesso que mantém por exigência da Lei turca nº 5651.
URL base#
O endpoint fica sob a URL base abaixo, no caminho /public/json/…. Somente HTTPS é aceito.
https://test.hms.gen.trResumo do fluxo#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueA chave é gerada uma única vez no painel administrativo do HMS do hotel e enviada no cabeçalho ApiKey em todas as requisições. O endpoint de lista retorna todos os hóspedes no hotel em uma única chamada; o software de hotspot compara o número do quarto e o sobrenome que o hóspede digita no portal com essa lista, libera a conta até a data prevista de check-out e atualiza a lista em intervalos regulares para encerrar as contas dos hóspedes que já saíram. Os detalhes estão no guia Fluxo de verificação de hóspedes.
Recursos#
| Recurso | Endpoints |
|---|---|
| Hóspedes no hotel | POST /public/json/customer/inhotel |
Regras gerais#
- Todas as requisições levam o cabeçalho
ApiKey. Não há etapa de login nem token. - O endpoint é chamado com
POST; não há corpo, query string nem parâmetro de filtro. - As respostas são JSON e o campo
successé o número1ou0. Uma falha de autenticação retorna HTTP401com{"success": 0}. - Os horários são timestamps Unix (segundos). A data de nascimento é uma string
DD.MM.YYYY. - A lista abrange o hotel inteiro; não há filtro por quarto nem por data. Faça a correspondência do seu lado e guarde a lista em cache.
- A resposta contém dados pessoais (número do documento, data de nascimento). Armazene apenas os campos de que precisa e envie a requisição a partir do seu próprio servidor, nunca do dispositivo do hóspede.
Versionamento#
Este endpoint pertence ao grupo de APIs personalizadas do HMS e não tem número de versão. Novos campos podem ser adicionados sem aviso prévio; escreva seu cliente de forma que ignore campos desconhecidos. A remoção de um campo existente ou a mudança do seu significado é anunciada com antecedência nas notas de versão.