Ajouter des appels à l'action à un flipbook

Ce que tu peux faire

Le lecteur d'un flipbook peut afficher des boutons d'appel à l'action (CTA) qui dirigent les lecteurs vers un endroit de ton choix. Trois endpoints te permettent de les configurer depuis l'API :

• Définir le bouton CTA principal — son libellé, son URL, sa couleur et son affichage.
• Définir le bouton CTA secondaire — un second bouton utilisant les champs suffixés par 2.
• Définir les règles d'aperçu — contrôler si le CTA est masqué pendant qu'un lecteur est en aperçu.

Avant de commencer

• Une clé d'API — envoyée soit dans l'en-tête X-Api-Key, soit sous la forme Authorization: Bearer YOUR_API_KEY sur chaque requête.
• Le flipbookId — l'ID numérique du flipbook que tu veux configurer (paramètre de chemin sur les trois endpoints). Il est renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list.
• Toutes les requêtes utilisent l'URL de base https://go.fliplink.me.
• Le corps de la requête est form-urlencoded (pas du JSON) sur les trois endpoints — envoie chaque champ avec --data-urlencode.

Définir le bouton CTA principal

Configure le bouton d'appel à l'action principal dans le lecteur (libellé, URL, couleur). Les champs sont IsCTAButton, CTAButtonText, CTAButtonURL (plus les champs de couleur) — pas Text/URL/Position. Une valeur CTAButtonURL préfixée par mailto: / tel: est normalisée automatiquement côté serveur.

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='

Réponse :

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

Définir le bouton CTA secondaire

Configure le bouton d'appel à l'action secondaire dans le lecteur. Le bouton secondaire utilise les champs suffixés par 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (plus les champs de couleur suffixés par 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='

Réponse :

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

Définir les règles d'aperçu

Configure le moment où l'appel à l'action est montré aux lecteurs — la règle de gate en aperçu. Envoie IsCTAHiddenInPreview pour contrôler si le CTA est masqué pendant qu'un lecteur est en aperçu.

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

Réponse :

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

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key (ou Authorization: Bearer) est présent et correct.
• ID d'élément introuvable ou non détenu par ta clé → HTTP 200 avec Message: "Item not found".
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message: "Unknown field(s) '…'. Expected: …". Revérifie l'orthographe exacte du champ (par exemple, les champs suffixés par 2 du bouton secondaire).

Notes

• Les trois endpoints partagent le même paramètre de chemin {flipbookId} et la même forme de succès { "Result": "OK", "Message": "Updated successfully" }.
• Les boutons principal et secondaire se configurent indépendamment — l'endpoint secondaire n'accepte que les noms de champs suffixés par 2.