Front Office API

CONTEÚDO

1. Visão Geral
2. Instalando o FrontOffice API.
3. Parceiros / Integração com API.
4. Servidor Cloud de Terceiros.
5. Descrição.
6. Iniciando o serviço.
7. Métodos Disponíveis na API.

1. VISÃO GERAL

  A documentação e orientações técnicas descritas a seguir tem o objetivo de comunicação com os produtos TOTVS Hospitalidade PMS - Linha Hotal (VHF). Essa integração foi desenvolvida pela TOTVS Hospitalidade visando atender uma necessidade identificada,  atuando como como facilitador de integrações entre sistemas utilizados por nossos clientes e que não se adequem aos padrões já utilizados pelas soluções HIGS e CMNET Reservas. 

  O acesso as informações e operações relacionadas a reservas e hospedagens, são feitas através de endpoints específicos. 

  Em decorrência do avanço da utilização do ambiente em cloud, as integrações e consumo de dados que eram realizadas através de views no SGBD, não atende a acessibilidade imediata das informações. Com isso a necessidade da evolução da disponibilização dos dados através de API.

2. Instalando o FrontOffice API.

  Primeiro entre em contato com o setor comercial da Totvs para entender a disponibildade desse serviço para o hotel, depois baixe o instalador do serviço (Setup_FRontOfficeAPI.exe), e execute em sua maquina. Este instalador, instala automaticamente o serviço Xamp e configura o mesmo para ser executado, siga os passos mostrados abaixo.

3. Parceiros / Integração com API

4. Servidor Cloud de Terceiros 

No caso de clientes que possuam serviço de terceiros (FTC Cloud da Faitec, por ex.), a configuração do XAMPP deverá ser realizada pelo terceiro, que retornará a informação do ip público (externo) e porta, para que seja informado ao parceiro da integração junto com o Client ID, Client Secret e o id do Hotel. 

4.1 Requisitos de Hardware e Software para hospedagem da API de integração

Para consultar os requisitos mínimos de hardware recomendados para o servidor de aplicação, clique aqui e acesse o tópico "Configuração recomendada para servidor de aplicações".

5. Descrição

Para que seja consumido os dados dos EndPoints da API - FRONTOFFICEAPI,  necessita de liberação do ClienteID e ClienteSecret. A liberação será realizar pela equipe de Plugin mediante a contratação comercial. 

A API - FRONTOFFICEEAPI possui os EndPoints conforme documentação do Swagger no link abaixo:

Swagger: http://IP:Porta/frontofficeapi/v1/swagger/doc/html#/

Exemplo de Swagger:   http://3.233.251.89:89/frontofficeapi/v1/swagger/doc/html#/

6. Iniciando o serviço

7. MÉTODOS DISPONÍVEIS NA API 

Abaixo os Métodos disponíveis nos EndPoints da API.  PUBLICADO

• Authenticate

  • POST /frontofficeapi/v1/authenticate

    Descrição: Inserir Authenticate

    Requisição

    {
        "clientId": "38629890-9CF8-46B0-ACF8-03AD46A3DCC8",
        "clientSecret": "276d56d0-77ad-11f0-8962-113d4e2eef4e",
        "app": "FRONTOFFICEAPI"
    }

    Respostas

    Código	Response
    201	OK
    400	Bad Request

• Listar cliente reservante

  • GET /frontofficeapi/v1/clienteReservante

    Descrição: Listar cliente reservante

  • Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    status	string	Não	Status
    dataPassandoInicio	string	Não	Data passando inicial
    dataPassandoFim	string	Não	Data passando final
    dataChegadaInicio	string	Não	Data chegada inicial
    dataChegadaFim	string	Não	Data chegada final
    dataPartidaInicio	string	Não	Data partida inicial
    dataPartidaFim	string	Não	Data partida final
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

  • Respostas

    Código	Descrição
    200	OK

• Listar Disponibilidade

  • GET /frontofficeapi/v1/disponibilidade

    Descrição: Listar Disponibilidade

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial - padrão dd-mm-yyyy
    dataFim	string	Sim	Data final - padrão dd-mm-yyyy
    tipouh	string	Sim	Tipo UH
    idContrato	integer	Não	Identificador do contrato do cliente
    idAgrupadorUh	string	Não	Identificador do Agrupador de Uhs
    codAgrupadorUH	string	Não	Código do Agrupador de Uhs
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Hospedagem

  
  

  • GET /frontofficeapi/v1/hospedagem

    Descrição: Listar Hospedagem

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial
    dataFim	string	Sim	Data Final
    cancelada	integer	Não	Para incluir reservas canceladas na resposta, utilize o valor 6
    gratuidade	integer	Não	Para incluir reservas gratuitas na resposta, utilize o valor 1
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Hospede

  
  

  • GET /frontofficeapi/v1/hospede

    Descrição: Listar Hospede

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHospede	integer	Sim	Identificador do hospede
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar hotel

  
  

  • GET /frontofficeapi/v1/hotel

    Descrição: Listar hotel

    Parâmetros        

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Não	Identificador do hotel
    nome	string	Não	Nome do hotel

    Respostas

    Código	Descrição
    200	OK

