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.
Neste capitulo iremos abordar as configurações mínimas para o funcionamento do novo REST do TSS.
Para isso basta informar as seguintes seções e tags no arquivo de appserver.ini do TSS. São elas:
[TSSREST_CONFIG]
Servers=TSSREST_SERVER
[TSSREST_SERVER]
Port=1322
URIs=TSSREST_URI
[TSSREST_URI]
URL=/rest/tss
[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:
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ço(s) REST do TSS.
Para isso, serão quebradas por seções do appserver.ini para um melhor entendimento.
[TSSREST_CONFIG]
Seção responsável por iniciar as configurações do TSS REST SERVER (HTTPSERVER).
De todos os nomes de seções que serão tratados, este é o único que é obrigatório manter o mesmo nome TSSREST_CONFIG.
Abaixo serão detalhadas as tags desta seção:
| TAG | Descrição | Valores Possíveis | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Enable | Responsável por habilitar ou desabilitar a subida do TSS REST SERVER ao iniciar o apsserver.exe do TSS | 0=Desabilitado ou 1=Habilitado | Não | 1 |
| Servers | Nome de Seções com configuração de porta e URL (pelo menos uma seção). Por ela é possível definir um ou mais servidores, sendo assim, pode-se informar uma lista. | Nome livre | Sim | |
| Charset | Charset é a chave para definir com qual Codepage o REST irá trabalhar. | Exemplos: ASCII, UTF-8, ANSI e ISO-8859-1 | Não | UTF-8 |
| Log | Define se habilita ou não a gravação dos logs de eventos do HttpServer. | 0=Desabilitado ou 1=Habilitado | Não | 0 |
[TSSREST_CONFIG] Enable=1 Servers=TSSREST_SERVER Charset=UTF-8 Log=1 |
[TSSREST_SERVER]
Define as configurações de cada servidor HTTP e/ou HTTPS informados na sessão [HTTPSERVER] pela chave {SERVERS}.
Os nomes aqui preenchidos podem variar conforme desejado, neste caso vamos seguir tratando como [TSSREST_SERVER] apenas para exemplo.
Abaixo serão detalhadas as tags desta seção:
| TAG | Descrição | Valores Possíveis | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Port | Define a porta em que o servidor atenderá às requisições após ativado. | Campo livre | Sim | |
| URIs | Define o nome das sessões (URIs) deste servidor. O(s) nome(s) definido(s) nesta chave serão utilizado(s) na chave de URI (neste exemplo: TSSREST_URI) | Campo livre | Sim | |
| SslCertificate | Informar o path com o nome do arquivo do certificado digital, para utilização do REST com o protocolo HTTPS/SSL (caminho absoluto). | Campo livre | Não | |
| SslCertificateKey | Informar o path com o nome do arquivo com a chave do certificado digital, para utilização do REST com o protocolo HTTPS/SSL (caminho absoluto). | Campo livre | Não | |
| SslPassPhrase | Senha utilizada para autenticar o arquivo de certificado digital | Campo livre | Não | |
| protocolMin* | Configuração de protocolo de segurança mínimo a ser aplicado na configuração do REST. | SSL/TLS, TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 | Não | SSL/TLS |
| protocolMax* | Configuração de protocolo de segurança máximo a ser aplicado na configuração do REST. | SSL/TLS, TLSv1.3, TLSv1.2, TLSv1.1, TLSv1 | Não | SSL/TLS |
* Ainda não disponíveis em versão corrente.
[TSSREST_CONFIG] Enable=1 Servers=TSSREST_SERVER Charset=UTF-8 Log=1 |
ds
fds
f