Exibir origem

Esse documento descreve a instalação e configuração modelo das serviços utilizados pelos aplicativos mobile

Guia passo a passo

Adicione as etapas envolvidas:

Instalação e Configuração
Guia API Parâmetros
Guia API Serviço
Guia SGBD

1. Instalação e Configuração

A tela da aplicação possui duas abas "API" e a "SGBD". Cada uma delas serão melhor descritas nos tópicos abaixo.

Recomendado sempre executar a API como "Administrador". Caso contrário, não terá sucesso na tentativa de instalação como serviço do Windows.

2. Guia API - Parâmetros de Recebimento

Porta: Campo destinado à digitação da porta de conexão que será utilizada pelo APP ou aplicações terceiras. Por padrão, a porta sugerida será: 9000. Porém, pode ser alterada a critério do Hotel.

Garantir que a porta digitada e conectada, esteja liberada para uso no firewall e regras de segurança.

Conectar: Clicar para tornar disponível a porta digitada para conexão à API .

Desconectar: Clicar para desconectar a porta. Após esta ação, o APP ou aplicações terceiras não conseguirá acessar a API.

TOTVS Hospitalidade > Configurando Serviço Padrão > 2023-07-19_17h37_52.png

3. Guia API - Serviço do Windows

Este recurso tem como função instalar a API como um serviço no Windows.

Permitirá a execução dos serviços, em segundo plano, sem a necessidade de deixa-los abertos.

Quando esta opção for utilizada pelo hotel, os serviços serão executados automaticamente caso o servidor de aplicação seja desligado e ligado novamente.

Após a instalação, como Serviços do Windows, faz-se necessário fechar as APIs, acessar o serviço do Windows e iniciá-las. Importante garantir que estejam configurados para iniciar automaticamente.

3.1 Instalar: Clicar para instalar o serviço.

Para que este processo tenha sucesso, o arquivo deve ser executado como administrador.
Ao final, não será exibida mensagem informando o termino do processo.
O processo de instalação será rápido, e para garanti-lo, acesse o serviço do Windows.

O vídeo abaixo explica o processo para instalar os serviços.

3.2 Desinstalar: Clicar para desinstalar o serviço.

Para que este processo tenha sucesso, o arquivo deve ser executado como administrador.
Ao final, não será exibida mensagem informando o termino do processo.
O processo de instalação será rápido, e para garanti-lo, acesse o serviço do Windows.

O vídeo abaixo explica o processo para desinstalar os serviços.

TOTVS Hospitalidade > Configurando Serviço Padrão > STAFF - Desinstalar Serviço Windows.gif

TOTVS Hospitalidade > Configurando Serviço Padrão > 2023-07-19_18h02_21.png

3. Guia SGBD

Esta parte é destinada a inserção de dados reservados a conexão direta com o banco de dados sendo ele Oracle ou SQL Server.

TOTVS Hospitalidade > Configurando Serviço Padrão > 02.png

4. Gerenciador de Conexão

4.1 Campos para preenchimento, informações sobre a base de dados.

Quando o driver for marcado como SQL Server, o campo Host, precisa ser preenchido com o nome ou ip do servidor onde o banco de dados estiver instalado.
O dado informado no campo usuário e senha, vai variar de acordo com a opção Usuário Fixo ou Usuário Banco. Existe API que possui a opção Usuário Banco. A seguir, será explicada a diferença entre uma e outra.

4.2 Driver

Oracle: Escolha da plataforma de banco de dados, Oracle.

SQL Server: Escolha da plataforma de banco de dados, SQL Server.

Teste de conexão: usado para testa se tem conexão entre API e o Banco de dados.

Quando o driver for marcado como SQL Server, o campo Host, precisa ser preenchido com o nome ou ip do servidor onde o banco de dados estiver instalado.
Ao clicar no botão Testar Conexão, a API gravará as informações digitadas em um arquivo <ini> que será utilizado sempre que a API estiver em execução.

4.2.1 Qual a diferença entre a opção Usuário Fixo e Usuário Banco.

TOTVS Hospitalidade > Configurando Serviço Padrão > image2023-7-27_14-56-34.png

Algumas APIs disponibilizam a opção Usuário Banco, além da opção Usuário Fixo. E qual a diferença entre uma opção e outra?

Quando a opção Usuário Fixo es marcada, o dado informado no campo Usuário / Senha, utilizará um usuário do sistema para validar o log-in nas APIs. Ou seja, um usuário cadastrado para acessar os módulos dos produtos Hotal.

Quando a opção Usuário Banco estiver marcada, o dado informado no campo Usuário / Senha, utilizará um usuário do Banco de Dados para validar o log-in nas APIs. Ou seja, um usuário cadastrado para acessar os módulos será o do banco de dados.

Na prática: