Esta seção fornece orientações sobre como criar uma consulta REST através do módulo de Integração. Observe que, uma vez cadastrada, a URL para a consulta pode ser utilizada para criar uma consulta agregada ou camada para o mapa de integração. Para maiores informações sobre a utilização de consultas REST para montar consultas agregadas, veja o Apêndice -> Configurações para consultas agregadas -> Configuração de fontes de dados para consultas agregadas e Cadastramento de consultas agregadas. Para mais informações sobre como configurar uma consulta REST como camada, veja o Apêndice -> Camadas para o mapa de integração.
1. Acesse o módulo de Integração.
2. Clique em Consultas Agregadas.
3. Na seção Consultas Agregadas, selecione a opção Gerenciar Consultas REST.
4. Na lista de consultas, clique em Criar e selecione Serviço REST (veja abaixo).
O sistema exibe uma tela onde a consulta pode ser configurada (veja abaixo).
5. No campo Nome, insira um nome para identificar a consulta utilizando no máximo 50 caracteres.
6. No campo Descrição, fornece uma descrição para a consulta utilizando no máximo 5.000 caracteres.
7. No campo URL do Serviço, insira o endereço do serviço. Através da URL, é possível enviar alguns parâmetros utilizando o seguinte formato: http://www.servico.com.br?parametro={valor}&outroparametro={outrovalor}. Estes parâmetros são exibidos como campos que podem ser utilizados para filtrar os resultados da consulta durante sua execução.
8. No campo Método HTTP, defina se o método a ser utilizado será GET ou POST.
9. No campo Header do HTTP, insira o header do HTTP utilizado para enviar informações adicionais para o serviço. Por exemplo, através do header é possível fornecer um token para um serviço que requer autenticação conforme o exemplo a seguir: authtoken: {token}.
10. No campo JSON Path, insira o JSON path a ser utilizado para extrair parte da resposta fornecida pelo serviço. Por exemplo, para extrair todos os autores de uma resposta que contém uma lista de livros e seus autores respectivos, o JSON path seria: $.livros[*].autor.
11. Ao terminar, clique em Salvar. Para sair da operação, clique em Cancelar.
O sistema exibe uma mensagem de sucesso.