API REST da Sellflux: Guia completo

O que é a API REST da SellFlux?

API é a "porta de entrada técnica" da plataforma. Em vez de um usuário clicar em botões dentro do painel, um sistema externo envia uma requisição HTTP e a SellFlux executa a ação.

Na prática, quase tudo que você faz na tela pode ser feito por API:

• Cadastrar e atualizar leads (inclusive campos personalizados)

• Disparar WhatsApp e e-mail de forma imediata

• Criar, mover, fechar e reabrir tickets e negócios

• Criar e controlar campanhas de automação

• Gerenciar dispositivos de WhatsApp, domínios, equipe e permissões

• Consultar e operar agentes de IA e a base de conhecimento

A API é REST, ou seja: você chama uma URL usando um método HTTP (GET, POST, PUT, DELETE) e recebe uma resposta em JSON.

Informações gerais

Criando o token da sua API.

Dentro da plataforma da Sellflux, acesse o menu de "Acessos rápidos".

Pesquise por "Tokens de API" e selecione a primeira opção.

Dentro da tela de tokens de API, clique no botão escrito "+ Novo Token".

Será aberta uma janela para configuração do token; nela, realize o seguinte:

1. Preencha com qual nome deseja vincular a esse token de API.

2. Selecione qual o preset de permissão que o token deve ter.

Após selecionar um preset de permissões, serão mostradas abaixo quais permissões estão inclusas nesse preset.

Caso deseje, é possível customizá-las conforme desejar.

💡 A configuração das permissões do seu token impacta diretamente nas suas requisições, por exemplo, caso queira adicionar novos leads via esse token de API, é necessário ter as permissões de ler e escrever nos Leads.

Após configurado o seu token, role a tela para baixo e clique no botão escrito "+ Criar Token".

Agora, será aberta uma janela com o seu token. Copie-o no ícone informado, pois não será possível mais visualizá-lo após fechar essa janela.

Após copiar o token e salvá-lo em um lugar seguro, feche essa janela no botão escrito "Fechar".

E pronto! O seu token foi criado com sucesso!

Como realizar a sua primeira requisição?

1. Monte o cabeçalho de autenticação:

Todas as requisições precisam dos dois headers abaixo:

Authorization: Bearer SEU_TOKEN
Content-Type: application/json

O token já identifica o projeto, então não é preciso informar o ID do projeto na maioria das chamadas.

2. Faça a primeira chamada (teste de conexão):

O teste mais simples é listar os leads do projeto:

BASH:

curl -X GET "https://apis.sellflux.app/api/v1/lead/project?page=1" \
  -H "Authorization: Bearer SEU_TOKEN"

Resposta esperada:

JSON:

{
  "data": [
    {
      "id": 98902,
      "name": "Lead 1",
      "phone": 51999999999,
      "email": null,
      "tags": ["ativo-sac", "facebook"],
      "project_id": 2465,
      "status": 1,
      "created_at": "2025-06-16T20:34:17.946Z"
    }
  ],
  "total": "2",
  "page": 1,
  "limit": 30,
  "total_pages": 1
}

Se você recebeu esse formato, a conexão está funcionando.

3. Crie o seu primeiro lead

bash

curl -X POST "https://apis.sellflux.app/api/v1/lead" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "email": "joao@empresa.com",
    "phone": "+5511999999999",
    "tags": ["novo-lead"]
  }'

A resposta traz o ID do lead criado:

JSON:

{ "id": 100025 }

Confira no painel, em Leads, se o contato apareceu com as tags corretas.

Pontos úteis do endpoint de leads:

• Todos os campos são opcionais

• Campos extras que correspondem a campos personalizados do projeto são salvos automaticamente (exemplo: "cargo": "Diretor")

• Tags são acumulativas ao criar e substituídas ao atualizar

• A exclusão é soft delete: o lead vai para status = 3 e o histórico é preservado

Mapa dos módulos disponíveis

Disparos diretos: a diferença para as automações

Os endpoints em /automation/v1 executam uma única ação imediata, sem criar fluxo. São ideais para webhooks e integrações externas.

Exemplo de envio de WhatsApp para um lead:

bash

curl -X POST "https://apis.sellflux.app/automation/v1/whatsapp/lead" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "lead_id": 1,
    "template_id": 1,
    "data": {}
  }'

Já o Flux v2 (/api/v1/flux-v2) serve para criar e controlar automações completas, com etapas e regras de entrada.

Caso deseje acessar a documentação completa, clique no botão abaixo:

Pronto! Agora você já conhece os principais recursos da API Rest da SellFlux. Com os endpoints em mãos, é possível integrar seus sistemas, automatizar processos e levar sua operação a um novo nível de eficiência.