...
O objetivo deste documento é detalhar as funcionalidades da nova integração entre o SGE e o Portal da Transparência na qual ao invés de consumir métodos pré-definidos, é consumido um método que executa uma consulta previamente criada no cadastro de consultas SQL padrão do SGE.
Requisitos
Expandir |
---|
title | Req. 01 – Validação de preenchimento de campos complementares (SESI e SENAI) |
---|
|
Pré-Requisitos / ParametrizaçõesNecessário habilitar os seguintes campos complementares da turma: "Publica no Portal do Regional", "Vagas gratuidade. Regimental/regulamentar", "Data inicial de matrícula", "Data final de matrícula", "Forma de Inscrição" e "Pré-Requisitos". Dica |
---|
Para acessar o roteiro de ativação dos campos complementares, clique aqui. |
Detalhamento do Processo Foi desenvolvida uma validação customizada no cadastro de Turmas, a fim de verificar se os campos complementares foram preenchidos. A customização irá exibir uma mensagem de erro impedindo que a alteração/cadastro da turma seja realizado se o campo "Publica Portal do Regional" estiver com o valor de S (Sim) e algum dos seguintes campos estejam em branco:Se o campo "Publica Portal do Regional" estiver vazio ou com N (Não), a customização irá permitir que os registros sejam salvos, porém irá alertar com uma mensagem quais os campos complementares que foram preenchidos e que a Turma não será exibida no Portal. |
Expandir |
---|
title | Req. 02 – Consultas para criação de filtros (SESI e SENAI) |
---|
|
Pré-Requisitos / ParametrizaçõesNenhum. Detalhamento do ProcessoForam desenvolvidas Consultas SQL para que seja possível elaborar os filtros utilizados no Portal Regional. Para o SESI, foram criadas as seguintes consultas, com seus respectivos parâmetros e retorno: Consulta | Parâmetros | Retorno |
---|
Município | Coligada (Obrigatório) | CIDADE | Programa | Coligada (Obrigatório) e município (opcional) | CODMODALIDADECURSO e MODALIDADECURSO | Produto | Coligada (Obrigatório) e município (opcional) e programa (opcional) | Produto (CODSERVICOSCAE) |
Para o SENAI, foram criadas as seguintes consultas: Consulta | Parâmetros | Retorno |
---|
Município | Coligada (Obrigatório) | CIDADE | Área de Atuação | Coligada (Obrigatório) e município (opcional) | Código da Área (CODAREA) e Nome da Área (NOMEAREA) | Curso | Coligada (Obrigatório)e município (opcional) e área de atuação (opcional) | Código do Curso (CODCURSO) e Nome (NOMECURSO) |
|
Expandir |
---|
title | Web Service Consulta SQL |
---|
|
Pré-Requisitos / Parametrizações Expandir |
---|
|
title | Token - Consumo do WebService |
---|
|
Parâmetros para Geração do Token
No TOTVS Educacional, por meio do menu Transparência | Parâmetros disponível no menu "Customização", o usuário administrador efetuará a geração do Token para consumo do WebService de Consultas.
Image Removed
* Alguns regionais ainda utilizam a versão 1 do Portal da Transparência e por isso o parâmetro Token permanece na lista.
Deverão ser parametrizadas as seguintes informações:
- Usuário: Usuário do SGE que será utilizado para geração do Token que fará autenticação no RM.
- Senha: Senha do usuário do SGE que será utilizado para geração do Token que fará autenticação no RM.
Token Portal Transparência V2:
Token necessário para validar acesso aos Web Services da TOTVS nas customizações disponibilizadas pelo Departamento Nacional. Este Token é a informação do Usuário do SGE e sua senha criptografados de acordo com o modelo de autenticação disponível.
O código criptografado deverá ser enviado toda vez que for acionado algum Web Service disponibilizado pela TOTVS para as Customizações do Departamento Nacional. A customização será capaz de descriptografar o código enviado para então realizar uma tentativa de login no SGE com o Usuário e Senha utilizados para a criptografia.
Para gerar o Token é necessário executar o processo "Gerar Token" acessível pela opção "Processos" da tela de Parâmetros. O Token gerado poderá ser visualizado no parâmetro "Token Portal Transparência V2".
Image Removed
Detalhamento do Processo
Foi desenvolvido um Web Service destinado a executar consultas SQL's cadastradas no RM.
Ao realizar a instalação da customização, ele estará disponível para acesso através do serviço do RM.
Swagger
Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.
Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo: http://localhost:8080/swagger/ui/index).
Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado quando realizada a instalação do Portal RM:
Image Removed
Após isso, basta clicar com o botão direito do mouse no Website "FrameHTML" e clicar na opção "Editar ligações...". Conforme imagem abaixo, a porta seria a 8080, e o link ficaria da seguinte forma "http://localhost:8080/swagger/ui/index".
Image Removed
Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:
Image Removed
O webservice de consultas SQL é o "CstExecSQL", método "ExecutaConsultaSQL".
Segurança
Para a autenticação no Web Service, é utilizado um Token, gerado pela tela de parametrização da customização.
Para isso, o usuário deverá acessar a tela de Parâmetros, no menu "TOTVS Educacional→Customização→Parâmetros".
Após acessar a tela, preencher os campos Usuário e Senha com dados válidos para realizar um login no RM. Em seguida, executar o processo "Gerar Token".
O Token gerado no campo "Token Portal Transparência V2" deverá ser enviado em todas as requisições, no header "Authorization", da seguinte forma: Basic token_gerado.
Para maiores detalhes, acesse aqui o manual da Lib DN.Parâmetros do
Web Service
...
O web service possui 3 parâmetros, sendo dois deles obrigatórios e todos enviados via GET:
...
Os parâmetros da consulta SQL. Devem ser passados da seguinte forma:
param1=value;param2=value.
Exemplo:
codColigada=0;codArea=1
Se a consulta que será executada não possuir parâmetros, o campo será enviado sem nenhum valor.
...
Consulta SQL
...
Exemplo de uma requisição enviada para o WebService
Consulta SQL cadastrada no RM, com o código "CstTesteFiltros".
Como podemos ver na imagem abaixo, ela retorna os dados do município e tem um parâmetro (MUNICIPIO).
Image Removed
Exemplo do envio da requisição via Postman:
Image Removed
Código da requisição em HTTP
GET /rm/api/TOTVSCustomizacao/ConsultasSQL/ExecutaConsultaSQL?codColigada=0&codSentenca=CstTesteFiltros&parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz
...
Lista Códigos dos Sistemas
...
Histórico de atualização do documento
...