INTERAFLOW.ai
DocsPreços
FeatureFuncionalidade · API pública

Mesmos recursos da UI, agora em REST.

Voz, WhatsApp, chatbot, campanhas, conversas, relatórios, usuários. Conheça os caminhos de integração e comece pelos guias de credenciais, webhooks e canais. Confirme o contrato dos endpoints e os recursos disponíveis no seu ambiente antes de implementar.

Ver guias de integração
  • Guias públicos
  • 14 dias grátis
  • Sem cartão pra testar o endpoint
Hello, Interaflow · curlPOST /v1/messages
curl -X POST https://api.interaflow.com.br/v1/messages \
  -H "Authorization: Bearer $IF_TOKEN" \
  -H "Idempotency-Key: 9f2b-4821" \
  -d '{
    "to": "+5511998887777",
    "channel": "whatsapp",
    "template": "order_update",
    "vars": { "nome": "Ana", "pedido": "#4821" }
  }'
# → 201 Created  { "id": "msg_01HN...", "status": "queued" }

  • API · GA

    v1 estável

  • Guias técnicos

    Credenciais · webhooks · canais

O que é uma API de contact center

Uma API de contact center é a superfície programática que permite ao seu time técnico fazer tudo que a interface do atendimento faz — sem abrir a interface. Criar campanha, disparar mensagem, consultar conversa, pedir transcrição, abrir ticket, mover contato de fila, extrair relatório: cada ação vira uma chamada HTTP autenticada, com resposta estruturada e auditável.

A diferença entre uma CCaaS integrável e uma CCaaS com API é cobertura. Muita plataforma publica uma API que serve só pra disparar mensagem de WhatsApp ou consultar saldo — quem quer automatizar o restante (campanhas, fluxos, classificação, fila) precisa abrir a UI. A proposta da Interaflow é que a API cubra a operação inteira, na mesma granularidade da UI.

Quando faz sentido ir pela API em vez da UI

Três situações em que começar pela API paga mais do que começar pela tela:

  1. Seu produto já é o contato com o cliente. App de entrega, marketplace, fintech: o atendimento precisa viver dentro do fluxo do produto, não num painel separado. Você chama a API quando faz sentido no fluxo — criar conversa na hora que o pedido atrasa, enriquecer o contato quando ele entra no funil.
  2. Você tem CRM/ERP caseiro ou muito customizado. Em vez de treinar o atendente pra abrir dois sistemas, sua integração joga o contexto do CRM na chamada da API e vice-versa. O atendente só vê uma tela — a sua.
  3. Operação com volume alto de dados sensíveis. Você prefere que a mensagem, a transcrição e o evento da chamada nunca passem por tela humana desnecessária — a API entrega direto no seu pipeline (data warehouse, CRM, compliance).

API-first, UI-segundo (ou ao lado)

Na prática, a maioria dos clientes Interaflow usa as duas juntas: atendentes humanos operam pela interface; integração, automação e relatórios rodam pela API. A promessa é que tudo que o supervisor viu na tela, seu backend pode consumir via JSON — mesma semântica, mesmo SLA. E quando você quer estender o atendimento (adicionar uma fonte de dado à conversa, acionar uma ferramenta externa durante o diálogo), o caminho recomendado é o nó MCP no flow builder, não uma integração out of band.

Quickstart

Hello, Interaflow

Mesma chamada — disparar uma mensagem de WhatsApp — em quatro linguagens. Copie o que o seu stack preferir e troque o token pelo seu. npm/pip/go get opcional: todos os exemplos rodam com biblioteca HTTP padrão.

curl -X POST https://api.interaflow.com.br/v1/messages \
  -H "Authorization: Bearer $IF_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 9f2b-4821" \
  -d '{
    "to": "+5511998887777",
    "channel": "whatsapp",
    "template": "order_update",
    "vars": { "nome": "Ana", "pedido": "#4821" }
  }'

Os quatro exemplos produzem exatamente a mesma chamada. A API é a verdade canônica, não o SDK. Configurar credenciais → · Guia de webhooks →

Superfícies

Quatro superfícies. Uma API.

