Histórico da Página

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tela XXX
   1. Outras Ações / Ações relacionadas
      
4. Tela XXX
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

1. Configuração Simplificada
2. Configuração Detalhada
3. Testando a Disponibilidade do TSS REST SERVER 
4. Outras Configurações de Autenticação TSS

01. VISÃO GERAL

Âncora
visao visao

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.

02. CONFIGURAÇÃO SIMPLIFICADA

Âncora
simplificada simplificada

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.

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

03. CONFIGURAÇÃO DETALHADA 

Âncora
p3 p3

Para uma configuração mais especifica das seções e chaves do TSS REST SERVER acessar: TSS REST SERVER 1.0 - Documentação Detalhada

04. TESTANDO A DISPONIBILIDADE DO TSS REST SERVER

Âncora
p4 p4

Servidor disponível

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:

Image Added

Indicativo da(s) URL(s) do(s) TSS REST SERVER mapeado(s):

Image Added

Cada URL poderá ser informado como endereço de URL em um browser/navegador, para verificação da disponibilidade do serviço REST do(s) servidor(es) do TSS REST SERVER:

Image Added

Esta imagem somente será apresentado se o arquivo index.html estiver presente na pasta indicado na seção URIs

Image Added

Servidor indisponível

Caso haja algum problema ao subir o servidor TSS REST SERVER, ao tentar informar a URL no navegador/browser será exibida a seguinte mensagem:

Image Added

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.

05. OUTRAS CONFIGURAÇÕES DE AUTENTICAÇÃO TSS

Âncora
p5 p5

• Autenticação TSS
• TSS REST SERVER 1.0 - Documentação Detalhada

04. TELA XXXXX

Principais Campos e Parâmetros

...

...