Das Viewer- und Reader-Erlebnis konfigurieren

Was du tun kannst

Diese fünf Endpunkte konfigurieren, wie sich ein einzelnes Flipbook im Viewer präsentiert. Jeder zielt über die {flipbookId} auf ein Flipbook und aktualisiert einen Aspekt des Ansichts- und Leseerlebnisses:

• Anzeigen oder ausblenden einzelner Viewer-Toolbar-Buttons (Herunterladen, Drucken, Teilen, Vollbild, Zoom, Thumbnails usw.).
• Die Reader-Navigation konfigurieren – Seiten-Thumbnails, Inhaltsverzeichnis und wie Leser zwischen Seiten wechseln.
• Automatisches Umblättern aktivieren oder deaktivieren und sein Intervall festlegen.
• Setzen oder entfernen des Hintergrundmusik-Titels, der im Viewer läuft.
• Den Inhalt festlegen, der in den vier Ecken (Kopf-/Fußzeile) des Viewer-Rahmens gezeigt wird.

Bevor du loslegst

• Einen API-Schlüssel, gesendet bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY.
• Die {flipbookId} – die numerische ID des Flipbooks, zurückgegeben von create-by-file / create-by-url (als ID) oder von list. Jeder Endpunkt hier nimmt sie als Pfadparameter entgegen.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Jeder Request-Body hier ist form-urlencoded (kein JSON). Sende jedes Feld mit --data-urlencode.

Viewer-Steuerung festlegen

Zeigt oder blendet einzelne Viewer-Toolbar-Buttons (Herunterladen, Drucken, Teilen, Vollbild, Zoom, Thumbnails usw.).

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Antwort:

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

Reader-Navigation festlegen

Konfiguriert die Reader-Navigation im Viewer – wie Leser zwischen Seiten wechseln. Die vier Body-Felder:

• BookLayout (Zahl) – ein numerisches Seitenlayout. Die API speichert genau den Wert, den du sendest.
• ScrollBehaviour (Zahl) – ein numerischer Scroll-Modus; Standard ist 1. Die Bedeutung jedes Werts wird viewer-seitig interpretiert, und die API speichert genau den Wert, den du sendest.
• IsNavFirstLast (boolean, true/false) – schaltet die Navigation zur ersten/letzten Seite um.
• IsRightToLeft (boolean, true/false) – stellt das Lesen von rechts nach links ein.

Hinweis: Diese Reader-Navigationseinstellungen gelten nur für Flipbooks. Bei einem Document-Item werden sie ignoriert – die API antwortet This setting applies to Flipbook items only.

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Antwort:

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

Auto-Flip festlegen

Aktiviert oder deaktiviert das automatische Umblättern im Viewer und sein Intervall. Der Wert AutoFlipInSecs ist trotz des Namens in Millisekunden: 0 = aus, 3000 = 3s, 5000 = 5s usw.

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Antwort:

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

Hintergrundmusik festlegen

Setzt oder entfernt den Hintergrundmusik-Titel, der im Viewer läuft. Verwende einen vordefinierten Titel-Dateinamen aus /api/list-background-music in BackgroundMusic oder eine eigene hochgeladene Musik-URL in BackgroundMusicCustom.

curl -X PUT 'https://go.fliplink.me/api/set-background-music/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=' \
  --data-urlencode 'BackgroundMusicCustom=' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Antwort:

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

Kopf-/Fußzeilen-Layout festlegen

Legt den Inhalt fest, der in den vier Ecken (Kopf-/Fußzeile) des Viewer-Rahmens gezeigt wird: TopLeft, TopRight, BottomLeft und BottomRight.

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=' \
  --data-urlencode 'TopRight=' \
  --data-urlencode 'BottomLeft=' \
  --data-urlencode 'BottomRight='

Antwort:

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

Mögliche Fehler

Alle fünf Endpunkte verhalten sich bei Fehlern gleich:

• 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: …".

Ein Result von "OK" bedeutet, dass die Änderung angewendet wurde; andernfalls lies die Message für den Grund.