Não existe "uma API" só — existe uma API composta. A REST é a porta oficial, o Outbox é como a Interaflow avisa o seu sistema, o MCP é como um agente de IA pede contexto, e o SDK/CLI é açúcar em cima disso.

  • REST · HTTP

    REST

    POST /v1/messages · GET /v1/conversations

    Você chama a Interaflow. Criar, ler, atualizar, deletar recursos — campanhas, mensagens, contatos, conversas, relatórios.

    Quando usar

    Ação síncrona — disparo de mensagem, consulta de relatório, mudança de fila.

    Atenção

    Chamadas síncronas dependem da sua latência + a nossa. Pra alto volume, combine com idempotency-key + backoff.

  • GA · retry + DLQ

    Outbox (webhooks)

    event: call.ended · conversation.closed · message.received

    A Interaflow chama o seu endpoint. Eventos de chamada, conversa, mensagem e classificação — entregues com HMAC e backoff.

    Quando usar

    Reação assíncrona — "quando uma chamada termina, manda o CDR pro meu data warehouse".

    Atenção

    Seu endpoint precisa ser idempotente — a Interaflow retransmite em falha (retry + DLQ).

  • consumo GA · server roadmap

    MCP

    nó `mcp` no flow builder · tools/list, tools/call

    Um LLM (agente seu ou nosso) pede contexto estruturado durante uma conversa. Chama ferramenta externa via nó `mcp` no flow builder.

    Quando usar

    Estender o atendimento com fonte de dado ou ferramenta externa sem sair do fluxo conversacional.

    Atenção

    Protocolo novo (spec Anthropic, 2025). A Interaflow consome MCP via nó do flow builder hoje; expor a Interaflow como MCP server está no roadmap.

  • SDKs oficiais em roadmap

    SDK / CLI

    Clientes HTTP do seu stack

    Organize autenticação, paginação e tratamento de erros no cliente HTTP da sua aplicação.

    Quando usar

    Você quer encapsular as chamadas HTTP e reutilizar a integração no seu stack.

    Atenção

    Confirme o contrato dos endpoints no seu ambiente antes de implementar. Os guias publicados não substituem uma especificação da API.

Recursos

O que a API entrega, além dos endpoints

Endpoint é commodity. O que diferencia é o que tem em volta — auth, idempotência, observabilidade, retry, versionamento. Tudo abaixo é nativo, sem serviço pago por fora.

Autenticação JWT com escopo e expiração

Auth via JWT — Bearer token no header Authorization. Tokens têm expiração configurável por tenant e escopo (leitura, escrita, admin). Emissão via painel ou POST /v1/auth/token. Credenciais de canal (WhatsApp, SIP, CRM) com criptografia Fernet — a API nunca devolve secret em claro.

Emissão de token com escopo explícitohttp
POST /v1/auth/token
{ "grant_type": "client_credentials",
  "scope": "messages:write conversations:read" }
→ 200 OK
{ "access_token": "eyJhbGci...",
  "expires_in": 3600,
  "scope": "messages:write conversations:read" }

Idempotency-Key nativa em writes

24h de retenção

Todo POST e PATCH aceita header Idempotency-Key. Se a mesma key chegar duas vezes em até 24h, a Interaflow devolve a mesma resposta da primeira — sem executar de novo. Resolve o clássico "meu job falhou após o envio mas antes do ack".

Retry seguro em writeshttp
POST /v1/messages
Idempotency-Key: 9f2b-4821
→ 201 Created    (primeira chamada)

POST /v1/messages
Idempotency-Key: 9f2b-4821
→ 200 OK  X-Idempotent-Replay: true   (segunda chamada)

Outbox pattern pros seus webhooks

retry + DLQ · HMAC assinado

Quando um evento acontece (chamada terminou, conversa foi fechada, mensagem chegou, classificação mudou), a Interaflow empilha em uma outbox interna e chama o seu endpoint — com assinatura HMAC no header X-Interaflow-Signature, body JSON normalizado e política de retry com backoff exponencial + DLQ pra eventos que falharem após N tentativas. Você não perde evento — e não precisa montar fila no seu lado.

Entrega garantida, não bloqueantetext
[evento: call.ended]
       ↓
[outbox] → POST https://seu-app.com/hooks
       ↓ falha
[retry · 5x · backoff exp.]
       ↓ ainda falha
[DLQ] → alerta no painel

Guias pra preparar sua integração

