...
Devido a demanda de segurança na camada das APIs disponibilizadas pelo TSS, a partir da versão de release 12.1.2410 do TSS, o serviço REST deverá ser reconfigurado. A nova configuração de REST no produto passa a ser o TSS REST SERVER 1.0 e não mais as configurações de REST do Framework Protheus que deverão deixar de ser utilizada a partir da release 12.1.2410.
A seguir serão detalhadas as configurações do novo TSS REST SERVER.
Âncora | ||||
---|---|---|---|---|
|
Visando maior segurança às APIs REST do TSS, foi implementado o servidor TSS REST SERVER, que conta com uma camada a mais de segurança, usando autenticação para todas as APIs REST do TSS.
Este documento tem o objetivo de ilustrar a configuração do TSS REST SERVER a ser realizada no arquivo appserver.ini do TSS.
O TSS REST SERVER é o substituto para o REST 2.0 do Framework Protheus como configuração de REST para (e somente) o TSS.
Para isso, será necessário realizar a troca do REST 2.0 presente nos releases de TSS 12.1.2310 ou versões inferiores, para o novo TSS REST SERVER, que será oficialmente disponibilizado e sustentado na release 12.1.2410 ou superiores do TSS.
As configurações de REST presentes em releases do TSS inferiores à 12.1.2410 poderão ser mantidas mas não terão suporte a autenticação de APIs em REST.
A seguir, veremos como configurar o novo TSS REST SERVER de forma detalhada.
Aviso | ||
---|---|---|
| ||
As configurações detalhadas aqui são de uso exclusivo no produto TSS e em releases iguais ou superiores à 12.1.2410. |
Âncora | ||||
---|---|---|---|---|
|
Neste capítulo iremos abordar as configurações mínimas ou simplificada para o correto funcionamento do novo TSS REST SERVER.
Para isso, basta informar as seguintes seções e chaves no arquivo de appserver.ini do TSS.
Para que o novo REST seja habilitado no TSS basta realizar a configuração mínima com as seguintes seções no appserver.ini do TSS. São elas:
[TSSREST_CONFIG]
Servers=TSSREST_SERVER[TSSREST_SERVER]
Port=
...
1323
URIs=TSSREST_URI
[TSSREST_URI]
URL=/
...
api/tss
Instances=1,4,1,1
[JOBTSSREST]
main=TSSREST_START
environment=SPED[ONSTART]
JOBS=JOBTSSREST
REFRESHRATE=10
...
Após inicialização do appserver.exe do TSS, no console.log será apresentado mensagem semelhante:
Com o indicativo da URL do REST criado:
Informações | ||
---|---|---|
| ||
Atenção à porta a ser utilizada, não poderá conflitar com nenhuma outra porta usada no mesmo appserver.ini. O JOBTSSREST deverá ser incluído junto dos demais jobs presentes na seção [ONSTART] e, uma vez que esteja presente, o job referente ao REST 2.0 do Framework poderá ser removido. |
Âncora | ||||
---|---|---|---|---|
|
Para uma configuração mais especifica das seções e chaves do TSS REST SERVER acessar: TSS REST SERVER 1.0 - Documentação Detalhada
Âncora | ||||
---|---|---|---|---|
|
Com o appserver.ini do TSS devidamente configurado, ao inicializar o serviço do TSS (appserver.exe), após mais ou menos 10 segundos da inicialização, serão impressos alguns logs no arquivo de console.log, informando o status da criação do(s) servidor(es) REST do TSS REST SERVER, conforme imagens a seguir:
Subida do TSS REST SERVER com sucesso:
Indicativo da(s) URL(s) do(s) TSS REST SERVER mapeado(s):
Cada URL Que poderá ser informado como endereço de URL em um browser/navegador, para verificação da disponibilidade do serviço de TSS REST SERVER:
Aqui serão mostradas todas as configurações possível de serem configuradas para um controle maior do(s) serviçoservidor(ses) REST do TSS REST SERVER:
Esta imagem somente será apresentado se o arquivo index.html estiver presente na pasta indicado na seção URIs
. Âncora uris uris
Para isso, serão quebradas por seções do appserver.ini para um melhor entendimento.
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Enable=1
Servers=TSSREST_SERVER
Charset=UTF-8
Log=1 |
ds
fds
...
Caso contrário será apresentada a seguinte tela:
Caso haja algum problema ao subir o servidor TSS REST SERVER, ao tentar informar a URL no navegador/browser será exibida a seguinte mensagem:
Isto significa que houve um problema na subida do TSS REST SERVER e as APIs não serão disponibilizadas para uso. A causa pode estar na configuração errônea do appserver.ini ou alguma tipo de conflito porta ou URI informados.
Âncora | ||||
---|---|---|---|---|
|