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.

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 método processo "Gerar Token de Acesso".

Um token de acesso será gerado, e para a versão 2 do Portal da Transparência, será utilizado o campo Token2.

No cabeçalho da requisição O Token gerado no campo "Token Portal Transparência V2" deverá ser enviado em todas as requisições, no header "Authorization", o token será enviado no seguinte formato: "Basic Token2"da seguinte forma: Basic token_gerado.

Parâmetros do Web Service

O web service possui 3 parâmetros, sendo dois deles obrigatórios e todos enviados via GET: