Configurando o serviço REST via APWebWizard / SRVWizard
O APWebWizard ou SRVWizard é responsável por fazer as atualizações no seu arquivo "appserver.ini" de acordo com sua necessidade para a criação dos mais diversos serviços. Para iniciarmos, conforme imagem abaixo, realize a chamada via smartclient para o seu ambiente desejado:
1) Configurando serviço HTTP.
Inicialmente, caso ainda não possua um serviço HTTP, precisaremos criá-lo, como no exemplo da imagem abaixo:
Informando uma pasta do servidor com o caminho para os serviços Web, a porta do HTTP, o ambiente a ser utilizado e a opção de "Protocolo habilitado" marcada.
Após finalizar essa configuração, encontraremos as seguintes tags no arquivo "appserver.ini":
[HTTP] |
|---|
Importante
- PATH
Apontamos para a PATH da pasta web localizada dentro da estrutura da system, pois outros portais como Portal Gestão Capital Humano e Portal do Candidato necessitaram utilizar as mesmas localizações de path para criação de seus arquivos.
- COMPRESSION
Solicitamos a inclusão manual da configuração para compressão GZIP no servidor HTTP, conforme exemplo abaixo, disponível em builds superiores a 7.00.131227A.
Essa funcionalidade permite ao servidor realizar automaticamente a compressão dos arquivos antes se serem enviados ao requisitante, permitindo que os arquivos trafegados tenham o seu tamanho reduzido durante o seu download, otimizando o tempo de carregamento inicial do aplicativo. Os arquivos comprimidos são descompactados pelos browsers antes de sua utilização!
Valores válidos para a tag "COMPRESSION"
Valor | Descrição |
|---|---|
0 | Desabilitado (padrão) |
1 | Habilitado |
Para mais conhecimentos sobre as tags que você poderá inserir segue um documento de referência TOTVSTEC - Arquivos de Configuração.
2) Configurando serviço REST.
Nessa fase vamos habilitar o serviço REST no server Protheus:
Escolha a opção REST do menu, em seguida o item HTTPV11 e clique no botão "editar configurações". Precisaremos efetuar as configurações na parte superior (Configuração de Sockets) e inferior (Configuração de URIs).
Configuração de Sockets, preencha:
- Marque a opção de "Habilitado".
- Preencha o Nome → HTTPREST
- Preencha Porta → De própria escolha, no exemplo abaixo usamos 9191.
- Marque item "Autenticação".
Configuração de URIs, preencha:
- Preencha o Nome → preferencialmente HTTPENV.
- URL → obrigatório ter a expressão inicial "/rest", posteriormente a essa expressão pode complementar, por exemplo, com o identificador da sua empresa "/rest01" ou "/restT1".
- Empresa/Filial para preparação de ambiente → em geral informamos apenas o código da empresa, consequentemente, todas as filiais pertencentes serão atendidas.
- Mínimo de Working Threads Ativas, Máximo de Working Threads Ativas, Mínimo de Working Threads Livres, Quantidade de Working Threads de Incremento (dependendo da quantidade de licenças de uso pode ser ajustado)
- Habilitar Cors → deve estar marcado.
- Allow Origin → preenchido com * (asterisco)
- Endpoints Públicos → deverá estar preenchido com as informações: fwjwt/refresh_token,auth
Após finalizar essa configuração, encontraremos as seguintes tags no arquivo "appserver.ini":
[HTTPV11] [HTTPREST] [HTTPENV] |
|---|
Endpoints Públicos
Os endpoints públicos são APIs não exigem autenticação para que o server Protheus possa responder qualquer requisição!
Por exemplo, as APIs do MeuRH que pertencem aos processos de autenticação, visto que são nelas que os nossos serviços realizam as identificações e geração do token para que todas as APIs que necessitam de identificação possam ser executadas.
Nas informações acima, foram solicitados que estejam liberadas de autenticação as APIs:
- fwjwt/refresh_token
- auth
Complementando a informação, ao informar "auth" estamos liberando todos os endpoints desse serviço, que basicamente seria o mesmo que informar manualmente todos os métodos existentes até o momento, por exemplo:
- auth/login, auth/logout, auth/isLogged, auth/isFirstLogin, auth/renewPassword, auth/resetPassword, auth/ChangePassWithLastPass
Você pode optar por informar manualmente ou todos de uma única vez!
Dica interessante
É recomendado utilizar um servidor Protheus (AppServer) apenas com os serviços REST, sem a necessidade de configurar os outros jobs e webservices do padrão webex/soap referente ao portal tradicional Gestão do Capital Humano.
O aplicativo MeuRH utiliza somente serviços REST em sua utilização, sendo assim, permite a flexibilidade da criação de servidores separados, podendo, caso necessário, reinicializar um server sem prejudicar o outro!
Caso o cliente utilize licenças do tipo OnDemand, faz-se necessário informar de qual módulo as licenças serão consumidas. Essa informação deverá constar dentro do bloco [HTTPENV]. Abaixo um exemplo
[HTTPENV]
MODULE=7
3) Configurando processo HTTPJOB.
Neste passo, iremos configurar o processo comum que criará um "JOB" para inicializar o serviço do REST criado anteriormente:
Como na imagem abaixo, devemos informar:
- Nome do Job
- Ambiente
- Função Advpl → informar o nome da função que inicializa o serviço, obrigatoriamente: HTTP_START
- Habilitar job no start do servidor Protheus → marcar opção
Após finalizar essa configuração, encontraremos as seguintes tags no arquivo "appserver.ini":
[HTTPJOB] [ONSTART] |
|---|
4) Carregando serviço REST
Após essas configurações do serviço REST, podemos reiniciar o server e identificar na imagem abaixo a inicialização dos serviços:
