Data Connector API

Na tela principal de Data Connectors, ao clicar no botão “Adicionar”, o sistema irá apresentar a tela para conectar uma nova fonte de dados a plataforma.

Para cada opção de Data Connector disponível na plataforma, o sistema irá apresentar alguns campos complementares para preenchimento.

Ao selecionar a opção API, será solicitado o preenchimento dos seguintes campos:

• Nome identificador do Data Connector: Informar nome que irá identificar a fonte de dados que será conectada

• Selecione o segredo para este conector de dados: Selecionar o segredo que deseja utilizar entre as opções cadastradas. Utilizaremos esse segredo para se conectar com o serviço.

• Response Data Path: Informe o path que devemos acessar na API para identificar os dados que você deseja utilizar

  • O Path deve ser separados por common.dot (.)

  • Caso a raiz da API seja o retorno, informe apenas "."

• Histórico de dados: Selecionar a opção de histórico desejado, entre as opções:

  • O Histórico Diário terá todos os dias valores que representam o dia do processamento. Exemplo, você terá dados que representam os dias 01/10, 02/10, 03/10 etc...

  • O Histórico Mensal terá dados que representam o mês do processamento. Exemplo, você terá dados que representam os meses 01/2023, 02/2023, 03/2023 etc...

• Endpoints:

  • Endpoint: Inserir o endpoint que devemos consultar

• Request Headers:

  • Chave: Inserir a chave do header

  • Valor: Inserir o valor do header

  Você pode adicionar valores programados, os possíveis valores são:

  • $token (Token gerado a partir do segredo cadastrado)

  Exemplo de utilização: "Bearer $token"

• Request Query Params:

  • Nome: Inserir o nome do parametro

  • Valor: Inserir o valor do parametro

  Você pode adicionar valores programados, os possíveis valores são:

  • $current_day (Data do dia atual (YYYY-MM-DD))

  • $start_of_month (Inínio do mês (YYYY-MM-DD))

  • $end_of_month (Fim do mês (YYYY-MM-DD))

  • $d-1 (Dia Atual - 1 Dia (YYYY-MM-DD))

  • $d-2 (Dia Atual - 2 Dias (YYYY-MM-DD))

  • $d-3 (Dia Atual - 3 Dias (YYYY-MM-DD))

• Paginação: Ao habilitar a opção de paginação, o sistema irá exibir o seguinte campo:

  • Tipo de paginação: selecionar o tipo de paginação entre as opções disponíveis