Ein Flipbook branden (Logo, Favicon, Skin, Hintergrund)

Was du tun kannst

Mit fünf Schreib-Endpunkten brandest du den gehosteten Viewer eines Flipbooks, ohne das Dashboard zu öffnen. Jeder davon zielt auf ein einzelnes Flipbook (über seine {flipbookId}) und ändert einen Aspekt seines Erscheinungsbilds:

• Das Logo festlegen, das im Header-/Branding-Bereich des Viewers gezeigt wird.
• Das Favicon festlegen (das Icon im Browser-Tab) der gehosteten Viewer-Seite.
• Einen Skin/ein Theme anwenden auf den Viewer.
• Das Hintergrundbild festlegen des Viewers.
• Den eigenen Ladetext festlegen, der auf dem Ladebildschirm des Viewers erscheint.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks, das du branden willst. Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben. Alle fünf Endpunkte nehmen 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.

Das Logo festlegen

Legt das Logo-Bild fest, das im Header-/Branding-Bereich des Flipbook-Viewers gezeigt wird.

curl -X PUT 'https://go.fliplink.me/api/set-logo/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=' \
  --data-urlencode 'LogoURL=' \
  --data-urlencode 'IsShowLogoMobile=false'

Dieser Endpunkt akzeptiert drei Body-Felder:

• LogoIMG – das Logo-Bild selbst (seine URL/sein Pfad). Das ist das Bild, das im Header-/Branding-Bereich des Viewers gezeigt wird.
• LogoURL – der Click-Through-Link, auf den das Logo zeigt; ein Klick auf das Logo öffnet diese URL. Standard ist https://fliplink.me.
• IsShowLogoMobile – ein boolean (true / false, Standard false), der festlegt, ob das Logo auf Mobilgeräten gezeigt wird.

Antwort:

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

Das Favicon festlegen

Legt das Favicon (das Icon im Browser-Tab) fest, das die gehostete Viewer-Seite des Flipbooks verwendet.

curl -X PUT 'https://go.fliplink.me/api/set-favicon/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG='

Antwort:

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

Einen Skin anwenden

Wendet einen Viewer-Skin/ein Theme auf das Flipbook an; der Server löst den Skin-Namen zu seiner ID auf. Das Feld ist SkinName (der String aus list-skins), nicht eine numerische ID.

curl -X PUT 'https://go.fliplink.me/api/set-skin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName='

Antwort:

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

Das Hintergrundbild festlegen

Legt das Hintergrundbild des Viewers aus einer URL fest, die du angibst (es gibt keine eingebaute Galerie). BackgroundIMG nimmt eine Bild-URL entgegen oder eine Platzhalter-URL wie https://plchldr.co/i/100x100?text=&bg=HEX. Jeder Farbwert ist ein Hex-String #RRGGBB und wird unverändert gespeichert.

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

Antwort:

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

Den Ladetext festlegen

Legt den eigenen Text fest, der auf dem Ladebildschirm des Viewers erscheint. Das Feld ist CustomLoadingText, nicht LoadingText.

curl -X PUT 'https://go.fliplink.me/api/set-loading-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText='

Antwort:

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

Mögliche Fehler

Diese gelten für alle fünf Endpunkte:

• 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

• Für Set Skin sende den Name des Skins (aus /api/list-skins) in SkinName – nicht eine numerische ID.
• Für Set Loading Text ist das Feld CustomLoadingText; LoadingText wird als unbekanntes Feld abgelehnt.
• Für Set Background Image gibt es keine eingebaute Galerie – du gibst die Bild-URL selbst an.