Linha Logix

Páginas filhas
  • LGX - Comunicação REST




No LOGIX, existem configurações a serem definidas no arquivo de configuração do TotvsAppserver (Arquivo Totvsappserver.ini) para executar e desenvolver métodos utilizando a arquitetura REST na tecnologia TotvsTec.


A seguir será apresentado um exemplo de configuração do TotvsAppserver e algumas referências para outras documentações também disponíveis a respeito do mesmo assunto.


Para mais detalhes a respeito de conceitos, configurações e testes utilizando arquitetura REST com TotvsTec clique AQUI (necessário solicitar permissão para equipe TotvsTec).



Configurações no arquivo appserver.ini


É necessário definir algumas seções no arquivo de configuração do Appserver e ajustar, quando necessário, os valores para o nome do ambiente (Chave ENVIRONMENT), porta (Chave PORT), quantidade de instâncias para execução no AppServer (Chave INSTANCES) e Chave URL para indicar o endereço em que as requisições REST serão atendidas.


[ONSTART]
REFRESHRATE=30
JOBS=HTTPJOB 

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=logix12_ora  ;*** NOME DO AMBIENTE LOGIX, pode ser modificado

[HTTPV11]
ENABLE=1
SOCKETS=HTTPREST
TIMEOUT=600 

[HTTPREST]
PORT=8580   ;*** Porta utilizada na URI, pode ser modificada
URIS=URITESTE
SECURITY=0

[URITESTE]
URL=/   ;*** Endereço base pra atender as requisições REST. Exemplo: http://localhost:8580/api/vdp/v1/clientes
INSTANCES=2,2   ;*** Número de instâncias utilizadas para atender as requisições REST (quantidade inicial e máxima de instâncias)
ONSTART=LOGIXRESTSTART
ONCONNECT=LOGIXRESTCONNECT
ONEXIT=LOGIXRESTEXIT

(aviso) ATENÇÃO! Fique atento ao utilizar o parâmetro de configuração com a chave Security=0, pois isso fará com que as integrações (APIs) não exijam autenticação e consequentemente dados do seu ambiente poderão ser consultados sem qualquer controle de autorização.

(seleção) Neste caso é indicado que ative a autenticação REST conforme orientações no item Ativando autenticação REST a seguir.


Com base na configuração acima, as requisições REST serão atendidas a partir da seguinte URL base:  http://localhost:8580/rest


Ativando autenticação REST

Para ativar o controle de autenticação nas requisições REST e passar a exigir que as requisições sejam executadas usando protocolo HTTPS, é necessário alguns procedimentos que estão descritos a seguir:


Ative a chave SECURITY na seção HTTPREST:

[HTTPREST]
PORT=8580   ;*** Porta utilizada na URI, pode ser modificada
URIS=URITESTE
SECURITY=1   ;*** Ativar a autenticação das requisições REST


Ativando a chave SECURITY=1 precisará configurar também as seguintes chaves CERTIFICATE, KEY e PASSPHRASE na seção [HTTPREST], com os dado do certificado SSL.

A partir da ativação da autenticação das requisições REST, na seção HEADER das requisições deverá constar o campo AUTHORIZATION contendo as informações de usuário e senha no formato BASE64.


Exemplo:

Supomos que para realizar a requisição de uma API REST do LOGIX seja necessário executar a URL de requisição abaixo:

Informação

Valor

MétodoGET
URLhttps://<servidor>:<porta_rest>/api/vdp/v1/states/SC 

HEADER

Authorization


Basic Auth

Username=[usuário logix] 

Password=[senha usuário Logix]


Para o exemplo acima, na seção Header da URL de requisição REST, deverá ser enviada a chave "Authorization":"BASIC XXXXXXXXXXXX", onde XXXXXXXXXXXX é a tupla usuario:senha do Logix convertidos em Base64.

Exemplo: 


Com isso a segurança na comunicação se dará principalmente pelo uso de certificados SSL que garantem a abertura da comunicação segura entre os dois pontos e também o uso da autenticação de um usuário logix válido.