Exibir origem

CONTEÚDO

Visão Geral
Instalando o FrontOffice API.
Parceiros / Integração com API.
Servidor Cloud de Terceiros.
Descrição.
Iniciando o serviço.
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 especificos.

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.

Execute o instalador baixado na sua maquina. Clique no boão avançar na tela que é mostrada.

Nessa nova tela, clique em instalar.

Neste momento o instalador esta iniciando o processo de instalação do xamp, isso pode levar alguns minutos.

Nessa tela são os parametros para acesso ao banco de dados do cliente.

Configuração da API

Path : Caminho onde esta instalado o apache do xamp. (não deve ser alterada)

Porta da API : Porta da API. (não deve ser alterada)

Nome da API : Nome do serviço de API do Front. (não deve ser alterada)

Api SecretKey : Não deve ser preenchido.

Configuração do Banco de Dados

Schema : Eschema do banco do cliente

Alias : Alias do banco do cliente

Usuário do Banco : Usuário de acesso ao banco.

Senha do Banco : Senha do usuário do banco.

ID's de Configuração

ID Parametro : Usado para o Timesahring API. (não deve ser preenchido).

ID Hotel : ID do Hotel na base do cliente.

ID Empresa : ID da empresa na base do cliente.

ID Usuaério : ID do usuário do sistema.

Tipo de Ambiente : Informa o tipo de ambiente, no cliente pode ser colocado produção.

Clique no botão (Salvar Configurações)

Neste momento o serviço do xamp já foi instalado, os aquivos necessários para funcionar a API já esta configurada, clique em concluir para fechar a tela de instalação.

3. Parceiros / Integração com API

Integram Com Essa API

1- Bebook

2- Voa

3- Upcash

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://129.151.33.247:89/frontofficeapi/v1/swagger/doc/html#/

6. Iniciando o serviço

Após instalação localize no iniciar do windows o atalho para abrir o programa xamp.

Após iniciar o aplicativo será mostrado a tela ao lado, clique no botão start para que o serviço fique habilitado para o uso.

Desta forna o serviço já esta disponivel para ser utilizado, feche a tela.

Retornar

7. MÉTODOS DISPONÍVEIS NA API

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