Skip to main content

Conectar via API

Conecte sua tabela a uma fonte externa (CRM, ERP, sistema próprio) para mantê-la sempre atualizada — sem cópia manual e sem código.

Quando usar

Use a integração via API quando:
  • Os dados mudam frequentemente (estoque, preços)
  • A fonte de verdade vive em outro sistema (CRM, ERP)
  • Você precisa que o Agente de IA leia dados sempre atualizados
  • Precisa importar grandes volumes em lotes paginados
Para Pipefy, há uma integração nativa mais simples — veja Sincronizar com Pipefy.

Passo a passo

1

Iniciar conexão

Em Tabelas, clique em Nova Tabela → Conectar via API → Configurar URL manualmente.
2

Configurar endpoint

CampoDescrição
URLEndpoint da API (ex: https://api.meusistema.com/produtos)
MétodoGET ou POST
HeadersJSON com headers HTTP, normalmente Authorization e Content-Type
Body Template (apenas POST)Corpo da requisição em JSON, com placeholders dinâmicos

Placeholders disponíveis no body

PlaceholderSubstituído por
{{cursor}}Cursor de paginação atual
{{since}}Timestamp ISO da última sincronização (modo incremental)
{{page}}Número da página atual
{{offset}}Offset atual
3

Mapear resposta

CampoDescrição
Response PathCaminho até o array de registros (ex: data.items, results, data.products.edges)
ID FieldNome do campo em cada objeto que será o ID externo (ex: id, sku)
O Brainchat usa o ID Field para detectar registros existentes (atualiza em vez de duplicar).
4

Configurar paginação

Escolha o tipo de paginação que sua API suporta:
TipoDescriçãoParâmetros
NenhumaAPI retorna tudo em uma resposta
CursorAPI retorna um cursor para a próxima páginacursorField, cursorParam
OffsetAPI aceita offset= e limit=offsetParam, pageSize
PageAPI aceita page=NpageParam, pageSize, totalPagesPath
Configuração extraO que faz
Page SizeQuantos registros por página
Max PagesLimite de segurança (default 100)
Total Pages PathCaminho até o total de páginas (paginação por page)
5

Definir modo de sincronização

ModoComportamento
FullRecarrega tudo. Registros que sumiram da fonte são removidos.
AppendApenas insere/atualiza. Não remove registros antigos.
IncrementalBusca só o que mudou desde a última sync (usa incrementalField).

Modo incremental

No modo incremental, defina:
  • Campo incremental — coluna na resposta que indica quando o registro foi atualizado (ex: updated_at)
  • Janela de overlap (minutos) — segurança para não perder edições no limite (default 10 min)
O Brainchat envia o timestamp da última sync no placeholder {{since}}.
6

Agendamento

Defina a periodicidade da sincronização automática:
FrequênciaQuando roda
ManualApenas quando você clica em “Sincronizar”
A cada 15 minutosA cada 15 min (mínimo recomendado)
A cada 30 minutosA cada 30 min
HourlyToda hora
Every 6hA cada 6 horas
DailyUma vez por dia (horário configurável)
WeeklyUma vez por semana (dia + horário)
Você pode definir um limite máximo de execuções (útil para sync de 1 vez por importação inicial).
7

Testar e ativar

Use Testar conexão para validar o setup. Se OK, salve. A primeira sync roda imediatamente.

Status de sincronização

O card da tabela mostra o status atual:
StatusSignificado
idleAguardando próxima sincronização
syncingSincronização em andamento
syncedÚltima sincronização concluída com sucesso
partialSync parcial — interrompida e pode ser retomada
errorFalha — verifique o erro detalhado e a configuração

Retomar carga interrompida

Se uma sync grande for interrompida (timeout, limite de páginas, erro temporário), o status fica partial e o Brainchat guarda em sync_resume:
  • Cursor da última página processada
  • Quantas páginas já foram baixadas
  • Quantos registros já foram inseridos
  • Timestamp do início
Basta clicar em Continuar sincronização que ele retoma de onde parou — sem reprocessar o que já foi feito.

Boas práticas

  • Comece com Max Pages baixo (5–10) para testar antes de liberar uma carga completa.
  • Use modo incremental sempre que a API suportar updated_at — é muito mais barato e rápido.
  • Defina Response Path com cuidado — caminho errado faz a sync retornar zero registros.
APIs externas com rate limit podem rejeitar muitas chamadas seguidas. Use Page Size razoável (50–100) e prefira modo incremental.

Próximo passo

Sincronizar com Pipefy

Integração nativa com Databases e Pipes do Pipefy — sem precisar montar a query GraphQL.