Guia de instalação e atualização da API V5
Documentação Técnica V5
Introdução
A API V5 foi desenvolvida para facilitar integração entre o sistema ERP de um cliente e a Rastreabilidade V5. Neste guia abordaremos como instalar a API V5, bem como realizar uma atualização.
Conteúdo
1. Pré-requisitos
1.1. Java
Se ainda não estiver presente no sistema, o Java Runtime Environment (versão 8-15) deverá ser instalado. Isso pode ser de 32 ou 64 bits. Se instalar a API em um sistema no qual qualquer aplicativo de rastreabilidade V5 também esteja instalado, o Java já estará instalado e esta etapa poderá ser ignorada.
OpenJDK (Java Development Kit) também é compatível para uso com a API V5.
1.2. Apache Tomcat/Hospedagem
A primeira coisa que precisamos fazer para instalar a API V5 é instalar Apache Tomcat. A API V5 suporta o uso do Apache Tomcat até a versão 10, e a SG Systems recomenda instalar a versão 9 ou 10.
Outras plataformas de hospedagem, como glassfish, também podem ser usadas no lugar do Apache Tomcat, mas neste exemplo utilizaremos o Tomcat.
Neste exemplo iremos instalar o Tomcat 9.0.75, realizando uma instalação 'Normal' do software. Podemos definir uma porta HTTP para o Tomcat usar, que por padrão será a porta 8080. Isso pode causar problemas de conflito com Relatórios SG que também usa a porta 8080 por padrão, então recomendamos usar uma porta diferente aqui (8181 neste exemplo) se o SG Reports estiver instalado no sistema.
Um nome de serviço e nome de usuário e senha de administrador do Tomcat também podem ser definidos aqui, o que pode ficar a seu critério. Para nossa instalação de demonstração, procedemos da seguinte forma:
Durante a instalação, você será solicitado a apontar o instalador para a pasta de instalação do JRE. Deve ser preenchido automaticamente, mas caso contrário, você precisará nomear a pasta correta.
Após a conclusão da instalação, a opção 'Executar Apache Tomcat' deve ser selecionada.
Este novo serviço do Windows deve ser configurado para iniciar com o Windows no futuro para garantir o funcionamento constante da API. Isso pode ser definido nas configurações dos Serviços do Windows ou na janela de propriedades do Tomcat, que pode ser encontrada executando uma pesquisa no Windows por 'configurar o Tomcat'. O tipo de inicialização pode então ser definido na guia ‘Geral’:
Também é recomendado definir as configurações de fuso horário do Tomcat nesta mesma janela de propriedades. Na aba 'Java' precisaríamos colar '-Duser.timezone=GMT' no painel 'Opções Java' e aplique:
Também é recomendável aumentar o pool de memória máximo do Tomcat para 1024 MB para lidar melhor com solicitações de dados maiores:
Para verificar a instalação correta do Tomcat, é recomendado neste momento verificar a conectividade com ele em um navegador da web. Para esta instalação, nos conectaríamos a http://127.0.0.1:8181/ (host local e o número da porta que escolhemos durante a instalação) e veríamos isto:
2. Instalando a API V5
Depois de nos certificarmos de que todos os pré-requisitos estão em vigor, podemos passar para a API em si. A versão mais recente da API V5 pode ser baixada aqui.. Isso fará o download de 'V5-API.war'.
Este arquivo deve então ser colocado em:
*InstallDir*\Apache Software Foundation\*nome do serviço escolhido*\webapps
Então, para o nosso exemplo, isso é:
C:\Arquivos de programas\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API\webapps
Uma vez colocado aqui, e com o serviço Tomcat em execução, uma pasta ‘V5-API’ será criada automaticamente junto com o arquivo ‘war’.
A instalação da API V5 agora está concluída. Agora só precisamos conectá-lo ao banco de dados V5.
3. Configurando a API V5
Na pasta principal de instalação do Tomcat (então 'C:\Arquivos de programas\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API' no nosso caso aqui) precisamos criar uma nova pasta chamada 'configuração'. Em seguida, baixe o seguinte arquivo 'db_settings.properties' aqui..
Abra este arquivo com o bloco de notas e exclua qualquer conjunto de dados que não seja relevante para o tipo de banco de dados SQL que está sendo usado com Rastreabilidade V5. Se você não tiver certeza sobre este método, entre em contato Suporte SG.
Entre em contato com o administrador do banco de dados para preencher os campos de nome de usuário e senha.
Em seguida, coloque este arquivo concluído na pasta indicada acima e reinicie o serviço Tomcat. A conexão com o banco de dados será estabelecida agora!
Para obter orientação sobre como usar a API V5, consulte nossa seção API dedicada aqui..
4. Atualizando a API V5
Atualizar a V5-API é tão simples quanto baixar novamente o arquivo 'V5-API.war' usando este link. Depois de baixado, exclua o arquivo .war antigo, bem como a pasta que ele criou quando foi instalado originalmente.
Em seguida, basta repetir as etapas acima da instalação, soltar o arquivo 'V5-API.war' nesta pasta novamente, permitir a extração da pasta novamente e reiniciar o serviço Tomcat.
Agora você pode continuar usando a API, atualizada para a versão mais recente!
