MultiClubes Hotel API

Esta é a documentação dos serviços de comunicação para smartphones da solução MultiClubes. Este manual tem como objetivo ajudar no entendimento e na implementação de uso dos serviços que compõem a API.

Comunicação

A forma de comunicação suportada é SOAP sobre HTTP. Os dados devem estar codificados no formato UTF8.

Glossário

  • Conta de consumo: é o cartão ou pulseira onde são apontados os serviços e produtos adquiridos pelo hóspede.
  • Voucher: valor que é ativado na conta de consumo do hóspede para ser gasto posteriormente somente com determinado produto.
  • TAG NFC: chip NFC armazenado em um cartão ou pulseira que o hóspede utiliza para fazer o consumo.
  • Pagamento: pagamento para quitar ou reduzir um saldo devedor.
  • NFC Legado: NFC com conteúdo gerido por terceiros.

Funcionamento

  • Abertura da conta de consumo do hóspede.
  • Consulta de saldo da conta de consumo do hóspede.
  • Ativação de vouchers na conta de consumo do hóspede.
  • Pagamento de conta de consumo do hóspede.
  • Encerramento de conta de consumo do hóspede.

Como começar

  1. Obtenha o endereço do serviço de homologação.
  2. Abra o endereço do serviço no navegador e obtenha a documentação WSDL.
  3. Realize chamadas em homologação para testes de reconhecimento.
  4. Integre as chamadas com seu software em homologação.
  5. Obtenha o endereço do serviço de produção.
  6. Realize chamadas em produção para testes de finalização.

Notas de versão

1.0.0

15/05/2018

  1. Criada esta documentação para auxiliar no entendimento e implementação.

1.1.0

18/06/2018

  1. Evolução do método de CheckIn para receber o RoomNumber (número do quarto, UH) e HotelEid (identificador do hotel).

1.2.0

05/07/2018

  1. Método GetMovements para consulta do extrato de consumo do hóspede.

1.3.0

30/07/2018

  1. Foi modificada os métodos CheckIn, CheckOut e ChangeNfc para permitir o rastreio de todas as operações realizadas com NFC.

1.4.0

04/07/2019

Foi modificada a API para que tenha as informações de saldo em abertos das contas

  1. Adicionado o método GetOpenConsumption para retornar o consumo em aberto da conta do hóspede.
  2. Alterado o método Pay com adição do parâmetro opcional PayData.CloseOpenConsumption.

1.5.0

02/10/2019

Foi modificada a API para permitir o uso de NFC Legado, permitindo à softwares de terceiros realizar a gravação do conteúdo da TAG NFC.

  1. Alterado o método CheckIn com adição do parâmetro CheckInData.IsLegacyNfc
  2. Alterado o método ChangeNfc para tenha suporte ao NFC Legado.

1.6.0

09/10/2019

Foi modificada a API para que permita a emissão fiscal dos produtos vouchers ativados e expirados na pré-venda do hotel que o hóspede está.

  1. Alterado o método ActivateVoucher com adição do parâmetro opcional ActivateVoucherProductData.ExpiryDateTime

1.7.0

05/06/2020

Foi realizada uma padronização de dados de check-in. Foi realizada a modificação no método CheckIn para que a edição dos dados da reserva quando chamado com mesmo GuestEid já existente.

  1. Alterado o método CheckIn com a adição dos parâmetros:
    • CheckInData.Document
    • CheckInData.DocumentType
    • CheckInData.Reserve
    • CheckInData.ReserveEid

1.8.0

17/11/2020

Foi modificada a API para que o cartão de consumo tenha uma data de validade e após o vencimento, não seja mais utilizado. Foi realizada a modificação no método CheckIn.

  1. Alterado o método CheckIn com a adição do parâmetro:
    • CheckInData.CardValidity

1.9.0-beta

16/04/2021

Inclusão do método CheckInOnity para gravação de chave de quarto pela integração Onity.

1.9.0

01/06/2021

Implementação do método CheckInOnity para gravação de chave de quarto pela integração Onity.

  1. Alterado CheckInOnityData com as seguintes modificações:
    • Alterado CheckInOnityData.CardValidity para CheckInOnityData.CardFinalValidity passando ser obrigatório.
    • Adicionado CheckInOnityData.CardInitialValidity como opcional

1.10.0

04/07/2025

Implementação do método GetConsumptionAccounts que retorna as informações de contas de consumo relacionadas a uma determinada reserva.

1.11.0

20/07/2025

Inclusão do campo CloudAccountEid ao retorno do método GetConsumptionAccounts.

1.12.0

22/07/2025

Implementação dos métodos relacionados ao pagamento através da API Hotel:

  1. Adicionado o método CreatePixPayment para criação de código de pagamento PIX.
  2. Adicionado o método AbortPix para cancelar transação PIX criada para pagamento.
  3. Adicionado o método ConfirmPixPayment para confirmação de pagamento PIX.
  4. Adicionado o método LoadPayment que retorna os dados necessários para a realização de pagamentos.
  5. Adicionado o método LoadAcquirerAuthentication que retorna os dados necessários para autenticação via 3DS.