Con la API REST de Papo, puedes listar todos los Flows disponibles en tu cuenta, activar o desactivar jornadas y matricular contactos en automatizaciones de forma programática — todo mediante solicitudes autenticadas, sin abrir el panel. Es la manera de integrar el motor de Flows con sistemas externos, workflows de n8n, CRMs o scripts internos.
La API de Papo expone recursos de Flows que permiten gestionar automatizaciones tal como ya gestionas bandejas de entrada o contactos. Con ella, equipos de desarrollo, integradores y revendedores white label pueden controlar en lote qué jornadas están activas, iniciar contactos en secuencias y sincronizar el estado de las automatizaciones con procesos de negocio.
Resumen de las operaciones de Flow vía API
| Operación | Descripción | Ejemplo de uso |
|---|---|---|
| Listar Flows | Devuelve los Flows y secuencias disponibles, con identificador, nombre, tipo y estado (Activo/Inactivo). | Auditar automatizaciones, sincronizar con dashboards externos o verificar qué está en ejecución. |
| Activar/desactivar Flow | Cambia el estado de un Flow específico, liberando o pausando la recepción y procesamiento de contactos. | Pausar una jornada durante mantenimiento, liberar tras ajustes o desactivar una campaña finalizada. |
| Matricular contacto | Inserta un contacto existente al inicio de un Flow activo, dando inicio a la jornada configurada. | Incluir leads del CRM externo, disparar un flujo de bienvenida tras integración o corregir entradas manuales. |
Cómo funciona la autenticación de la API
Todas las llamadas a la API, incluidas las que involucran Flows, requieren la clave secreta de la cuenta. Debe enviarse como token Bearer en el encabezado Authorization. La clave pública de la cuenta es opcional, pero si se envía debe corresponder a la misma cuenta de la clave secreta.
La URL base de la API es https://app.papo.global/api/v1. Las claves se generan en el área de desarrollador del panel de Papo. La clave secreta aparece una única vez en la creación; guárdala en un lugar seguro y revócala si sospechas de un filtrado.
El patrón de autenticación es el mismo usado en todos los endpoints:
curl https://app.papo.global/api/v1/me \
-H "Authorization: Bearer sk_live_…" \
-H "X-Papo-Public-Key: pk_live_…"
Gestionando Flows vía API en la práctica
Aunque los detalles exactos de cada endpoint y parámetros estén en la documentación oficial de la API, el flujo general de trabajo sigue estos pasos conceptuales:
- Autentícate con la clave secreta (y, si lo deseas, la clave pública) para validar la cuenta.
- Lista los Flows para obtener la relación actual de jornadas, incluidos sus identificadores y estado. Esto permite mapear lo que ya existe y elegir el Flow correcto para las próximas operaciones.
- Cambia el estado de un Flow específico, si es necesario. Envía una solicitud que defina el Flow como activo (liberado para recibir contactos) o inactivo (pausado). Solo los Flows activos procesan contactos y aceptan matrículas.
- Matricula un contacto en un Flow activo. Informa el identificador del contacto y el identificador del Flow deseado para insertarlo al inicio de la jornada. El historial del contacto en el CRM se preserva.
- Integra con sistemas externos — mediante webhooks o llamadas directas, puedes iniciar contactos provenientes de un formulario externo, un evento en otro sistema o un pipeline de datos.
La plataforma también soporta la creación de Flows vacíos e inactivos y el llenado de sus nodos vía API, lo que permite provisionar automatizaciones completas de forma programática. Para los formatos exactos de payload, campos obligatorios y ejemplos de código, consulta la sección de Flows en la documentación de la API de Papo.
Para quién tiene sentido esta integración
- Equipos de TI que operan múltiples automatizaciones y necesitan pausar, reactivar o monitorear Flows en lote sin acceder al panel manualmente.
- Revendedores white label que desean provisionar journeys estandarizadas para cada nuevo cliente automáticamente, matricular contactos iniciales y mantener alineación entre plataformas.
- Integradores y desarrolladores que conectan Papo a CRMs, ERPs o herramientas como n8n, activando Flows a partir de eventos externos (una compra, un registro, una cita).
- Operaciones que trabajan con matrícula condicional, donde los contactos se incluyen en Flows solo después de pasar por reglas de negocio definidas en otros sistemas.
Preguntas frecuentes
¿Necesito la clave secreta para listar los Flows?
Sí. La lista de Flows, así como cualquier operación que devuelve datos de la cuenta, requiere autenticación con la clave secreta. El patrón es el mismo de todos los demás endpoints: envía el token Bearer en el encabezado Authorization.
¿Puedo activar o desactivar un Flow por la API?
Sí. La API permite cambiar el estado de un Flow entre activo e inactivo. Necesitas el identificador del Flow y la clave secreta. Los Flows inactivos no reciben contactos y no avanzan en la jornada, incluso si se intenta una matrícula.
¿Cómo hago para matricular un contacto en un Flow vía API?
Proporciona el identificador del contacto y el identificador del Flow activo en la llamada de matrícula. El contacto se insertará al inicio de la jornada, sin borrar el historial de conversaciones o datos del perfil. La documentación oficial detalla el formato exacto de los parámetros.
¿Es posible crear un Flow desde cero por la API?
Sí. La API permite crear un Flow vacío (solo con el nodo Start) e inactivo, además de llenar sus nodos con preguntas, mensajes y condiciones. Esto es útil para provisionar automatizaciones de forma escalable, principalmente en escenarios de reventa u onboarding de nuevos clientes.
¿La API devuelve el estado de cada Flow al listar?
Sí. La lista incluye el estado (Activo o Inactivo) de cada Flow y secuencia, además de identificador, nombre y tipo, lo que permite que sistemas externos monitoreen qué está funcionando y qué está pausado.
¿Dónde encuentro la documentación completa de las rutas de Flows?
La documentación oficial está disponible en https://papo.global/pt/docs. Allí encuentras todos los endpoints, parámetros aceptados, códigos de error y ejemplos en varios lenguajes. Las rutas de Flows siguen el mismo patrón REST y autenticación de los demás módulos.
Lea también
- Cómo usar la API de Papo para crear y actualizar contactos en masa
- Cómo usar la API de Papo para crear y gestionar etiquetas (tags)
Comienza a integrar tus Flows ahora mismo →
Crea tu cuenta gratuita en Papo, accede a las claves de API y conecta tus automatizaciones con el mundo exterior.