...
Para isso basta informar as seguintes seções e tags chaves no arquivo de appserver.ini do TSS.
...
Aqui serão detalhadas todas as seções e tags possível chaves possíveis de serem configuradas para um maior controle do(s) servidor(es) e serviço(s) de REST do TSS REST SERVER.
Para para um melhor entendimento, serão quebradas por seções a serem incluídas no appserver.ini do TSS.
...
Abaixo serão detalhadas as tags chaves desta seção:
TAGChave | Descrição | Valores Possíveis | Obrigatório | Valor padrão |
---|---|---|---|---|
Enable | Responsável por habilitar ou desabilitar a subida/criação do TSS REST SERVER (HTTPSERVER). | 0=Desabilitado ou 1=Habilitado | Não | 1 |
Servers | Nome das seções de servers com configuração de porta e URL. Por ela é possível definir um ou mais servidores, sendo assim, pode-se informar uma lista. Como exemplo será adotado o nome TSSREST_SERVER. | Nome livre | Sim | |
Charset | Chave para definir com qual Codepage que será configurado no REST. | 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. Para mais detalhes | 0=Desabilitado ou 1=Habilitado | Não | 0 |
...
Abaixo serão detalhadas as tags chaves desta seção:
TAGChave | 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 usaremos: 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 |
...
Através da URIs
...
Abaixo serão detalhadas as tags chaves desta seção:
TAGChave | 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 RESTservidor 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 RESTservidor 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 |
...
Abaixo serão detalhadas as tags chaves desta seção:
TAGChave | 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 |
...
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) serviçoservidor(ses) de REST do TSS REST SERVER, conforme imagens a seguir:
...
Cada URL poderá ser informado como endereço de URL em um browser/navegador, para verificação da disponibilidade do serviço de REST do(s) servidor(es) do TSS REST SERVER:
Âncora | ||||
---|---|---|---|---|
|
...