API de publicaciones

Crea, actualiza, elimina y gestiona publicaciones de flipbooks. Sube PDFs, controla la visibilidad, gestiona versiones y genera códigos QR.

On this page

API de publicaciones

La API de publicaciones te permite crear publicaciones de flipbooks, subir PDFs para su conversión, gestionar versiones y controlar la configuración de acceso. Todos los endpoints requieren autenticación a menos que se indique como público.

URL base: https://api.zenflip.io/v1/publications

Listar publicaciones

Recupera una lista paginada de publicaciones de tu organización.

Parámetros de consulta

Parámetro

Tipo

Requerido

Descripción

page

integer

No

Número de página (por defecto: 1)

limit

integer

No

Elementos por página (por defecto: 20)

search

string

No

Filtrar por título (coincidencia parcial)

status

string

No

Filtrar por estado: draft, published, archived

sortBy

string

No

Campo para ordenar (ej., createdAt, title)

sortOrder

string

No

Dirección de orden: ASC o DESC

Ejemplo de solicitud

Ejemplo de respuesta

Crear publicación

Crea un nuevo registro de publicación. Después de la creación, sube un PDF para generar páginas de flipbook.

Rol requerido: editor o superior.

Cuerpo de la solicitud

Campo

Tipo

Requerido

Descripción

title

string

Sí

Título de la publicación (1--200 caracteres)

description

string

No

Descripción breve de la publicación

Ejemplo de solicitud

Ejemplo de respuesta

Subir PDF

Sube un archivo PDF para crear una nueva versión de una publicación. El PDF se almacena en S3 y se encola un trabajo de conversión en segundo plano para generar las páginas del flipbook.

Rol requerido: editor o superior. Tamaño máximo de archivo: 200 MB. Solo se aceptan archivos PDF.

Ejemplo de solicitud

Ejemplo de respuesta

El estado de la versión progresa a través de: uploading -> uploaded -> converting -> ready (o failed). Usa el endpoint Obtener publicación para comprobar el estado de la versión activa.

Obtener publicación

Recupera una publicación individual por ID.

Ejemplo de solicitud

Ejemplo de respuesta

Actualizar publicación

Actualiza los metadatos de una publicación.

Rol requerido: editor o superior.

Cuerpo de la solicitud

Campo

Tipo

Requerido

Descripción

title

string

No

Título de la publicación (1--200 caracteres)

description

string

No

Descripción breve

slug

string

No

Slug compatible con URL (1--200 caracteres)

Ejemplo de solicitud

Actualizar configuración de la publicación

Actualiza la configuración del visor de una publicación (modo de página, reproducción automática, visibilidad de la barra de herramientas, etc.).

Rol requerido: editor o superior.

Ejemplo de solicitud

Actualizar marca de la publicación

Aplica marca personalizada (logotipo, colores, fuentes) a una publicación. Requiere la funcionalidad customBranding en tu plan.

Rol requerido: editor o superior. Funcionalidad de plan requerida: customBranding.

Ejemplo de solicitud

Publicar / Archivar

Cambia el estado del ciclo de vida de la publicación:

Eliminar publicación

Elimina permanentemente una publicación y todos los datos asociados (versiones, páginas, analíticas).

Rol requerido: admin o superior.

Listar versiones

Recupera todas las versiones de una publicación.

Ejemplo de respuesta

Activar versión

Cambia la versión activa (en vivo) de una publicación a una versión subida previamente.

Rol requerido: editor o superior.

Generar código QR

Genera un código QR en formato PNG que enlaza al visor de la publicación.

Devuelve una imagen PNG de 512x512 directamente (Content-Type: image/png).

Endpoint público del visor

Recupera datos de publicación para el visor público de flipbooks. No se requiere autenticación.

Este endpoint tiene un límite de tasa de 60 solicitudes por minuto por IP y devuelve la publicación con las URLs de las imágenes de página resueltas para su renderizado en el visor.

Next →
API de analíticas