# 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:

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FROJevUZxGMcP25tRdT12%2Fimage.png?alt=media&#x26;token=b4ba8e40-5787-4a36-8865-bac242880033" alt=""><figcaption></figcaption></figure>

* **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...

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2F1M2dTLyQnlB7ya99KXUh%2Fimage.png?alt=media&#x26;token=c9dc944e-b4ac-4481-b8e3-62696b0a86d4" alt=""><figcaption></figcaption></figure>

* **Endpoints**:&#x20;
  * **Endpoint:** Inserir o endpoint que devemos consultar

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2F1JDFwwhDc1cJPAEXkTni%2Fimage.png?alt=media&#x26;token=998a14a1-630c-4828-b3be-2028b89d7f57" alt=""><figcaption></figcaption></figure>

* **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"

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2Frd7QIC0ZPzgGHXRqNd8x%2Fimage.png?alt=media&#x26;token=0e63694e-9703-4b5e-833a-398fcca01c91" alt=""><figcaption></figcaption></figure>

* **Request Query Params**:&#x20;

  * **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))

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FLYyqI1PmWHqTIhIg8dpr%2Fimage.png?alt=media&#x26;token=c9e76e52-0a98-4987-bf21-221cf6807246" alt=""><figcaption></figcaption></figure>

* **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

<figure><img src="https://109632036-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcxn6hAOP0k8IqKSI8iRP%2Fuploads%2FciF8rKrHePD4eyWNFnmT%2Fimage.png?alt=media&#x26;token=088af7f6-57b1-4d0c-8ae2-c9d5ba6527e5" alt=""><figcaption></figcaption></figure>