Métadonnées, URL personnalisée et publication

Ce que tu peux faire

Ces quatre endpoints contrôlent la façon dont un flipbook se présente — son titre et ses métadonnées SEO, son état de publication, son URL de partage et l'aspect de l'expérience de lecture. Chacun cible un seul flipbook via son {flipbookId} :

• Définir le titre et les métadonnées SEO — Title, Description, TitleColor et l'indicateur IsPublished.
• Publier ou dépublier sans toucher au titre ni à la description.
• Lui donner un slug personnalisé (vanity) pour l'URL de partage.
• Configurer l'apparence des pages du lecteur — épaisseur des pages et type de couverture.

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, renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list. Les quatre endpoints ci-dessous l'utilisent comme paramètre de chemin.
• Toutes les requêtes utilisent l'URL de base https://go.fliplink.me.
• Chaque corps de requête ici est form-urlencoded (pas du JSON) — envoie chaque champ avec --data-urlencode.

Définir le titre et les métadonnées SEO

PUT /api/set-meta/{flipbookId} définit le titre et les métadonnées SEO du flipbook — Title, Description, TitleColor et l'indicateur IsPublished. Cet appel écrase Title/Description/TitleColor. Pour changer seulement l'état de publication, utilise plutôt set-published (ci-dessous). TitleColor prend une couleur hexadécimale avec le # de tête (par ex. #1a1a1a ; défaut #000000) et est stockée telle quelle.

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'

Réponse :

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

Publier ou dépublier

PUT /api/set-published/{flipbookId} bascule UNIQUEMENT l'indicateur de publication, en laissant Title/Description/TitleColor intacts (contrairement à set-meta). Utilise-le pour (re)publier un flipbook — par exemple un qui est revenu dépublié de create-by-file. IsPublished est requis : true/1 = publier, false/0 = dépublier.

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

Réponse :

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

Définir une URL personnalisée

PUT /api/set-custom-url/{flipbookId} définit le slug personnalisé (vanity) de l'URL de partage du flipbook via le champ CustomURL. Le slug doit être unique — un slug déjà utilisé renvoie Result: "ERROR" (voir les erreurs ci-dessous).

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

Réponse :

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

Définir l'apparence des pages

PUT /api/set-page-appearance/{flipbookId} configure l'apparence des pages du lecteur. Cet endpoint n'expose actuellement que deux champs modifiables : PageDepth (accepte flat, thin ou thick) et CoverType (accepte soft ou hard). Les valeurs sont stockées verbatim ; des éléments plus anciens peuvent renvoyer d'autres valeurs (par ex. regular, ou le numérique 1) à la relecture via Get one.

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'

Réponse :

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

Erreurs possibles

Ces erreurs s'appliquent aux quatre endpoints (l'URL personnalisée en ajoute une qui lui est propre) :

• 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 { "Result": "ERROR", "Message": "Item not found" }.
• URL personnalisée déjà prise (set-custom-url uniquement) → HTTP 200 avec { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message: "Unknown field(s) '…'. Expected: …".

Une règle simple : Result: "OK" signifie que le changement a été appliqué ; Result: "ERROR" signifie qu'il ne l'a pas été — lis le Message pour connaître la raison.

Notes

• set-meta vs set-published : set-meta écrase Title/Description/TitleColor, donc si tu veux seulement changer l'état de publication, utilise set-published — il laisse ces champs intacts.