Publications-API
Erstellen, aktualisieren, löschen und verwalten Sie Flipbook-Publikationen. Laden Sie PDFs hoch, steuern Sie die Sichtbarkeit, verwalten Sie Versionen und generieren Sie QR-Codes.
- Publikationen auflisten
- Abfrageparameter
- Beispielanfrage
- Beispielantwort
- Publikation erstellen
- Anfragekörper
- Beispielanfrage
- Beispielantwort
- PDF hochladen
- Beispielanfrage
- Beispielantwort
- Publikation abrufen
- Beispielanfrage
- Beispielantwort
- Publikation aktualisieren
- Anfragekörper
- Beispielanfrage
- Publikationseinstellungen aktualisieren
- Beispielanfrage
- Publikations-Branding aktualisieren
- Beispielanfrage
- Veröffentlichen / Archivieren
- Publikation löschen
- Versionen auflisten
- Beispielantwort
- Version aktivieren
- QR-Code generieren
- Öffentlicher Viewer-Endpunkt
Publications-API
Die Publications-API ermöglicht es Ihnen, Flipbook-Publikationen zu erstellen, PDFs für die Konvertierung hochzuladen, Versionen zu verwalten und Zugriffseinstellungen zu steuern. Alle Endpunkte erfordern Authentifizierung, sofern nicht als öffentlich gekennzeichnet.
Basis-URL: https://api.zenflip.io/v1/publications
Publikationen auflisten
Rufen Sie eine paginierte Liste der Publikationen in Ihrer Organisation ab.
` GET /publications `
Abfrageparameter
Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| integer | Nein | Seitennummer (Standard: 1) |
| integer | Nein | Einträge pro Seite (Standard: 20) |
| string | Nein | Nach Titel filtern (Teilübereinstimmung) |
| string | Nein | Nach Status filtern: |
| string | Nein | Sortierfeld (z.B. |
| string | Nein | Sortierrichtung: |
Beispielanfrage
`bash curl "https://api.zenflip.io/v1/publications?page=1&limit=10&status=published" \ -H "Authorization: Bearer YOUR_TOKEN" `
Beispielantwort
`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 } } `
Publikation erstellen
Erstellen Sie einen neuen Publikationsdatensatz. Nach der Erstellung laden Sie ein PDF hoch, um Flipbook-Seiten zu generieren.
` POST /publications `
Erforderliche Rolle: editor oder höher.
Anfragekörper
Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | Ja | Publikationstitel (1--200 Zeichen) |
| string | Nein | Kurze Beschreibung der Publikation |
Beispielanfrage
`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" }' `
Beispielantwort
`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" } } `
PDF hochladen
Laden Sie eine PDF-Datei hoch, um eine neue Version einer Publikation zu erstellen. Das PDF wird in S3 gespeichert und ein Hintergrund-Konvertierungsauftrag wird in die Warteschlange gestellt, um Flipbook-Seiten zu generieren.
` POST /uploads/publication/:pubId/pdf `
Erforderliche Rolle: editor oder höher. Maximale Dateigröße: 200 MB. Nur PDF-Dateien werden akzeptiert.
Beispielanfrage
`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" `
Beispielantwort
`json { "data": { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "publicationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "versionNumber": 1, "pdfFilename": "report.pdf", "pdfSizeBytes": 4521984, "status": "uploaded" } } `
Der Versionsstatus durchläuft folgende Phasen: uploading -> uploaded -> converting -> ready (oder failed). Verwenden Sie den Endpunkt "Publikation abrufen", um den Status der aktiven Version zu prüfen.
Publikation abrufen
Rufen Sie eine einzelne Publikation anhand der ID ab.
` GET /publications/:id `
Beispielanfrage
`bash curl "https://api.zenflip.io/v1/publications/b2c3d4e5-f6a7-8901-bcde-f12345678901" \ -H "Authorization: Bearer YOUR_TOKEN" `
Beispielantwort
`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" } } `
Publikation aktualisieren
Aktualisieren Sie die Metadaten einer Publikation.
` PATCH /publications/:id `
Erforderliche Rolle: editor oder höher.
Anfragekörper
Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | Nein | Publikationstitel (1--200 Zeichen) |
| string | Nein | Kurze Beschreibung |
| string | Nein | URL-freundlicher Slug (1--200 Zeichen) |
Beispielanfrage
`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" }' `
Publikationseinstellungen aktualisieren
Aktualisieren Sie die Viewer-Einstellungen einer Publikation (Seitenmodus, Auto-Play, Symbolleisten-Sichtbarkeit usw.).
` PATCH /publications/:id/settings `
Erforderliche Rolle: editor oder höher.
Beispielanfrage
`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" } }' `
Publikations-Branding aktualisieren
Wenden Sie benutzerdefiniertes Branding (Logo, Farben, Schriftarten) auf eine Publikation an. Erfordert das customBranding-Feature in Ihrem Plan.
` PATCH /publications/:id/branding `
Erforderliche Rolle: editor oder höher. Erforderliches Plan-Feature: customBranding.
Beispielanfrage
`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" } }' `
Veröffentlichen / Archivieren
Ändern Sie den Lebenszyklus-Status einer Publikation:
`bash
Einen Entwurf veröffentlichen
curl -X POST "https://api.zenflip.io/v1/publications/:id/publish" \ -H "Authorization: Bearer YOUR_TOKEN"
Eine Publikation archivieren
curl -X POST "https://api.zenflip.io/v1/publications/:id/archive" \ -H "Authorization: Bearer YOUR_TOKEN" `
Publikation löschen
Löschen Sie eine Publikation und alle zugehörigen Daten (Versionen, Seiten, Analysen) dauerhaft.
` DELETE /publications/:id `
Erforderliche Rolle: admin oder höher.
`bash curl -X DELETE "https://api.zenflip.io/v1/publications/b2c3d4e5-f6a7-8901-bcde-f12345678901" \ -H "Authorization: Bearer YOUR_TOKEN" `
Versionen auflisten
Rufen Sie alle Versionen einer Publikation ab.
` GET /publications/:id/versions `
Beispielantwort
`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" } ] } `
Version aktivieren
Wechseln Sie die aktive (Live-)Version einer Publikation zu einer zuvor hochgeladenen Version.
` POST /publications/:id/versions/:versionId/activate `
Erforderliche Rolle: editor oder höher.
QR-Code generieren
Generieren Sie einen PNG-QR-Code, der auf den Publikations-Viewer verlinkt.
` GET /publications/:id/qr-code `
Gibt ein 512x512 PNG-Bild direkt zurück (Content-Type: image/png).
`bash curl "https://api.zenflip.io/v1/publications/b2c3d4e5.../qr-code" \ -H "Authorization: Bearer YOUR_TOKEN" \ --output qr-code.png `
Öffentlicher Viewer-Endpunkt
Rufen Sie Publikationsdaten für den öffentlichen Flipbook-Viewer ab. Keine Authentifizierung erforderlich.
` GET /publications/public/:slug `
Dieser Endpunkt ist auf 60 Anfragen pro Minute pro IP begrenzt und gibt die Publikation mit aufgelösten Seitenbild-URLs für die Darstellung im Viewer zurück.