Cover- und Vorschaubilder

Was du tun kannst

Zwei Schreib-Endpunkte steuern die PDFs, die für ein Flipbook einspringen, bevor ein Leser vollen Zugriff erhält:

• Das Vorschau-PDF festlegen, das Lesern vor der Lead-Erfassung / Bezahlung gezeigt wird.
• Das Bild-PDF festlegen, das für Thumbnails und Vorschauen verwendet wird.

Jeder Aufruf zielt über die {flipbookId} auf ein Flipbook und gibt ein einfaches Erfolgsergebnis zurück.

Bevor du loslegst

Du brauchst:

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks/Dokuments, zurückgegeben von create-by-file / create-by-url (als ID) oder von list.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.

Beide Endpunkte nehmen einen form-urlencoded Body entgegen (kein JSON).

Das Vorschau-PDF festlegen

PUT /api/set-preview-pdf/{flipbookId} legt das Vorschau-PDF fest, das Lesern vor der Lead-Erfassung / Bezahlung gezeigt wird. Es wird automatisch gelöscht, wenn sowohl die Lead-Erfassung als auch der Verkaufsmodus aus sind.

Sende die URL des zu verwendenden PDFs als PreviewPDF:

• PreviewPDF – die URL des PDFs, das als Vorschau gezeigt werden soll. Der Wert wird unverändert gespeichert; die API prüft nicht, ob die URL erreichbar ist (live getestet), also sende eine gültige, erreichbare PDF-URL. Der Standard ist leer (kein Vorschau-PDF).

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Das Bild-PDF festlegen

PUT /api/set-image-pdf/{flipbookId} legt das reine Bild-/Vorschau-PDF fest, das für Thumbnails und Vorschauen verwendet wird. Sende die URL des zu verwendenden PDFs als IMGPdf:

• IMGPdf – die URL des reinen Bild-PDFs, das für Thumbnails und Vorschauen verwendet wird. Der Wert wird unverändert gespeichert; die API prüft nicht, ob die URL erreichbar ist (live getestet), also sende eine gültige, erreichbare PDF-URL. Der Standard ist ein Platzhalter ohne Bild, und wenn du einen leeren Wert sendest, bleibt das bestehende Bild-PDF erhalten.

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder Authorization: Bearer) vorhanden und korrekt ist.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels → HTTP 200 mit Message Item not found.
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message Unknown field(s) '…'. Expected: ….

Hinweise

• Bei beiden Feldern wird der URL-Wert unverändert gespeichert – die API prüft nicht, ob das PDF erreichbar ist (live getestet). Sende immer eine gültige, erreichbare PDF-URL.
• Das Vorschau-PDF (PreviewPDF) ist standardmäßig leer und wird automatisch gelöscht, wenn sowohl die Lead-Erfassung als auch der Verkaufsmodus aus sind.
• Das Bild-PDF (IMGPdf) ist standardmäßig ein Platzhalter ohne Bild; wenn du einen leeren Wert sendest, bleibt das bestehende Bild-PDF erhalten.