• Listar Inventario

  
  

  • GET /frontofficeapi/v1/inventario

    Descrição: Listar Inventario

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataIni	string	Sim	Data inicial - padrão dd-mm-yyyy
    dataFim	string	Sim	Data final - padrão dd-mm-yyyy
    tipouh	string	Sim	Tipo UH
    idContrato	integer	Não	Identificador do contrato do cliente
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Origem Reserva

  
  

  • GET /frontofficeapi/v1/origemReserva

    Descrição: Listar Origem Reserva

    Respostas            

    Código	Descrição
    200	OK

• Reserva

  • Cancelar Reserva

    
    

    • PUT /frontofficeapi/v1/reserva/{numReserva}

      Descrição: Cancelar Reserva

      Parâmetros

      Nome	Tipo	Obrigatório	Descrição
      numReserva	integer	Sim	Número da reserva

      Respostas

      Código	Descrição
      201	Created
      204	No Content
      404	Not Found

  • Listar Reserva

    
    

    • GET /frontofficeapi/v1/reserva

      Descrição: Listar Reserva

      Parâmetros

      Nome	Tipo	Obrigatório	Descrição
      idhotel	Integer	Sim	Identificador do hotel
      numreserva	string	Não	Numero da reserva
      numdocumento	string	Não	Documento do cliente
      dataInicial	string	Não	Data inicial do filtro. Sozinha, retorna registros a partir desta data
      dataFinal	string	Não	Data final do filtro. Usada com dataInicio para intervalo.
      status	Integer	Não	Status da reserva
      page	integer	Não	Número da página
      pageSize	integer	Não	Quantidade de registros por página

      Respostas

      Código	Descrição
      200	OK
      204	No Content

      Possíveis  status de reserva

      Código	Descrição
      0	A Confirmar
      1	Confirmada
      2	Check-In
      3	Check-Out
      4	Pendente
      5	No-Show
      6	Cancelada
      7	Waiting List
      8	Em Tentativa

• • Inserir Reserva

    • POST /frontofficeapi/v1/reserva

      Descrição: Inserir Reserva

      Parâmetros          

      Nome	Tipo	Obrigatório	Descrição
      dados		Sim

      Respostas

      Código	Descrição
      201	Created
      400	Bad Request

• Listar reserva de grupo

  
  

  • GET /frontofficeapi/v1//reservaGrupo

    Descrição: Listar reserva de grupo

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    dataEntrada	string	Sim	Data da entrada
    dataSaida	string	Sim	Data da saída
    page	string	Não	Número da página. Para utilizar esse recurso adicionar a tag (X-Paginate=true) no Header da requisição.
    limit	string	Não	Quantidade de registros por página

    Respostas

    Código	Descrição
    200	OK

• Listar Segmento

  
  

  • GET /frontofficeapi/v1/Segmento

    Descrição: Listar Segmento

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    IdHotel	string	Não	Hotel
    CodSegmento	integer	Não	Identificador do Segmento

    Respostas

    Código	Descrição
    200	OK

• Listar TipoUH

  
  

  • GET /frontofficeapi/v1/tipoUH

    Descrição: Listar TipoUH

    Parâmetros

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    IdTipoUh	integer	Não	Identificador do tipo de UH

    Respostas

    Código	Descrição
    200	OK

• Listar UH

  
  

  • GET /frontofficeapi/v1/UH

    Descrição: Listar UH

    Parâmetros         

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    tipo	string	Não	Tipo da UH
    grupo	string	Não	Grupo da UH

    Respostas

    Código	Descrição
    200	OK

• Buscar agrupador de Uh

  
  

  • GET /frontofficeapi/v1/agrupadorUh/codReduzido

    Descrição: Buscar agrupador de Uh

    Parâmetros                      

    Nome	Tipo	Obrigatório	Descrição
    idHotel	integer	Sim	Identificador do hotel
    idAgrupadorUh	integer	Não	Identificador do agrupador de uh
    codReduzido	string	Não	Código reduzido

    Respostas

    Código	Descrição
    200	OK
    404	Not Found