Consulte como criar credenciais, configurar webhooks de entrada e conectar canais. Esses guias descrevem configurações e limites conhecidos; não são um console interativo nem uma especificação completa dos endpoints.

Começar pelo guia de chaves de API →

Versionamento /v1 e deprecação com lead time

A API é versionada por prefixo (/v1, /v2 no futuro). Breaking changes não entram em /v1 — viram /v2 com pelo menos 6 meses de lead time. Campos novos são aditivos; deprecações ganham header X-Interaflow-Deprecation com a data de sunset.

  1. v1 (hoje)

    API estável · GA

  2. v1.x

    Campos aditivos · sem breaking

  3. v2 (+6m)

    Lead time mínimo · X-Interaflow-Deprecation nos endpoints v1

Observabilidade no seu lado

Cada resposta traz X-Request-Id (correlacionável no log da Interaflow). Suporte a W3C Trace Context (traceparent) pra você correlacionar a chamada com o trace do seu backend. Rate limits retornam X-RateLimit-Remaining e Retry-After — sem surpresa de 429.

Headers que você correlaciona no seu APMhttp
HTTP/1.1 200 OK
X-Request-Id: req_01HN3ZV...
X-RateLimit-Remaining: 58
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01

Matriz de decisão

Por onde começar a integração?

Três caminhos que cobrem a maioria dos casos dev. Se a sua situação não está aqui, tem um quarto recorte no CTA do fim da página.

01Outbox primeiro

Migração gradual — UI primeiro, API depois

Pra quem
Operações que entraram pela UI e querem começar a puxar dados pro data warehouse e pro CRM.
Como funciona
Configura outbox webhook pra eventos de chamada e conversa → joga em S3/BigQuery/Snowflake via seu pipeline existente. REST entra quando surge o primeiro caso de orquestração.
Bom
Sem troca de UI. Sem parar operação. Outbox como primeira superfície.
Atenção
Você ainda precisa que seu pipeline consuma o payload normalizado — planeje o contrato de evento antes de ligar.
02

Integração profunda — API-first desde o dia 1

Pra quem
Produto que já é o contato com o cliente (app, marketplace, fintech). O atendimento vive dentro do fluxo do seu produto.
Como funciona
CRUD de contatos e conversas via REST, webhook pra cada evento relevante, JWT com rotação programada. Time humano usa a UI só pra supervisão ao vivo.
Bom
Uma tela pro atendente (a sua). Toda automação e enriquecimento em código do seu lado.
Atenção
Exige engenharia própria pra cuidar de integração, observabilidade e rotação de credencial.
03MCP

Extensão via MCP — agentes de IA consumindo contexto

Pra quem
Você tem base de conhecimento, sistema de cotação, API de saldo — e quer que o agente de voz ou WhatsApp chame durante a conversa.
Como funciona
Expõe seu serviço como MCP server (padrão Anthropic, 2025) → adiciona o nó `mcp` no flow builder apontando pro seu endpoint → o agente usa a ferramenta como contexto no turno.
Bom
Bom encaixe com saúde, jurídico, financeiro — onde o agente precisa consultar antes de responder.
Atenção
Expor a Interaflow como MCP server (pra LLMs externos) ainda não é GA — está no roadmap.

Vale combinar com CRM, URA e integrações nativas onde fizer sentido. Pra integrar WhatsApp direto na camada API, ver /whatsapp/api.

A documentação é o próximo clique

Guias de credenciais, webhooks e conexão dos canais. Leia os pré-requisitos e confirme o contrato dos endpoints do seu ambiente com a equipe.

Guias de integraçãoDocumentação
Chaves e escopos
Credenciais
Configuração de entrada
Webhooks
Conexão e roteamento
Canais
Explorar os guias

Leitura pública, sem login. Estes guias não são um console de testes da API.

FAQ

Perguntas que o time de engenharia faz

Começar

14 dias

pra auditar a API inteira sem cartão

Pega uma API key. Roda um curl. Decide.

14 dias pra testar a API inteira sem cartão: emite token, dispara mensagem, configura webhook, chama relatório. Se a cobertura não for a que a gente promete, você sai sem fricção. Se for, migra o restante do produto pra cá.

Ver guias de integração

14 dias. Sem cartão. Guias públicos pra conhecer a configuração antes de criar conta.