API de Captura de Leads
Crea y gestiona formularios de captura de leads, recopila envios de lectores desde tus publicaciones y exporta datos de leads como CSV.
- Capturar un Lead (Publico)
- Parametros de Ruta
- Cuerpo de la Solicitud
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Listar Leads
- Parametros de Consulta
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Exportar Leads como CSV
- Parametros de Consulta
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Formularios de Captura de Leads
- Listar Formularios de una Publicacion
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Crear un Formulario de Captura de Leads
- Actualizar un Formulario de Captura de Leads
- Eliminar un Formulario de Captura de Leads
- Respuesta
- Obtener Formularios Activos (Publico)
API de Captura de Leads
La API de Captura de Leads te permite crear formularios que aparecen dentro de tus publicaciones de flipbook para recopilar informacion de los lectores. Puedes configurar los campos del formulario, las condiciones de activacion y el estilo. Los leads capturados se almacenan y estan disponibles para listado, busqueda y exportacion CSV.
URL base: https://api.zenflip.io/v1/leads
Capturar un Lead (Publico)
Envia un lead desde el visor de la publicacion. Este es un endpoint publico --- no se requiere autenticacion. Es llamado por el visor integrado cuando un lector completa un formulario de captura de leads.
` POST /leads/capture/:pubId `
Limite de tasa: 10 envios por minuto por direccion IP.
Parametros de Ruta
Parametro | Tipo | Descripcion |
|---|---|---|
| string | UUID de la publicacion |
Cuerpo de la Solicitud
Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | Si | Direccion de email del lead |
| string | No | Nombre completo |
| string | No | Nombre de la empresa u organizacion |
| string | No | Numero de telefono |
| object | No | Pares clave-valor para campos personalizados del formulario |
| integer | No | Numero de pagina donde se activo el formulario |
| string | No | Como aparecio el formulario: |
Ejemplo de Solicitud
`bash curl -X POST "https://api.zenflip.io/v1/leads/capture/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Content-Type: application/json" \ -d '{ "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager", "department": "Marketing" }, "sourcePage": 3, "triggerType": "page" }' `
Ejemplo de Respuesta
`json { "data": { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager", "department": "Marketing" }, "sourcePage": 3, "triggerType": "page", "capturedAt": "2026-02-20T15:30:00.000Z" } } `
Listar Leads
Obtiene una lista paginada de todos los leads capturados de tu organizacion.
` GET /leads `
Parametros de Consulta
Parametro | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | No | Filtrar por ID de publicacion |
| integer | No | Numero de pagina (por defecto: 1) |
| integer | No | Elementos por pagina (por defecto: 20) |
| string | No | Buscar por email o nombre |
Ejemplo de Solicitud
`bash curl "https://api.zenflip.io/v1/leads?pubId=a1b2c3d4...&page=1&limit=20" \ -H "Authorization: Bearer YOUR_TOKEN" `
Ejemplo de Respuesta
`json { "data": [ { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "publicationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager" }, "sourcePage": 3, "triggerType": "page", "capturedAt": "2026-02-20T15:30:00.000Z" } ], "meta": { "total": 142, "page": 1, "limit": 20, "totalPages": 8 } } `
Exportar Leads como CSV
Exporta todos los leads de tu organizacion (o de una publicacion especifica) como un archivo CSV.
` GET /leads/export `
Parametros de Consulta
Parametro | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | No | Filtrar por ID de publicacion |
Ejemplo de Solicitud
`bash curl "https://api.zenflip.io/v1/leads/export?pubId=a1b2c3d4..." \ -H "Authorization: Bearer YOUR_TOKEN" `
Ejemplo de Respuesta
`json { "data": "email,name,company,phone,source_page,trigger_type,captured_at\njane@example.com,Jane Doe,Acme Inc.,+1-555-0100,3,page,2026-02-20T15:30:00.000Z\n" } `
Formularios de Captura de Leads
Los formularios de captura de leads definen los campos, las condiciones de activacion y el estilo de los formularios mostrados a los lectores dentro de tus publicaciones.
Listar Formularios de una Publicacion
` GET /leads/forms/:pubId `
Ejemplo de Solicitud
`bash curl "https://api.zenflip.io/v1/leads/forms/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer YOUR_TOKEN" `
Ejemplo de Respuesta
`json { "data": [ { "id": "e5f6a7b8-c9d0-1234-ef01-345678901234", "publicationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "title": "Download gated form", "description": "Enter your details to continue reading", "fields": [ { "name": "email", "type": "email", "label": "Email", "required": true }, { "name": "name", "type": "text", "label": "Full Name", "required": false }, { "name": "company", "type": "text", "label": "Company", "required": false } ], "trigger": { "type": "page", "page": 3 }, "styling": { "backgroundColor": "#ffffff", "buttonColor": "#3b82f6" }, "isActive": true, "createdAt": "2026-02-10T09:00:00.000Z", "updatedAt": "2026-02-10T09:00:00.000Z" } ] } `
Crear un Formulario de Captura de Leads
` POST /leads/forms/:pubId `
Rol requerido: editor o superior. Funcionalidad del plan requerida: leadCapture.
Cuerpo de la Solicitud
Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | Si | Titulo del formulario (max 200 caracteres) |
| string | No | Descripcion mostrada sobre el formulario |
| array | Si | Array de definiciones de campos (ver abajo) |
| object | Si | Configuracion de activacion (ver abajo) |
| object | No | Opciones de estilo personalizado |
Objeto de Definicion de Campo
Propiedad | Tipo | Descripcion |
|---|---|---|
| string | Identificador del campo (usado como clave en los envios) |
| string | Tipo de campo: |
| string | Etiqueta de visualizacion del campo |
| boolean | Si el campo es obligatorio |
| array | Opciones para campos |
Objeto de Configuracion de Activacion
Propiedad | Tipo | Descripcion |
|---|---|---|
| string | Tipo de activacion: |
| integer | Numero de pagina (para activacion |
| integer | Segundos de espera (para activacion |
| integer | Porcentaje de desplazamiento (para activacion |
Ejemplo de Solicitud
`bash curl -X POST "https://api.zenflip.io/v1/leads/forms/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Get the full report", "description": "Enter your email to unlock all pages", "fields": [ { "name": "email", "type": "email", "label": "Work Email", "required": true }, { "name": "name", "type": "text", "label": "Full Name", "required": true }, { "name": "company", "type": "text", "label": "Company", "required": false } ], "trigger": { "type": "page", "page": 5 }, "styling": { "backgroundColor": "#ffffff", "buttonColor": "#4F46E5", "buttonText": "Unlock Report" } }' `
Actualizar un Formulario de Captura de Leads
` PATCH /leads/forms/:formId `
Rol requerido: editor o superior.
Todos los campos son opcionales. Solo incluye los campos que deseas cambiar.
Campo | Tipo | Descripcion |
|---|---|---|
| string | Titulo del formulario |
| string | Descripcion del formulario |
| array | Definiciones de campos actualizadas |
| object | Configuracion de activacion actualizada |
| object | Opciones de estilo actualizadas |
| boolean | Habilitar o deshabilitar el formulario |
Eliminar un Formulario de Captura de Leads
` DELETE /leads/forms/:formId `
Rol requerido: editor o superior.
`bash curl -X DELETE "https://api.zenflip.io/v1/leads/forms/e5f6a7b8-c9d0-1234-ef01-345678901234" \ -H "Authorization: Bearer YOUR_TOKEN" `
Respuesta
`json { "message": "Lead capture form deleted" } `
Obtener Formularios Activos (Publico)
Obtiene solo los formularios de captura de leads activos de una publicacion. Este es un endpoint publico utilizado por el visor para saber que formularios mostrar.
` GET /leads/forms/public/:pubId `
No se requiere autenticacion. Devuelve solo los formularios donde isActive es true.