API Reference

Bem-vindo à documentação da API da Interflow.

EM ATUALIZAÇÃO

Esta documentação está em fase de atualização contínua. Novos endpoints são documentados regularmente.

Visão Geral

A API da Interflow permite que você integre e automatize funcionalidades da plataforma em suas aplicações.

Base URL

https://api.interflow.chat/v1

Ambientes

Ambiente	URL
Produção	https://api.interflow.chat/v1
Sandbox	https://sandbox.api.interflow.chat/v1

Autenticação

A API utiliza API Keys para autenticação. Inclua sua chave no header de todas as requisições:

curl -X GET "https://api.interflow.chat/v1/customers" \
  -H "Authorization: Bearer sua_api_key_aqui" \
  -H "Content-Type: application/json"

Obtendo sua API Key

1. Acesse Configurações → API Keys
2. Clique em "Gerar nova chave"
3. Dê um nome descritivo
4. Copie e guarde em local seguro

IMPORTANTE

Sua API Key é secreta. Nunca exponha em código frontend ou repositórios públicos.

📸

Screenshot: Gerenciamento de API Keys

Formato de Resposta

Todas as respostas são em JSON:

Sucesso

{
  "success": true,
  "data": {
    // dados da resposta
  },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

Erro

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O campo 'email' é obrigatório",
    "details": [
      {
        "field": "email",
        "message": "Campo obrigatório"
      }
    ]
  }
}

Rate Limiting

A API possui limites de requisições por minuto:

Plano	Limite
Starter	60 req/min
Professional	300 req/min
Enterprise	1000 req/min

Headers de resposta indicam seu limite:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1640995200

Endpoints Principais

Mensagens

Método	Endpoint	Descrição
POST	/messages/send	Enviar mensagem
POST	/messages/bulk	Enviar em massa
GET	/messages/:id	Buscar mensagem

Clientes

Método	Endpoint	Descrição
GET	/customers	Listar clientes
POST	/customers	Criar cliente
GET	/customers/:id	Buscar cliente
PUT	/customers/:id	Atualizar cliente
DELETE	/customers/:id	Excluir cliente

Chats

Método	Endpoint	Descrição
GET	/chats	Listar chats
POST	/chats	Criar chat
GET	/chats/:id	Buscar chat
GET	/chats/:id/messages	Mensagens do chat

Webhooks

Método	Endpoint	Descrição
GET	/webhooks	Listar webhooks
POST	/webhooks	Criar webhook
DELETE	/webhooks/:id	Excluir webhook

Exemplo: Enviar Mensagem

Request

curl -X POST "https://api.interflow.chat/v1/messages/send" \
  -H "Authorization: Bearer sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_id": "uuid-do-canal",
    "to": "5511999999999",
    "type": "text",
    "content": {
      "text": "Olá! Esta é uma mensagem via API."
    }
  }'

Response

{
  "success": true,
  "data": {
    "id": "msg_abc123",
    "status": "sent",
    "channel_id": "uuid-do-canal",
    "to": "5511999999999",
    "type": "text",
    "content": {
      "text": "Olá! Esta é uma mensagem via API."
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Exemplo: Criar Cliente

Request

curl -X POST "https://api.interflow.chat/v1/customers" \
  -H "Authorization: Bearer sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "5511999999999",
    "tags": ["vip", "newsletter"],
    "custom_fields": {
      "empresa": "Empresa XYZ",
      "cargo": "Gerente"
    }
  }'

Response

{
  "success": true,
  "data": {
    "id": "cust_xyz789",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "5511999999999",
    "tags": ["vip", "newsletter"],
    "custom_fields": {
      "empresa": "Empresa XYZ",
      "cargo": "Gerente"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

SDKs e Bibliotecas

EM DESENVOLVIMENTO

SDKs oficiais estão em desenvolvimento:

• Node.js/JavaScript - Em breve
• Python - Em breve
• PHP - Em breve

Seções da API

💬

Mensagens

Envio e gerenciamento

👥

Clientes

CRUD de clientes

🔗

Webhooks

Eventos em tempo real