Online Booking API
Conecta o motor de reservas do site do hotel ao HMS: lista de quartos e tarifas, disponibilidade no calendário, cupons, pagamento e envio de reservas.
- URL base
https://test.hms.gen.tr- Autenticação
- apiKey / apiSecret → Bearer token
- Formato
- Respostas JSON · corpo da requisição em formulário ou JSON
- Escopo
- 8 recursos · 16 endpoints
Recursos#
Autenticação
1 endpointO acesso à API Online Booking usa credenciais de parceiro emitidas pela HMS. O endpoint de login troca apiKey e apiSecret por um token, que é enviado …
- POST
/external/public/login
Quartos e tarifas
2 endpointsDois endpoints que alimentam os resultados de busca do motor de reservas: a lista de quartos, que retorna os tipos de quarto disponíveis para venda, o…
- POST
/external/online/roomType - GET
/external/room/type/hotel/availability
Reserva
1 endpointO quarto, o regime de alimentação e a tarifa escolhidos pelo hóspede são enviados ao HMS em uma estrutura BookingPushRQ. O mesmo endpoint trata cancel…
- POST
/external/online/channel/booking
Pagamento
3 endpointsLista os tipos de pagamento que o hotel aceita em reservas online e inicia a etapa de pagamento para o tipo selecionado. O que fazer em cada tipo está…
- GET
/external/online/payment/type - GET
/external/payment/company - POST
/external/online/payment/type/{paymentType}
Cupom
1 endpointValida os cupons de desconto online que o hotel cadastrou no painel. Aplique o desconto do seu lado e informe os valores com desconto no envio da rese…
- POST
/external/online/coupon/search
Pacotes e extras
1 endpointExtras que podem ser vendidos junto com uma reserva: pacotes de quarto (vinculados a um tipo de quarto) e pacotes gerais (transfer, jantar, spa). Os p…
- GET
/external/stock/packages
Informações do hotel
4 endpointsDados que preenchem a estrutura das páginas do motor de reservas: contato e localização, links de redes sociais, textos do rodapé (textos legais, sobr…
- GET
/external/hotel/{hotelID}/contact/info - GET
/external/online/social/media - GET
/external/online/footer - +1 mais
Tabelas auxiliares
3 endpointsListas fixas para opções de formulário: países, moedas e idiomas. Raramente mudam e podem ficar em cache por um dia.
- POST
/external/counties - GET
/external/currencies - GET
/external/languages
Documentação#
Primeiros passos
- Visão geralO que a API Online Booking faz, URL base, resumo do fluxo e regras gerais.
- Início rápidoObtenha um token com suas credenciais de parceiro e envie sua primeira consulta de quartos e tarifas.
- AutenticaçãoLogin com apiKey / apiSecret, Bearer token, contexto do hotel e validade do token.
- Requisições e respostasCorpos de formulário e JSON, o envelope success, paginação, formatos de data e valor, códigos de status HTTP.
- Códigos de erroValores de message e errorCode, erros de autenticação e orientações para novas tentativas.