Call-to-Actions zu einem Flipbook hinzufügen

Was du tun kannst

Der Viewer eines Flipbooks kann Call-to-Action-(CTA-)Buttons anzeigen, die Leser an einen von dir gewählten Ort verlinken. Drei Endpunkte lassen dich sie über die API konfigurieren:

• Den primären CTA-Button festlegen – seine Beschriftung, URL, Farbe und ob er angezeigt wird.
• Den sekundären CTA-Button festlegen – ein zweiter Button, der die Felder mit dem Suffix 2 verwendet.
• Die Vorschauregeln festlegen – steuere, ob der CTA ausgeblendet wird, während ein Leser in der Vorschau ist.

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 konfigurieren willst (Pfadparameter bei allen drei Endpunkten). Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Der Request-Body ist bei allen drei Endpunkten form-urlencoded (kein JSON) – sende jedes Feld mit --data-urlencode.

Den primären CTA-Button festlegen

Konfiguriert den primären Call-to-Action-Button im Viewer (Beschriftung, URL, Farbe). Die Felder sind IsCTAButton, CTAButtonText, CTAButtonURL (plus Farbfelder) – nicht Text/URL/Position. Ein Wert für CTAButtonURL mit einem mailto:- / tel:-Präfix wird serverseitig automatisch normalisiert.

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=' \
  --data-urlencode 'CTAButtonColor=' \
  --data-urlencode 'CTAButtonURL=' \
  --data-urlencode 'CTAButtonTextColor='

Antwort:

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

Den sekundären CTA-Button festlegen

Konfiguriert den sekundären Call-to-Action-Button im Viewer. Der sekundäre Button verwendet die Felder mit dem Suffix 2 – IsCTAButton2, CTAButtonText2, CTAButtonURL2 (plus die Farbfelder mit dem Suffix 2).

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=' \
  --data-urlencode 'CTAButtonColor2=' \
  --data-urlencode 'CTAButtonTextColor2=' \
  --data-urlencode 'CTAButtonURL2='

Antwort:

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

Die Vorschauregeln festlegen

Konfiguriert, wann der Call-to-Action Lesern angezeigt wird – die Vorschau-Sperr-Regel. Sende IsCTAHiddenInPreview, um zu steuern, ob der CTA ausgeblendet wird, während ein Leser in der Vorschau ist.

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

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: …". Prüfe die genaue Schreibweise der Felder (zum Beispiel die Felder mit dem Suffix 2 des sekundären Buttons).

Hinweise

• Alle drei Endpunkte teilen sich denselben Pfadparameter {flipbookId} und dieselbe Erfolgsform { "Result": "OK", "Message": "Updated successfully" }.
• Der primäre und der sekundäre Button werden unabhängig voneinander konfiguriert – der sekundäre Endpunkt akzeptiert nur die Feldnamen mit dem Suffix 2.