API Reference
Bienvenido a la documentación de la API de Interflow.
EN ACTUALIZACIÓN
Esta documentación está en fase de actualización continua.
Visión General
La API de Interflow permite integrar y automatizar funcionalidades de la plataforma en tus aplicaciones.
URL Base
https://v1.api.interflow.chatAutenticación
La API utiliza API Keys para autenticación:
bash
curl -X POST "https://v1.api.interflow.chat/api/{organizationId}/chat/create" \
-H "x-api-key: ak_tu_api_key_aqui" \
-H "Content-Type: application/json" \
-d '{
"contactType": "whatsapp",
"contactValue": "5511999999999",
"channelId": "uuid-del-canal"
}'Dónde encontrar los IDs
| ID | En la app |
|---|---|
organizationId | Configuración → API Keys |
channelId | Menú lateral Canales — copiar en la tarjeta del canal |
whatsappTemplate.id / templateId | Canales → canal WhatsApp Oficial → Plantillas de WhatsApp → Copiar ID |
teamId | Menú lateral Equipos — copiar en la tarjeta del equipo |
flowId / responseFlowId | Menú lateral Flujos — copiar en la tarjeta del flujo |
customerId | Menú lateral Clientes → acciones (⋮) → Copiar ID |
| API Key | Configuración → API Keys → generar una nueva clave |
Rate Limiting
| Plan | Límite |
|---|---|
| Starter | 60 req/min |
| Professional | 300 req/min |
| Enterprise | 1000 req/min |
Endpoints Principales
Chats
| Método | Endpoint | Descripción |
|---|---|---|
POST | /api/{organizationId}/chat/create | Crear chat |