Histórico da Página
...
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 | ||
|---|---|---|
| ||
Pré-Requisitos / ParametrizaçõesNecessário habilitar os seguintes campos complementares da turma: "Publica no Portal do Regional", "Vagas gratuidgratuidade. Regimental/regulamentar", "Data inicial de matrícula", "Data final de matrícula" e , "Forma de Inscrição" e "Pré-Requisitos".
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:
|
| Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pré-Requisitos / ParametrizaçõesNenhum. Detalhamento do ProcessoForam desenvolvidas Consultas SQL para que seja possível elaborar os filtros utilizados no Portal Regional.
Para o SENAI, foram criadas as seguintes consultas:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Expandir | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pré-Requisitos / ParametrizaçõesNenhum. Detalhamento do Processo Foi criada uma consulta SQL para retorno dos dados de gratuidade que serão exibidos no Portal da Transparência. Obs.: uma única consulta foi criada para retorno dos dados no contexto do SESI e SENAI.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Expandir | title | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
...
Pré-Requisitos / Parametrizações
Nenhum.
Detalhamento do Processo
...
...
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:
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".
Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:
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.
...
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).
Exemplo do envio da requisição via Postman:
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
Histórico de versões
Data | Autor | Versão | Descrição das alterações |
|---|---|---|---|
05/10/2018 | Thiago Neiva Chagas | 1.0 | Documento inicial. |
| 07/05/2018 | Ana Carolina Eleutério Abras | 2.0 | Adicionadas informações sobre o Token - Versão 2 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas