Schnellstartanleitung

Schnellstartanleitung

Diese Anleitung führt Sie durch das Erhalten von Anmeldedaten, die Authentifizierung bei der ZenFlip-API und Ihren ersten erfolgreichen API-Aufruf. Am Ende werden Sie alle Publikationen in Ihrer Organisation aufgelistet haben.

Basis-URL

Alle API-Anfragen werden an die versionierte Basis-URL gerichtet:

` https://api.zenflip.io/v1 `

Jeder in dieser Anleitung dokumentierte Endpunkt ist relativ zu dieser Basis-URL. Der Login-Endpunkt wird beispielsweise zu https://api.zenflip.io/v1/auth/login aufgelöst.

Schritt 1 --- API-Schlüssel erstellen

ZenFlip unterstützt zwei Authentifizierungsmethoden: JWT-Tokens (für benutzerorientierte Anwendungen) und API-Schlüssel (für Server-zu-Server-Integrationen).

So erstellen Sie einen API-Schlüssel:

1. Melden Sie sich im ZenFlip-Dashboard unter https://app.zenflip.io an.

2. Navigieren Sie zu Einstellungen > API-Schlüssel.

3. Klicken Sie auf Neuen Schlüssel generieren, vergeben Sie eine aussagekräftige Bezeichnung (z.B. "Produktions-Backend") und kopieren Sie den Schlüssel sofort. Er wird nicht erneut angezeigt.

API-Schlüssel sind auf Ihre Organisation beschränkt. Anfragen mit einem API-Schlüssel übernehmen die Berechtigungen des Organisations-Inhabers.

Schritt 2 --- Authentifizieren

Option A: API-Schlüssel (Server-zu-Server)

Übergeben Sie Ihren API-Schlüssel im Authorization-Header mit dem Präfix Bearer:

`bash curl https://api.zenflip.io/v1/publications \ -H "Authorization: Bearer zf_live_abc123yourAPIkeyHere" `

Option B: JWT-Token (Benutzersitzungen)

Erhalten Sie ein kurzlebiges JWT-Zugriffstoken durch Aufruf des Login-Endpunkts:

`bash curl -X POST https://api.zenflip.io/v1/auth/login \ -H "Content-Type: application/json" \ -d '{ "email": "you@example.com", "password": "your-password" }' `

Eine erfolgreiche Antwort gibt ein Zugriffstoken und ein Refresh-Token zurück:

`json { "accessToken": "eyJhbGciOiJIUzI1NiIs...", "refreshToken": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 3600, "user": { "id": "550e8400-e29b-41d4-a716-446655440000", "email": "you@example.com", "name": "Your Name", "role": "owner" }, "organization": { "id": "660e8400-e29b-41d4-a716-446655440000", "name": "Your Organization" } } `

Verwenden Sie das accessToken in nachfolgenden Anfragen:

`bash curl https://api.zenflip.io/v1/publications \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." `

Schritt 3 --- Ersten API-Aufruf durchführen

Listen Sie alle Publikationen in Ihrer Organisation mit einer einfachen GET-Anfrage auf:

`bash curl https://api.zenflip.io/v1/publications?page=1&limit=10 \ -H "Authorization: Bearer YOUR_TOKEN" `

Die Antwort folgt dem standardmäßigen paginierten Format:

`json { "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "title": "Product Catalog 2026", "slug": "product-catalog-2026", "status": "published", "accessType": "public", "thumbnailUrl": "https://cdn.zenflip.io/thumbs/a1b2c3d4.jpg", "activeVersionNumber": 2, "createdAt": "2026-01-15T10:30:00.000Z", "updatedAt": "2026-02-01T14:22:00.000Z" } ], "meta": { "total": 1, "page": 1, "limit": 10, "totalPages": 1 } } `

Antwortformat

Alle erfolgreichen Antworten kapseln Daten in einem data-Schlüssel. Paginierte Endpunkte enthalten ein meta-Objekt mit Paginierungsdetails.

Fehlerantworten

Wenn eine Anfrage fehlschlägt, gibt die API eine konsistente Fehlerstruktur zurück:

`json { "statusCode": 401, "message": "Invalid or expired token", "error": "Unauthorized" } `

Ratenlimits

Die API erzwingt minutenbasierte Ratenlimits basierend auf Ihrem Plan:

Wenn Sie das Limit überschreiten, gibt die API einen 429-Status mit einem Retry-After-Header zurück, der angibt, wie viele Sekunden Sie warten müssen.

Nächste Schritte

• [Authentifizierung](/docs/authentication) --- Detaillierte Informationen zu JWT-Tokens, Refresh-Abläufen und Google OAuth.

• [Publications API](/docs/publications-api) --- Erstellen, aktualisieren und verwalten Sie Ihre Flipbooks.

• [Embed-Widget](/docs/embed-quickstart) --- Fügen Sie interaktive Flipbooks zu jeder Website hinzu.