Consulta API

Sumário

1. Conceito

Através desta funcionalidade o sistema disponibiliza uma API do tipo REST que retorna consultas ao banco de dados.

2. Funcionalidades

2.1 Listagem de Consulta APIs

A tela de listagem exibe todas as Consulta APIs do ambiente, permitindo que os usuários visualizem o Nome do Método (equivalente ao endpoint gerado para a chamada da integração), última data de modificação, indicador de integração ativa e os parâmetros de URL que podem ser enviados.

Na aba de ações é possível chamar a URL do endpoint, ir para a tela de edição, deletar o registro, exportar (para backups ou migração) ou navegar para a tela de monitoramento da integração.

2.2 Criando uma Consulta API

Campos disponíveis e suas respectivas funcionalidades:

• Nome do método: Identificador do endpoint;
• Banco de dados: Registro do CadastroDB no qual a consulta vai ser executada;
• Fila de integração: Contexto de execução dentro do ambiente, escopo de filas de processamento;
• Parâmetros de URL: Valores que podem ser utilizados para alimentar a consulta dinamicamente com parâmetros de URL;
• Ativo: Define se o endpoint pode ser chamado;
• Campo de SQL: Define a query SQL que vai ser processada pelo banco-de-dados. Pode receber os valores dos Parâmetros de URL com a sintaxe de replace dedicada ( :nomeParametro ).
• Autorização: Define um cabeçalho de Authorization no endpoint que serve como uma chave-de-uso para que o mesmo não seja disponibilizado de forma aberta.
• Tipo de Autorização do Serviço Web: Nenhum (público), Bearer (código fixo) ou Basic Auth (associado a um registro de Credencial da plataforma);
• Token de Autenticação: Token ou Credencial a ser associado ao Tipo de Autorização do Serviço Web.

2.3 Chamando uma Consulta API

A URL para chamada da ConsultaAPI pode ser obtido após realizar um teste de API, já com os parâmetros de URL indicados (caso tenham sido definidos):

O endpoint gerado pelo CONNECT tem o formato HOST/AMBIENTE/FUNCIONALIDADE/IDENTIFICADORES, para o exemplo:

Exemplo de chamada com Autorização