Front Office API

Integração de dados do módulo VHF FrontOffice, conforme documentação do Swagger dos Endpoint.

CONTEÚDO

1. Visão Geral
2. Parceiros / Integração com API
3. Descrição / Instalação
4. Métodos Disponíveis na API

1. VISÃO GERAL

A API FrontOffice fornece acesso a informações relacionadas a reservas e hospedagens, permitindo a consulta aos dados 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. Parceiros / Integração com API

3. 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#/

Instalação Padrão da API

A APIFrontOffice pode ser instalada através da publicação da DLL em ums servidor APACHE.

Utilizamos o programa XAMP, para instalação do servidor APACHE, conforme os passos abaixo: 

UTILIZANDO O XAMP

Passo 1: Baixe o instalador do XAMPP
O primeiro passo para instalar o XAMPP no Windows é baixar o instalador. Acesse o site oficial do XAMPP em https://www.apachefriends.org/index.html e clique na opção de download para o sistema operacional Windows. Certifique-se de baixar a versão mais recente do XAMPP para garantir que você tenha acesso aos recursos mais atualizados.

Passo 2: Execute o instalador
Após concluir o download do arquivo de instalação, localize-o no seu computador e execute-o. Um assistente de instalação será aberto e guiará você por todo o processo.

Passo 3: Selecione os componentes
Durante o processo de instalação, você terá a opção de selecionar os componentes que deseja instalar. Por padrão, todos os componentes, como Apache, MySQL, PHP e Perl, são selecionados. No entanto, se você não precisar de algum desses componentes, pode desmarcá-los para economizar espaço em disco.

Passo 4: Escolha a pasta de instalação
Agora é hora de escolher a pasta onde você deseja instalar o XAMPP. A pasta padrão é “C:\xampp”, mas você pode selecionar uma localização diferente, se preferir. Certifique-se de escolher uma pasta em que você tenha permissões de gravação e que seja de fácil acesso.

Passo 5: Inicie a instalação
Após selecionar os componentes e a pasta de instalação, clique no botão “Next” ou “Instalar” para iniciar o processo de instalação. Aguarde até que a instalação seja concluída. Isso pode levar alguns minutos, pois o instalador está copiando arquivos e configurando o ambiente.

Passo 6: Configuração do arquivo httpd.conf 

Abra o XAMPP, clique no botão Config. na linha do serviço Apache, opção "Apache (httpd.conf)". Encontre a última linha que começo com "#LoadModule..." e copie o código abaixo e cole depois dela, antes de <IfModule unixd_module>:

<Location /frontofficeapi>
  SetHandler frontofficeapi_module-handle
</Location>

Depois, entre no diretório "C:\xampp\apache\modules", cole os arquivos "mod_FrontOfficeAPI.dll" e "FrontOfficeAPIResources.json" (https://drive.google.com/drive/folders/118YdC56rcjRN5Jou07p9BqFwMpP1SzL-) nessa pasta. Esse arquivo JSON indicará a porta a ser utilizada pela API e os dados para conexão com o banco (veja aqui). 

Passo 7: Configuração adicional (opcional)
Após a conclusão da instalação, você pode optar por fazer algumas configurações adicionais. O XAMPP pode configurar automaticamente os serviços de Apache e MySQL para iniciar quando o computador for ligado. Além disso, você pode configurar exceções de firewall para permitir o acesso aos serviços web. Essas configurações são opcionais, mas podem ser úteis para facilitar o uso do XAMPP.

Passo 8: Inicie o XAMPP (Apache)
Agora que o XAMPP está instalado, você pode iniciar o painel de controle do XAMPP para gerenciar os serviços. Clique no ícone do painel de controle do XAMPP na área de trabalho ou procure por ele no menu Iniciar. O painel de controle exibirá uma lista dos serviços disponíveis, como Apache, MySQL e PHP. Você pode iniciar e parar esses serviços com apenas um clique.

Conclusão:
Com o XAMPP instalado no seu computador Windows, você tem um ambiente de desenvolvimento web completo à sua disposição. Você pode criar e testar aplicativos web localmente antes de implantá-los em um servidor de hospedagem. O XAMPP simplifica o processo de configuração e permite que você se concentre no desenvolvimento do seu projeto. Experimente o XAMPP e aproveite a conveniência de ter um ambiente de desenvolvimento local poderoso e fácil de usar.

TELA PADRÃO DO XAMP:

Configuração do HTTPD.CONF do Apache para habilitar o serviço da API FrontOffice

• Pare (Stop) o servidor APACHE e clica no botão de config para acessar o aquivo TXT httpd.conf e configurar o módulo da API FronToffice conforme a imagem abaixo.

Arquivo JSON

• API_PORT: chave para configuração da porta
• DATABASE_SCHEMA: chave para schema do banco 
• DATABASE_ALIAS: chave para alias do banco
• DATABASE_PASSWORD: chave para a senha do banco

 Retornar

4. MÉTODOS DISPONÍVEIS NA API 

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