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
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 |
Port=1322 URIs=TSSREST_URI Security=1 protocolMin=TLSv1.0 protocolMax=TLSv1.3 SslCertificate=C:\certificados\https_rest\cert_rest.crt SslCertificateKey=C:\certificados\https_rest\cert_rest.pem SslPassPhrase=123456 |
[TSSREST_URI]
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 |
|---|---|---|---|---|
| URL | URN do site | Texto livre | Não | / |
| RootPath | Diretório onde estão armazenados os arquivos do site, pode ser informado como um path absoluto ou relativo ao diretório onde o servidor de aplicações executa | Texto livre | Não | ROOTPATH do TSS + '\http-root\tssrest\' |
| DefaultPage | Páginas iniciais que serão inicializadas no acesso a URL. Podem ser informadas várias páginas separados por espaço. Podem ser definidas mais de uma página default separados pode vírgula (,) | Texto livre | Não | index.html |
| Instances | Indica o controle de thread pool disponíveis para atender as requisições de APIs no TSS REST SERVER, em formato P1,P2,P3,P4. Onde: P1 = Indica a quantidade mínima de threads ativas no thread pool. Deve ser maior que zeros. P2 = Indica a quantidade máxima de threads ativas no thread pool. Deve ser maior ou igual que P1. P3 = Indica a quantidade mínima de threads prontas para execução no thread pool. Deve ser positivo e menor ou igual a P1. P4= O fator de crescimento, indica a quantidade de threads a serem alocadas. Deve ser maior que zero. | Mínimo, Máximo, Mínimo Livre, Fator Crescimento | Não | 1,4,1,1 |
| CORSEnable | Habilita utilização de controle de CORS | 0=Desabilitado ou 1=Habilitado | Não | 1 |
| AllowOrigin | Define lista de domínios permitidos para acessar as APIs do serviço REST. Exemplo: https://www.dominio.com.br/, https://10.172.0.84:1081/, http://localhost:1080/ | *=Para liberar todos os domínios ou texto livre com os domínios separados por virgula. | Não | * |
| AllowMethods | Define lista de métodos HTTP permitidos para acessar as APIs do serviço REST | GET,POST,PUT,DELETE,PATCH,OPTIONS,HEAD | Não | GET,POST,PUT,DELETE,PATCH,OPTIONS,HEAD |
| ExpirationTime | É o tempo em segundos que a thread aguarda uma nova requisição. Se expirado a thread retorna a aguardar uma requisição ou finalizara conforme análise dos controles da quantidade de threads. O valor deve se maior que zero se não for informado o sistema assume o valor padrão. | Não | 60 | |
| AcceptTimeOut | É o tempo em segundos que uma nova requisição aguarda para ser processada. Se expirado a requisição é descartada e o cliente sairá por timeout. O valor deve se maior que zero se não for informado o sistema assume o valor padrão. | Não | 10 |
[TSSREST_URI] URL=/rest/tss RootPath=C:\tss\http-root\httprest\httpuri\ DefaultPage=index.html Instances=1,10,2,1 CORSEnable=1 AllowOrigin=* AllowMethods=POST,GET,DELETE,UPDATE ExpirationTime=120 AcceptTimeOut=10 |
[JOBTSSREST]
Esta seção define a configuração do JOB responsável por criar o(s) serviço(s) do TSS REST SERVER.
O nome desta seção pode variar conforme desejado, neste caso vamos seguir tratando como [JOBTSSREST] apenas para exemplo.
Abaixo serão detalhadas as tags desta seção:
| TAG | Descrição | Valores Possíveis | Obrigatório | Valor padrão |
|---|---|---|---|---|
| main | Nome da função a ser executada. Neste caso deve ser preenchido sempre com: TSSREST_START | TSSREST_START | Sim | |
| environment | Nome do ambiente onde será executado o TSS REST SERVER. Normalmente o mesmo nome do ambiente configurado para o TSS. Exemplo: SPED | Texto livre | Sim |
[JOBTSSREST] main=TSSREST_START environment=SPED |
Com o appserver.ini devidamente configurado ao inicializar o appserver.exe do TSS, após mais ou menos 10 segundos da inicialização, serão impressos alguns logs no arquivo console.log informando o status da criação do(s) serviço(s) de TSS REST SERVER, conforme prints que seguem:
2. Indicativo da(s) URL(s) do(s) TSS REST SERVER criado(s):
3. Cada URL poderá ser informado como endereço de URL em um browser/navegador, para verificação da disponibilidade do serviço de TSS REST SERVER:
