---
title: Fontes via API
slug: aura/fontes-via-api
createdAt: 2026-11-19T14:33:14.626Z
---

Uma **fonte via API** é uma lista de destinatários que vem de um sistema externo — o CRM, o ERP, o sistema de protocolos — buscada **na hora do disparo**. Serve para campanha que se repete ("todo dia às 8h, quem venceu ontem") sem ninguém subir planilha. Fica em **Contatos › Fontes via API**.

## Criar uma fonte

**Nova fonte** tem três passos.

### 1. Conectar

Nome, **URL da API**, método (GET/POST) e a **autenticação** (sem, usuário e senha, token Bearer, header customizado, query string ou **login e token**: a plataforma faz o login com usuário e senha a cada busca e usa o token que a API devolve — é o caso de APIs cujo token vence em uma hora). Token e senha ficam guardados cifrados; headers extras não sensíveis vão numa caixa própria. **Testar conexão** faz uma chamada só e mostra o código HTTP, onde está a lista na resposta e os campos encontrados.

:inlineImage[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/hfzlxA-jNeMQjfiBee9QG_f094abc7cd6843244110774fc48390a9.jpg" alt="Conexão OK · respondeu 200 · lista em $.contacts · 2 campos" caption size="160" width="1600" height="1000"} *Conexão OK · respondeu 200 · lista em $.contacts · 2 campos*

### 2. Modelo

**Vincular a um modelo** (recomendado): escolha o fornecedor e o template — a fonte passa a carregar as variáveis dele. Ou **pular** e declarar variáveis livres. A **etiqueta** vai para os grupos que cada busca gera.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/BjMsqVMXw02qc0dOENWpQ_5340f42a98f4c8d044fec690eb4f5e89.jpg" size="160" alt="Passo Modelo da nova fonte, com fornecedor, template e etiqueta" isUploading="false" initialPath="../images/5340f42a98f4c8d044fec690eb4f5e89.jpg" githubPath="images/5340f42a98f4c8d044fec690eb4f5e89.jpg" width="1600" height="1000" showCaption="false"}

### 3. Mapear

Onde está a **lista de registros** na resposta (`$.contacts`, ou `$` se a resposta já é a lista), qual campo é o **telefone**, o **nome**, o **identificador na origem** (para não repetir contato e confirmar o consumo) e a **etiqueta por contato**. Os campos descobertos no teste são clicáveis. **Ajustes avançados**: agenda, paginação e limites. **Pré-visualizar resultado** busca uma página e mostra como os contatos ficariam.

:inlineImage[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/CkvhYwrLsfuQ_F97FtBiq_8ec88618dc4ad95be71edbdeb04bd257.jpg" alt="Clique num campo descoberto ou escreva o caminho" caption size="160" width="1600" height="1000"} *Clique num campo descoberto ou escreva o caminho*

## O cartão da fonte

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/-88F0g5-iFbXwYULz63fR_63708c8cf6afe7db16f1af2d9164738a.jpg" size="160" alt="Cartão da fonte em Contatos › Fontes via API, com Buscar agora, Execuções e Editar" isUploading="false" initialPath="../images/63708c8cf6afe7db16f1af2d9164738a.jpg" githubPath="images/63708c8cf6afe7db16f1af2d9164738a.jpg" width="1600" height="1000" showCaption="false"}

- **Buscar agora** — chama a API e monta um grupo com quem ela devolver. Nada é enviado.
- **Execuções** — cada busca: quando, gatilho (na mão, agendada ou pela campanha), recebidos, válidos, inválidos, duplicados, inseridos, e o que houve.
- **Editar**, **Desativar/Ativar** (fonte desativada não pode ser usada em campanha nova) e excluir.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/UsAZAahEDV_ua6PFXP_2e_ff5cb68765ece876c8a7b12016d294ff.jpg" size="160" alt="Janela Execuções da fonte, com uma linha por busca" isUploading="false" initialPath="../images/ff5cb68765ece876c8a7b12016d294ff.jpg" githubPath="images/ff5cb68765ece876c8a7b12016d294ff.jpg" width="1600" height="1000" showCaption="false"}

## Usar numa campanha

Em **Para quem**, escolha **Fonte via API** e a fonte. No lançamento a plataforma busca os contatos na origem, monta a lista e dispara. Em campanha que se repete, cada execução busca de novo — é o ponto da fonte.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/JQwZlSRoG9Kc5h9Rroj7F_0dfae155eca08370d4785ce33d72ad66.jpg" size="160" alt="Passo Para quem da nova campanha com uma fonte via API escolhida" isUploading="false" initialPath="../images/0dfae155eca08370d4785ce33d72ad66.jpg" githubPath="images/0dfae155eca08370d4785ce33d72ad66.jpg" width="1600" height="1000" showCaption="false"}
