O perfil Global Json é indicado para API que necessitam de autenticação para acessa-lá.
Para criar uma fonte Global Json você precisa acessar o Menu Perfil de Conexões(1).
Configuração do Perfil de Conexões
Após pesquisar sobre a api que será usada para extrair os dados e ter todas as informações de acesso necessárias siga os seguintes passos:
Na tela de perfil de conexões clique em Adicionar(1)
Preencha o campo classe de conexão com o nome “GlobalJson” exatamente dessa forma para que o Manager reconheça a sua conexão;
Em dados de conexão preencha os campos nome e tooltip (descrição para facilitar o uso) com os dados necessários para acessar sua api json.
O perfil de conexões do tipo GlobalJson utiliza o protocolo HTTP para realizar as consultas. Um Request do protocolo HTTP tem 3 informações:
- Uma Request Line
- Um Request Header
- Um Request Body
A Request Line é o único parâmetro obrigatório, ela está dividida em duas partes: o método HTTP (que pode ser apenas GET ou POST) e a localização do recurso (URL).
Os outros campos são opcionais e dependem da api json que estará sendo acessada, os dados normalmente são explicados nas documentações, onde são passadas senhas, tipo de autenticação, tokens e etc.
- O Header, ou cabeçalho da requisição, contém informações opcionais adicionais para os servidores para os quais enviamos algumas informações referentes àquela requisição.
- O Body, normalmente não é utilizado nas requisições GET. Ele é mais útil no POST. Ele recebe um json e o transforma em query-builder.
- O Filter, quando preenchido, deve receber uma string informando os níveis do json que se deseja obter, separados pelo caracter ‘&’. Por exemplo: Data&Unidades.
- O Arguments, quando preenchido, busca pelo próximo nível do filtro onde é informado os valores que se está procurando. Ele deve receber uma string informando o campo e o valor que será procurado, separados pelos sinais “==”, outros argumentos podem ser passados e também devem ficar entre o caracter “&”. Por exemplo: CodigoUnidadeAtendimento==104&CodigoUnidadeOperacional==2. Caso necessário incluir dois ou mais argumentos com o mesmo nome, mas valores é necessário separa por "||" . Exemplo: codigo==659843||codigo==875346.
Com o perfil criado, o próximo passo é criar um Canal para poder vincular a uma fonte de dados.
Para adicionar um canal, acesse o menu Canal(2) e clique em Adicionar(3)
Para criar um canal basta escolher um nome pra ele. Posteriormente ele será vinculado a uma fonte de dados.
Depois do Canal criado, acesse o menu Fonte de dados(2) e clique em Adicionar(3)
Configuração da Fonte de Dados
Depois de clicar em Adicionar, preencha os campos da seguinte maneira:
- Perfil de Conexão: Selecione o Perfil de Conexão do tipo GlobalJson que criou;
- Canal: Selecione o Canal que criou nesse passo 1;
- Nome: Informe um nome para a fonte, ex.: “Api Json”;
- url: url da api
- method: método para acessar a api
- headers: opcional
- body: opcional
- filter: opcional
Depois de ter adicionado os dados, verifique se o Manager consegue capturar as requisições clicando em "Testar Consulta". Caso volte com os dados corretos, clique em Adicionar e sua fonte de dados estará salva. Caso ela volte informando algum tipo de erro, verifique se as informações batem com a documentação.