TOTVS Hospitalidade

Árvore de páginas

  • Visão Geral
    Caro Parceiro, Este documento visa esclarecer todos os procedimentos de como consumir via REST os recursos da API PMS VHF através de métodos HTTP. Todos os
    métodos HTTP que disponibilizam os recursos necessários para a integração são detalhados a seguir.

  • Autenticação

    Para ter acesso a API PMS, é necessário possuir um Token Client, Token Application e desbloqueados, que são recebidos após a contratação do nosso serviço.
    O HotelCode deve ser o código do hotel na base do cliente.
    Os três parâmetros devem ser inseridos no Header com os seus respectivos valores. Em todas as requisições a utilização dos campos mencionados acima é obrigatória.

Exemplo:

  • Request


Para a parte de request o endereço do servidor mencionado como “localhost”, pode mudar conforme configuração feita no cliente, o mesmo pode ter a porta definida depois
do nome “localhost:85”.

  • Métodos

    • Método PooList

Método POST de UHPOOL. Interface responsável para incluir ou retirar uma UH do Pool
no PMS ( VHF ).

Request

http://localhost:85/hotalapi/frontoffice/Hotel/poolist

Exemplo de requisição:

Body
{
"PoolList": [{
    "LocatorId": "1212",
    "HotelCode": "1",
    "RoomTypeCode": "STDB",
    "RoomNumber": "511",
    "Stardate": "2017-12-18T00:00:00",
    "Enddate": "2017-12-18T00:00:00",
    "Status": 1
   }
 ]
}


Return Success
Código HTTP: 200

Resposta
{
 "Message":"Processed",
 "Warnings": [ ]
}


Error Example
Código HTTP: 400

Resposta
{
          "Message": "Failed",
          "Warnings":
           [{
             "Code": 001,
             "LocatorID": "ABC",
             "Message": "Não foi informado o identicicador do hotel no PMS."
             }
            ]
}


Method Errors

Parameters


  • Método AvailableRoom
    • Método GET de AVAILABLEROOM. Interface responsável para verificar se a UH encontra-se disponível para o período.

Request

http://localhost:85/hotalapi/frontoffice/Hotel/availableroom/{RoomNumber}/{DataCheckin}/{DataCheckout}

Return Success
Código HTTP: 200

Resposta
{
   "Message":"Available",
   "Warnings": [ ]
}


Error Example
Código HTTP: 400

Resposta
{
     "Message": "Failed",
     "Warnings":
     [{
       "Code": 001,
       "LocatorID": "ABC",
       "Message": "O código da UH não foi localizado no PMS."
       }
      ]
}

Method Errors

CódigoMensagem de erro
001O Código da UH não foi localizado no PMS.
002O código da UH informado, não esta disponível. {motivo}




Request

Para a parte de request o endereço do servidor mencionado como “localhost”, pode mudar conforme configuração feita no cliente, o mesmo pode ter a porta definida depois
do nome “localhost:85”.



3. Request

Para a parte de request o endereço do servidor mencionado como “localhost”, pode
mudar conforme configuração feita no cliente, o mesmo pode ter a porta definida depois
do nome “localhost:85”.


  • Sem rótulos