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.
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.
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.
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
A API permite conectar com dois banco de dados homologados pela TOTVS, Oracle ou SQL Server. Após a configuração dos dados de conexão, mencionada no item 4.1, escolha uma opção de banco de dados e clique no botão testar conexão.
- 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.
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?
Na prática:
- Quando a decisão for utilizar a opção Usuário Fixo, o usuário e senha informado nesses campos, deve ser cadastrados primeiro no VHF e vinculado a um grupo de usuário.
- Quando a decisão for utilizar a opção Usuário Banco, o usuário e senha será o mesmo utilizado para acessar o banco de dados. Caso o cliente não queria disponibilizar o usuário padrão do banco, pode ser criado um usuário específico para a API.
- Com base em lições aprendidas, todas as ativações realizadas em APIs que existem a opção Usuário Banco, foi dada prioridade em utilizar essa opção e não a opção Usuário Fixo.
|