Histórico da Página

Pré-Requisitos / Parametrizações

Nenhum.

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.
Segue abaixo um exemplo de retorno do método da consulta com a descrição e valores de todos os campos retornados.

Pré-Requisitos / Parametrizações

Nenhum.

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:

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:

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&amp;codSentenca=CstTesteFiltros&amp;parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Lista Códigos dos Sistemas

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.

Image Removed