Para utilização dos Apps é necessário que o REST do Protheus esteja habilitado e configurado corretamente, com a autenticação habilitada. Nas seções abaixo temos alguns exemplos de configuração e validação.
Para fazer a configuração do Rest é recomendado que seja criada uma cópia do appserver do Protheus para que ele rode em instâncias separadas conforme no exemplo abaixo:
Os arquivos podem ser copiados da pasta appserver, sendo necessário alterar apenas o arquivo appserver.ini da pasta onde ficará o REST.
Caso você utiliza mais de um tipo de webservice, para correto funcionamento das integrações, o appserver REST e SOAP não devem rodar na mesma instância do serviço, nem estar expostos na mesma porta. |
O arquivo appserver.ini deve conter as chaves abaixo:
[General] MAXSTRINGSIZE=10 // Essa chave é obrigatória com o valor mínimo de 10 [HTTPV11] Enable=1 Sockets=HTTPREST [HTTPREST] Port=8080 // porta que o REST irá utilizar para subir o serviço, pode ser alterada para qualquer outra porta. IPsBind= URIs=HTTPURI Security=1 // O valor 1 é obrigatório. [HTTPURI] // mesmo valor da chave URIs, definido na linha 7 URL=/rest // path onde o rest irá subir, pode ser alterado. PrepareIn=ALL // Chave que indica qual environment será preparado para o rest. ALL significa que deve ser preparado para atender todas as empresas. Caso você queira utilizar o REST com empresa 1 filial 01, por exemplo, inserir na chave 1,01 Instances=2,5,1,1 // Chave obrigatória, mais informações sobre configuração em http://tdn.totvs.com/display/tec/Instances . A configuração desta chave impacta diretamente no total de licenças consumidas pelo REST. CORSEnable=1 // essa chave é obrigatória e com o valor 1, caso contrário, o REST não aceitara as requisições dos apps. AllowOrigin=* // Essa chave limita os IP's que o REST do Protheus pode responder, deve conter o valor * (responder para qualquer ip) ou os ip's específicos onde a integração será realizada [HTTPJOB] MAIN=HTTP_START // Cria um JOB que inicializa o servidor HTTP na inicialização do serviço ENVIRONMENT=environment // Diz em qual environment o JOB será configurado [ONSTART] jobs=HTTPJOB // Indica que o HTTPJOB será iniciado quando o serviço for iniciado RefreshRate=30 // Indica qual a taxa de atualização para reiniciar o JOB em caso de falha |
Obs: O exemplo acima contém apenas os valores obrigatórios referente ao REST.
Exclusivamente para o aplicativo Meu Coletor de Dados, é necessário incluir a chave MODULE na seção HTTPURI:
A configuração do REST do Meu Coletor de Dados não pode ser compartilhada com os demais aplicativos. |
Após configurado, você pode iniciar o executável do appserver do REST em modo console e verificar se ele subiu corretamente através da mensagem no console:
A falta de quaisquer uma das chaves no exemplo acima faz com que o REST não funcione como esperado. Abaixo listamos algumas:
A chave SECURITY indica se o REST irá validar o usuário que esta fazendo a chamada ou não, quando o valor esta como 0, é desconsiderado o usuário enviado e o Protheus executa a chamada com o usuário administrador. Essa configuração traz grandes problemas de segurança para o Protheus e deve ser usado apenas em modo de desenvolvimento.
Os aplicativos também não funcionam corretamente, pois independente do usuário que fez o login, os dados e configurações de usuário exibidos dentro do aplicativo, são do usuário administrador.
Caso não haja a chave SECURITY, o valor dela é 1, o que esta correto também.
A chave prepareIn indica para quais empresas/filiais o REST irá subir uma thread. O Valor ALL usado no exemplo acima sobe uma thread para cada empresa e filial. Porém é consumida uma licença (TOTVS i) para cada thread. Caso o cliente não for utilizar todas as empresas, é possível subir apenas para as que ele deseja. Exemplo:
PrepareIn=T1, D MG 01
A chave CORSEnable indica se o REST do Protheus pode receber requisições fora do próprio servidor. Para utilização dos Apps, essa chave é obrigatória com o valor 1. Pois seu valor padrão é 0.
A chave AllowOrigin indica de quais ip's o REST pode responder. Quando o valor é * (asterisco), indica que o Protheus pode responder para qualquer ip. Para utilização dos Apps, é possível limitar o acesso apenas para os ranges de ip's do Mingle (criar link para documentação do Mingle) listados abaixo:
Existem diferentes maneiras para verificar se o REST esta com a configuração correta.
A primeira e mais fácil de fazer, é acessa-lo pelo navegador, verificando esse acesso é possível saber se o REST esta de pé. Caso não seja possível acessa-lo, os aplicativos não irão funcionar.
Como testar:
Caso esteja fazendo o teste em ambiente local, siga os passos abaixo:
Em nosso exemplo, ficaria
http://10.172.145.178:8080/rest
Acessar o endereço pelo navegador.
Caso o teste seja feito em um ambiente do cliente, será necessário orienta-lo a seguir os passos acima.
Após ter o endereço do REST em mãos, é recomendado testar de um outro aparelho que não seja o próprio servidor. Pode ser qualquer computador ou celular que esteja na mesma rede (do cliente).
Em ambos os casos, deverá ser aberta uma página semelhante a abaixo:
Após ter seu REST configurado e funcional no ambiente, para alguns aplicativos, pode ser necessário expo-lo em IP fixo externo (para configuração do ALIAS do Mingle).
Esta configuração deve ser feita na infraestrutura de rede de sua empresa, e os IPs de origem do Mingle devem ser liberados para realizar conexões de entrada e saída.
Abaixo algumas documentações que podem auxiliar em caso de dúvidas/problemas:
Framework: Configuração do REST (Geral)
02. REST com ERP Microsiga Protheus
Exemplo de configuração do REST
Dicas sobre Configuração REST Protheus®