Esta seção fornece orientações sobre os dois tipos de fontes de dados disponíveis para uso em consultas agregadas: consultas REST cadastradas no módulo de Integração e consultas do sistema cadastradas em outros módulos e soluções.
• Consultas REST: este tipo de fonte de dado submete consultas às URLs utilizando o protocolo HTTP. Para este tipo de consulta, o parâmetro Type deve ser preenchido com "RESTService". Este tipo de consulta pode ser cadastrado na seção Gerenciar Consultas REST do módulo de Integração e depois configurado no arquivo XML. Esse método de cadastramento obriga que a consulta passe pelo processo de autenticação no sistema, e permite que a política de controle de acesso seja aplicada, além de permitir que o log de auditoria do sistema registre atividades acerca destas consultas. É importante observar que, para visualizar esse tipo de consulta em uma consulta agregada, o usuário autenticado deve ter sido incluído na sua audiência. Para maiores informações sobre como cadastrar consultas REST e definir uma audiência, veja o Capítulo 15: Integração -> Consultas agregadas -> Gerenciar consultas REST.
Os argumentos de construção que podem ser criados e as suas descrições estão listados na tabela abaixo.
Nome |
Obrigatório |
Valor Padrão |
Descrição |
url |
Sim |
- |
URL para a qual a solicitação HTTP irá apontar. |
method |
Não |
POST |
Verbo HTTP. |
headers |
Não |
Vazio |
Valores a serem inseridos no header da solicitação HTTP. Este valor deve estar no seguinte formato: name:value,name:value. |
parameters |
Não |
Vazio |
Valores fixos a serem enviados como variáveis no corpo da solicitação HTTP (quando POST é utilizado) ou no QueryString (quando GET é utilizado). Este valor deve estar no seguinte formato: name:value,name:value.
Segue abaixo um exemplo de um nó Arg preenchido para este tipo de consulta: <Arg Name="headers" Value="accept:application/json,timeout:3000" />. |
• Consultas do sistema: este tipo de fonte de dado funciona de forma similar as fontes de dados de consultas REST. Porém, antes de executar a solicitação HTTP para a API, a autenticação é realizada e um token de autenticação é obtido. Para este tipo de consulta, o parâmetro Type deve ser preenchido com "RMAPI".
Para autenticar e buscar dados do sistema, esse tipo de fonte de dado requer a edição das seguintes chaves no arquivo web.config:
Nome |
Obrigatório |
Descrição |
ClientID |
Sim |
ID gerado para o módulo de Integração quando foi cadastrado como uma aplicação autorizada no módulo Administração. |
ClientSecret |
Sim |
Chave secreta gerada para o módulo de Integração quando foi cadastrado como uma aplicação autorizada no módulo Administração. |
O seguinte argumento de construção também deve ser editado no arquivo:
Nome |
Obrigatório |
Descrição |
url |
Sim |
URL para a API do Módulo Risk Manager. |