Metadaten, eigene URL und Veröffentlichung

Was du tun kannst

Diese vier Endpunkte steuern, wie sich ein Flipbook präsentiert – seinen Titel und die SEO-Metadaten, seinen Veröffentlichungsstatus, seine Share-URL und das Aussehen des Leseerlebnisses. Jeder davon zielt über die {flipbookId} auf ein einzelnes Flipbook:

• Titel und SEO-Meta festlegen – Title, Description, TitleColor und das IsPublished-Flag.
• Veröffentlichen oder Veröffentlichung aufheben, ohne Titel oder Beschreibung anzutasten.
• Einen eigenen (Vanity-)Slug vergeben für die Share-URL.
• Das Erscheinungsbild der Viewer-Seite konfigurieren – Seitentiefe und Cover-Typ.

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, zurückgegeben von create-by-file / create-by-url (als ID) oder von list. Alle vier Endpunkte unten verwenden sie als Pfadparameter.
• 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.

Titel und SEO-Meta festlegen

PUT /api/set-meta/{flipbookId} legt Titel und SEO-Meta des Flipbooks fest – Title, Description, TitleColor und das IsPublished-Flag. Das überschreibt Title/Description/TitleColor. Um nur den Veröffentlichungsstatus zu ändern, verwende stattdessen set-published (unten). TitleColor nimmt eine Hex-Farbe mit führendem # entgegen (z. B. #1a1a1a; Standard #000000) und wird unverändert gespeichert.

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

Antwort:

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

Veröffentlichen oder Veröffentlichung aufheben

PUT /api/set-published/{flipbookId} schaltet NUR das Veröffentlichungs-Flag um und lässt Title/Description/TitleColor unangetastet (anders als set-meta). Verwende es, um ein Flipbook (erneut) zu veröffentlichen – zum Beispiel eines, das aus create-by-file unveröffentlicht zurückkam. IsPublished ist erforderlich: true/1 = veröffentlichen, false/0 = Veröffentlichung aufheben.

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

Antwort:

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

Eine eigene URL festlegen

PUT /api/set-custom-url/{flipbookId} legt den eigenen (Vanity-)Slug für die Share-URL des Flipbooks über das Feld CustomURL fest. Der Slug muss eindeutig sein – ein bereits vergebener Slug gibt Result: "ERROR" zurück (siehe Fehler unten).

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

Antwort:

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

Das Erscheinungsbild der Seite festlegen

PUT /api/set-page-appearance/{flipbookId} konfiguriert das Erscheinungsbild der Viewer-Seite. Dieser Endpunkt stellt derzeit nur zwei einstellbare Felder bereit: PageDepth (akzeptiert flat, thin oder thick) und CoverType (akzeptiert soft oder hard). Werte werden wörtlich gespeichert; ältere Items können beim Zurücklesen über Get one andere Werte melden (z. B. regular oder numerisch 1).

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Antwort:

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

Mögliche Fehler

Diese Fehler gelten über die vier Endpunkte hinweg (custom-URL fügt einen eigenen hinzu):

• 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 { "Result": "ERROR", "Message": "Item not found" }.
• Eigene URL bereits vergeben (nur set-custom-url) → HTTP 200 mit { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message: "Unknown field(s) '…'. Expected: …".

Eine schnelle Faustregel: Result: "OK" bedeutet, dass die Änderung angewendet wurde; Result: "ERROR" bedeutet, dass sie es nicht wurde – lies die Message für den Grund.

Hinweise

• set-meta vs. set-published: set-meta überschreibt Title/Description/TitleColor. Wenn du also nur den Veröffentlichungsstatus ändern willst, verwende set-published – es lässt diese Felder unangetastet.