API de Publicaciones
Crea, actualiza, elimina y gestiona publicaciones de flipbook. Sube PDFs, controla la visibilidad, gestiona versiones y genera codigos QR.
- Listar Publicaciones
- Parametros de Consulta
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Crear Publicacion
- Cuerpo de la Solicitud
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Subir PDF
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Obtener Publicacion
- Ejemplo de Solicitud
- Ejemplo de Respuesta
- Actualizar Publicacion
- Cuerpo de la Solicitud
- Ejemplo de Solicitud
- Actualizar Configuracion de la Publicacion
- Ejemplo de Solicitud
- Actualizar Marca de la Publicacion
- Ejemplo de Solicitud
- Publicar / Archivar
- Eliminar Publicacion
- Listar Versiones
- Ejemplo de Respuesta
- Activar Version
- Generar Codigo QR
- Endpoint Publico del Visor
API de Publicaciones
La API de Publicaciones te permite crear publicaciones de flipbook, subir PDFs para conversion, gestionar versiones y controlar la configuracion de acceso. Todos los endpoints requieren autenticacion a menos que se marquen como publicos.
URL base: https://api.zenflip.io/v1/publications
Listar Publicaciones
Obtiene una lista paginada de publicaciones en tu organizacion.
` GET /publications `
Parametros de Consulta
Parametro | Tipo | Requerido | Descripcion |
|---|---|---|---|
| integer | No | Numero de pagina (por defecto: 1) |
| integer | No | Elementos por pagina (por defecto: 20) |
| string | No | Filtrar por titulo (coincidencia parcial) |
| string | No | Filtrar por estado: |
| string | No | Campo para ordenar (ej., |
| string | No | Direccion de ordenamiento: |
Ejemplo de Solicitud
`bash curl "https://api.zenflip.io/v1/publications?page=1&limit=10&status=published" \ -H "Authorization: Bearer YOUR_TOKEN" `
Ejemplo de Respuesta
`json { "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "title": "Product Catalog 2026", "slug": "product-catalog-2026", "description": "Annual product catalog with pricing", "status": "published", "accessType": "public", "activeVersionNumber": 2, "thumbnailUrl": "https://cdn.zenflip.io/thumbs/a1b2c3d4.jpg", "publishedAt": "2026-01-20T09:00:00.000Z", "createdAt": "2026-01-15T10:30:00.000Z", "updatedAt": "2026-02-01T14:22:00.000Z" } ], "meta": { "total": 24, "page": 1, "limit": 10, "totalPages": 3 } } `
Crear Publicacion
Crea un nuevo registro de publicacion. Despues de la creacion, sube un PDF para generar las paginas del flipbook.
` POST /publications `
Rol requerido: editor o superior.
Cuerpo de la Solicitud
Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | Si | Titulo de la publicacion (1--200 caracteres) |
| string | No | Descripcion breve de la publicacion |
Ejemplo de Solicitud
`bash curl -X POST https://api.zenflip.io/v1/publications \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Q1 Sales Report", "description": "Quarterly sales performance flipbook" }' `
Ejemplo de Respuesta
`json { "data": { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "title": "Q1 Sales Report", "slug": "q1-sales-report", "description": "Quarterly sales performance flipbook", "status": "draft", "accessType": "public", "activeVersionId": null, "activeVersionNumber": null, "settings": {}, "branding": null, "createdAt": "2026-02-20T12:00:00.000Z", "updatedAt": "2026-02-20T12:00:00.000Z" } } `
Subir PDF
Sube un archivo PDF para crear una nueva version de una publicacion. El PDF se almacena en S3 y se encola un trabajo de conversion en segundo plano para generar las paginas del flipbook.
` POST /uploads/publication/:pubId/pdf `
Rol requerido: editor o superior. Tamano maximo del archivo: 200 MB. Solo se aceptan archivos PDF.
Ejemplo de Solicitud
`bash curl -X POST "https://api.zenflip.io/v1/uploads/publication/b2c3d4e5-f6a7-8901-bcde-f12345678901/pdf" \ -H "Authorization: Bearer YOUR_TOKEN" \ -F "file=@/path/to/report.pdf" `
Ejemplo de Respuesta
`json { "data": { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "publicationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "versionNumber": 1, "pdfFilename": "report.pdf", "pdfSizeBytes": 4521984, "status": "uploaded" } } `
El estado de la version progresa a traves de: uploading -> uploaded -> converting -> ready (o failed). Usa el endpoint Obtener Publicacion para verificar el estado de la version activa.
Obtener Publicacion
Obtiene una publicacion individual por ID.
` GET /publications/:id `
Ejemplo de Solicitud
`bash curl "https://api.zenflip.io/v1/publications/b2c3d4e5-f6a7-8901-bcde-f12345678901" \ -H "Authorization: Bearer YOUR_TOKEN" `
Ejemplo de Respuesta
`json { "data": { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "title": "Q1 Sales Report", "slug": "q1-sales-report", "description": "Quarterly sales performance flipbook", "status": "published", "accessType": "public", "accessPassword": null, "activeVersionId": "c3d4e5f6-a7b8-9012-cdef-123456789012", "activeVersionNumber": 1, "settings": { "pageMode": "double", "toolbarVisible": true }, "branding": null, "leadCaptureEnabled": false, "thumbnailUrl": "https://cdn.zenflip.io/thumbs/b2c3d4e5.jpg", "publishedAt": "2026-02-20T14:00:00.000Z", "createdAt": "2026-02-20T12:00:00.000Z", "updatedAt": "2026-02-20T14:00:00.000Z" } } `
Actualizar Publicacion
Actualiza los metadatos de una publicacion.
` PATCH /publications/:id `
Rol requerido: editor o superior.
Cuerpo de la Solicitud
Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
| string | No | Titulo de la publicacion (1--200 caracteres) |
| string | No | Descripcion breve |
| string | No | Slug amigable para URLs (1--200 caracteres) |
Ejemplo de Solicitud
`bash curl -X PATCH "https://api.zenflip.io/v1/publications/b2c3d4e5-f6a7-8901-bcde-f12345678901" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Q1 Sales Report - Updated", "slug": "q1-sales-report-2026" }' `
Actualizar Configuracion de la Publicacion
Actualiza la configuracion del visor de una publicacion (modo de pagina, reproduccion automatica, visibilidad de la barra de herramientas, etc.).
` PATCH /publications/:id/settings `
Rol requerido: editor o superior.
Ejemplo de Solicitud
`bash curl -X PATCH "https://api.zenflip.io/v1/publications/b2c3d4e5.../settings" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "settings": { "autoPlay": true, "toolbarVisible": false, "pageMode": "double" } }' `
Actualizar Marca de la Publicacion
Aplica marca personalizada (logo, colores, fuentes) a una publicacion. Requiere la funcionalidad customBranding en tu plan.
` PATCH /publications/:id/branding `
Rol requerido: editor o superior. Funcionalidad del plan requerida: customBranding.
Ejemplo de Solicitud
`bash curl -X PATCH "https://api.zenflip.io/v1/publications/b2c3d4e5.../branding" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "branding": { "logoUrl": "https://example.com/logo.png", "primaryColor": "#4F46E5", "fontFamily": "Inter" } }' `
Publicar / Archivar
Cambia el estado del ciclo de vida de la publicacion:
`bash
Publicar un borrador
curl -X POST "https://api.zenflip.io/v1/publications/:id/publish" \ -H "Authorization: Bearer YOUR_TOKEN"
Archivar una publicacion
curl -X POST "https://api.zenflip.io/v1/publications/:id/archive" \ -H "Authorization: Bearer YOUR_TOKEN" `
Eliminar Publicacion
Elimina permanentemente una publicacion y todos los datos asociados (versiones, paginas, analiticas).
` DELETE /publications/:id `
Rol requerido: admin o superior.
`bash curl -X DELETE "https://api.zenflip.io/v1/publications/b2c3d4e5-f6a7-8901-bcde-f12345678901" \ -H "Authorization: Bearer YOUR_TOKEN" `
Listar Versiones
Obtiene todas las versiones de una publicacion.
` GET /publications/:id/versions `
Ejemplo de Respuesta
`json { "data": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "versionNumber": 2, "pdfFilename": "report-v2.pdf", "pdfSizeBytes": 5120000, "pageCount": 24, "status": "ready", "conversionProgress": 100, "convertedAt": "2026-02-20T14:05:00.000Z", "createdAt": "2026-02-20T14:00:00.000Z" }, { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "versionNumber": 1, "pdfFilename": "report.pdf", "pdfSizeBytes": 4521984, "pageCount": 20, "status": "ready", "conversionProgress": 100, "convertedAt": "2026-02-20T12:10:00.000Z", "createdAt": "2026-02-20T12:00:00.000Z" } ] } `
Activar Version
Cambia la version activa (en vivo) de una publicacion a una version subida previamente.
` POST /publications/:id/versions/:versionId/activate `
Rol requerido: editor o superior.
Generar Codigo QR
Genera un codigo QR en formato PNG que enlaza al visor de la publicacion.
` GET /publications/:id/qr-code `
Devuelve una imagen PNG de 512x512 directamente (Content-Type: image/png).
`bash curl "https://api.zenflip.io/v1/publications/b2c3d4e5.../qr-code" \ -H "Authorization: Bearer YOUR_TOKEN" \ --output qr-code.png `
Endpoint Publico del Visor
Obtiene los datos de la publicacion para el visor publico de flipbook. No se requiere autenticacion.
` GET /publications/public/:slug `
Este endpoint tiene un limite de tasa de 60 solicitudes por minuto por IP y devuelve la publicacion con las URLs de imagenes de paginas resueltas para renderizar en el visor.