API de captura de leads
Crea y gestiona formularios de captura de leads, recoge envíos de visitantes de tus publicaciones y exporta datos de leads como CSV.
- Capturar un lead (público)
- Parámetros de ruta
- Cuerpo de la solicitud
- Ejemplo de solicitud
- Ejemplo de respuesta
- Listar leads
- Parámetros de consulta
- Ejemplo de solicitud
- Ejemplo de respuesta
- Exportar leads como CSV
- Parámetros de consulta
- Ejemplo de solicitud
- Ejemplo de respuesta
- Formularios de captura de leads
- Listar formularios de una publicación
- 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 (público)
API de captura de leads
La API de captura de leads te permite crear formularios que aparecen dentro de tus publicaciones de flipbooks para recoger información de los visitantes. Puedes configurar campos de formulario, condiciones de activación y estilos. Los leads capturados se almacenan y están disponibles para listar, buscar y exportar como CSV.
URL base: https://api.zenflip.io/v1/leads
Capturar un lead (público)
Envía un lead desde el visor de publicaciones. Este es un endpoint público --- no se requiere autenticación. Es llamado por el visor incrustado cuando un lector completa un formulario de captura de leads.
Límite de tasa: 10 envíos por minuto por dirección IP.
Parámetros de ruta
Parámetro | Tipo | Descripción |
| string | UUID de la publicación |
Cuerpo de la solicitud
Campo | Tipo | Requerido | Descripción |
| string | Sí | Dirección de email del lead |
| string | No | Nombre completo |
| string | No | Nombre de la empresa u organización |
| string | No | Número de teléfono |
| object | No | Pares clave-valor para campos personalizados del formulario |
| integer | No | Número de página donde se activó el formulario |
| string | No | Cómo apareció el formulario: |
Ejemplo de solicitud
Ejemplo de respuesta
Listar leads
Recupera una lista paginada de todos los leads capturados para tu organización.
Parámetros de consulta
Parámetro | Tipo | Requerido | Descripción |
| string | No | Filtrar por ID de publicación |
| integer | No | Número de página (por defecto: 1) |
| integer | No | Elementos por página (por defecto: 20) |
| string | No | Buscar por email o nombre |
Ejemplo de solicitud
Ejemplo de respuesta
Exportar leads como CSV
Exporta todos los leads de tu organización (o de una publicación específica) como un archivo CSV.
Parámetros de consulta
Parámetro | Tipo | Requerido | Descripción |
| string | No | Filtrar por ID de publicación |
Ejemplo de solicitud
Ejemplo de respuesta
Formularios de captura de leads
Los formularios de captura de leads definen los campos, condiciones de activación y estilos de los formularios mostrados a los visitantes dentro de tus publicaciones.
Listar formularios de una publicación
Ejemplo de solicitud
Ejemplo de respuesta
Crear un formulario de captura de leads
Rol requerido: editor o superior. Funcionalidad de plan requerida: leadCapture.
Cuerpo de la solicitud
Campo | Tipo | Requerido | Descripción |
| string | Sí | Título del formulario (máx. 200 caracteres) |
| string | No | Descripción mostrada encima del formulario |
| array | Sí | Array de definiciones de campos (ver abajo) |
| object | Sí | Configuración de activación (ver abajo) |
| object | No | Opciones de estilo personalizadas |
Objeto de definición de campo
Propiedad | Tipo | Descripción |
| string | Identificador del campo (usado como clave en los envíos) |
| string | Tipo de campo: |
| string | Etiqueta de visualización del campo |
| boolean | Si el campo es obligatorio |
| array | Opciones para campos |
Objeto de configuración de activación
Propiedad | Tipo | Descripción |
| string | Tipo de activación: |
| integer | Número de página (para activación |
| integer | Segundos de espera (para activación |
| integer | Porcentaje de scroll (para activación |
Ejemplo de solicitud
Actualizar un formulario de captura de leads
Rol requerido: editor o superior.
Todos los campos son opcionales. Solo incluye los campos que deseas cambiar.
Campo | Tipo | Descripción |
| string | Título del formulario |
| string | Descripción del formulario |
| array | Definiciones de campos actualizadas |
| object | Configuración de activación actualizada |
| object | Opciones de estilo actualizadas |
| boolean | Habilitar o deshabilitar el formulario |
Eliminar un formulario de captura de leads
Rol requerido: editor o superior.
Respuesta
Obtener formularios activos (público)
Recupera solo los formularios de captura de leads activos para una publicación. Este es un endpoint público utilizado por el visor para saber qué formularios mostrar.
No se requiere autenticación. Devuelve solo formularios donde isActive es true.