Cover-Seiten, Link-Ablauf und Anpinnen

Was du tun kannst

Mit diesen fünf Endpunkten verwaltest du die Cover-Seiten eines Flipbooks, seinen Link-Ablauf und ob es angepinnt ist – ohne das Dashboard zu öffnen:

• Anhängen von Titel- und/oder Rückseiten aus einer hochgeladenen PDF-Datei.
• Anhängen von Titel- und/oder Rückseiten aus einer entfernten PDF-URL.
• Entfernen der Titel-/Rückseiten-Hülle, wodurch das Flipbook auf sein ungehülltes Kern-PDF zurückgesetzt wird.
• Setzen oder Entfernen eines automatischen Ablaufs für das Flipbook.
• Anpinnen oder Lösen des Flipbooks, damit es im Dashboard nach oben sortiert wird.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Jeder Endpunkt hier nimmt den Pfadparameter {flipbookId} entgegen – die numerische ID des Flipbooks, zurückgegeben von create-by-file / create-by-url (als ID) oder von list. Die Beispiele unten verwenden 96216.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Die Endpunkte URL-Cover-Seite und set-expiry senden einen form-urlencoded Body (kein JSON). Der Datei-Cover-Seiten-Endpunkt sendet multipart form-data (Datei-Uploads). Die Endpunkte clear und pin nehmen keinen Body entgegen.

Titel-/Rückseiten aus einer Datei festlegen

Hänge Titel- und/oder Rückseiten aus hochgeladenen PDF-Dateien an. Eines oder beide von Front/Back sind optional – mindestens eines ist erforderlich. Die Seiten werden erneut mit dem bestehenden Haupt-PDF zusammengeführt.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Antwort:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Titel-/Rückseiten aus einer URL festlegen

Die URL-Variante des Obigen – hängt Titel-/Rückseiten aus einer entfernten PDF-URL statt aus einer hochgeladenen Datei an. Die Felder Front und Back werden form-urlencoded gesendet.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Antwort:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Titel-/Rückseiten entfernen

Entfernt die Titel-/Rückseiten-Hülle und setzt FilePDF auf das ungehüllte Kern-PDF (MiddlePDF) zurück. Der Aufruf ist idempotent – ein Flipbook ohne Hülle gibt OK zurück und ändert nichts. Die Antwort enthält die S3-URL des wiederhergestellten Kern-PDFs. Alte zusammengeführte/Titel-/Rück-S3-Objekte werden nicht gelöscht. Nimmt keinen Body entgegen.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Ablauf setzen oder entfernen

Setzt oder entfernt den automatischen Ablauf eines Flipbooks. Sende Days und Hours als Ganzzahlen. Hours ist optional und standardmäßig 0. Wenn du Days=-1, Hours=0 sendest, wird der Ablauf vollständig entfernt.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Antwort:

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

Um den Ablauf zu entfernen, sende Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Anpinnen oder lösen

Pinnt das Flipbook an oder löst es (der markierte Zustand), damit es im Dashboard nach oben sortiert wird. Das ist ein Umschalter und nimmt keinen Body entgegen.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

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 vorhanden und korrekt ist.
• Unbekannte flipbookId (oder eine, die nicht zu deinem Schlüssel gehört) → HTTP 200 mit "Message": "Item not found".
• Set front/back page (Datei) – ungültiges PDF → HTTP 200 mit "Message": "File is not a valid PDF.", wenn die hochgeladene Datei kein lesbares PDF ist.
• Set front/back page (Datei) – Datei zu groß → HTTP 413 mit "Message": "File exceeds the maximum allowed upload size.", wenn der Upload die maximale Dateigröße des Tarifs überschreitet.
• Set front/back page (URL) und Set expiry – unbekanntes Feld → HTTP 200 mit "Message": "Unknown field(s) '…'. Expected: …", wenn ein Body-Feld falsch geschrieben oder nicht erkannt wird.