Visão geral
A API Online Booking conecta o motor de reservas do site do próprio hotel ao HMS Software Hoteleiro. Listas de quartos e tarifas, disponibilidade no calendário, validação de cupons, a etapa de pagamento e o envio da reserva para o HMS passam todos por esta API. Ela foi pensada para agências que desenvolvem motores de reservas e para parceiros da HMS.
URL base#
Todos os endpoints ficam sob a URL base abaixo, no caminho /external/…. Somente HTTPS é aceito.
https://test.hms.gen.trO fluxo em resumo#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingO token obtido no login vale por 7 dias e fica vinculado a um único hotel. A lista de quartos retorna os quartos disponíveis para venda e os preços para as datas e a ocupação pesquisadas pelo hóspede; depois que o hóspede faz a escolha e o tipo de pagamento é definido, a reserva é gravada no HMS como um BookingPushRQ. O guia Fluxo de reserva percorre cada etapa.
Recursos#
| Recurso | Endpoints |
|---|---|
| Autenticação | POST /external/public/login |
| Quartos e tarifas | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Reserva | POST /external/online/channel/booking |
| Pagamento | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Cupom | POST /external/online/coupon/search |
| Pacotes e extras | GET /external/stock/packages |
| Informações do hotel | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Tabelas auxiliares | POST /external/countiesGET /external/currenciesGET /external/languages |
Regras gerais#
- Todas as requisições, exceto o login, levam o cabeçalho
Authorization: Bearer <token>. - A maioria dos endpoints
POSTrecebe campos de formulário (application/x-www-form-urlencodedoumultipart/form-data). O envio da reserva e o início do pagamento esperam corpos JSON. A página de referência de cada endpoint indica qual formato usar. - As respostas são JSON com o indicador
success. Erros de regra de negócio também retornam como HTTP200; avalie o resultado porsuccess, e não pelo código de status. - As datas usam o formato
YYYY-MM-DD, os valores são strings com duas casas decimais ("965.00") e a moeda vem das configurações do canal online do hotel. - O parâmetro
hotelIDdeve corresponder ao hotel ao qual o token está vinculado.
Versão#
Esta documentação cobre a API HMS V2. Novos campos e endpoints podem ser adicionados sem aviso prévio; escreva seu cliente de forma que ignore campos desconhecidos. As alterações são listadas nas notas de versão.