Autenticação

A API Hotspot faz a autenticação com um único cabeçalho HTTP: ApiKey. Não há etapa de login separada nem token; a chave é enviada em todas as requisições.

Cabeçalhos#

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

De onde vem a chave#

A chave é gerada na aba Custom API da página API, no painel administrativo do HMS do hotel. O campo de descrição serve para anotar onde a chave é usada; é possível gerar várias chaves. Uma chave excluída nessa mesma página deixa de valer imediatamente.

Falha de autenticação#

Se o cabeçalho estiver ausente ou vazio, ou se a chave não for encontrada no HMS, a resposta é HTTP 401 com este corpo:

{
    "success": 0
}

Nenhum detalhe do erro é informado. Verifique nesta ordem: o nome do cabeçalho é ApiKey, o valor é exatamente a chave copiada do painel e a chave ainda aparece listada no painel. Não repita a requisição após um 401; o resultado não muda enquanto a chave não for corrigida.

Contexto do hotel#

Cada chave fica vinculada a um único hotel; a resposta contém apenas os hóspedes desse hotel. Em uma instalação que atende vários hotéis, obtenha uma chave no painel de cada hotel e armazene-as por hotel. Enviar um HotelCode diferente não retorna dados de outro hotel; é sempre a chave que define o hotel.

Proteção da chave#

• Mantenha a chave na configuração do servidor de hotspot ou em uma variável de ambiente; nunca a coloque no HTML do captive portal nem em JavaScript do lado do cliente.
• O componente que busca a lista precisa rodar no servidor. Os dispositivos dos hóspedes não devem chamar o HMS diretamente; a resposta contém os dados de identificação de todos os hóspedes.
• Se suspeitar que a chave vazou, exclua-a no painel e gere uma nova. A chave antiga passa a retornar 401 no momento em que é excluída.