Personnaliser un flipbook (logo, favicon, thème, arrière-plan)

Ce que tu peux faire

Cinq endpoints d'écriture te permettent de personnaliser le lecteur hébergé d'un flipbook sans passer par le tableau de bord. Chacun cible un seul flipbook (via son {flipbookId}) et modifie un aspect de son apparence :

• Définir le logo affiché dans l'en-tête / la zone de marque du lecteur.
• Définir le favicon (icône d'onglet du navigateur) de la page du lecteur hébergé.
• Appliquer un thème au lecteur.
• Définir l'image d'arrière-plan du lecteur.
• Définir le texte de chargement personnalisé affiché sur l'écran de chargement du lecteur.

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 personnaliser. Il est renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list. Les cinq endpoints le prennent 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 logo

Définit l'image du logo affichée dans l'en-tête / la zone de marque du lecteur du flipbook.

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'

Cet endpoint accepte trois champs de corps :

• LogoIMG — l'image du logo elle-même (son URL/chemin). C'est l'image affichée dans l'en-tête / la zone de marque du lecteur.
• LogoURL — le lien de redirection vers lequel pointe le logo ; cliquer sur le logo ouvre cette URL. Par défaut https://fliplink.me.
• IsShowLogoMobile — un booléen (true / false, false par défaut) qui indique si le logo est affiché sur mobile.

Réponse :

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

Définir le favicon

Définit le favicon (icône d'onglet du navigateur) utilisé par la page du lecteur hébergé du flipbook.

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

Réponse :

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

Appliquer un thème

Applique un thème au lecteur du flipbook ; le serveur résout le nom du thème vers son ID. Le champ est SkinName (la chaîne renvoyée par list-skins), pas un ID numérique.

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

Réponse :

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

Définir l'image d'arrière-plan

Définit l'image d'arrière-plan du lecteur à partir d'une URL que tu fournis (il n'y a pas de galerie intégrée). BackgroundIMG prend une URL d'image, ou une URL de substitution comme https://plchldr.co/i/100x100?text=&bg=HEX. Toute valeur de couleur est une chaîne hexadécimale #RRGGBB et est stockée telle quelle.

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

Réponse :

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

Définir le texte de chargement

Définit le texte personnalisé affiché sur l'écran de chargement du lecteur. Le champ est CustomLoadingText, pas LoadingText.

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

Réponse :

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

Erreurs possibles

Elles s'appliquent aux cinq endpoints :

• 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: …".

Notes

• Pour Définir le thème, envoie le Name du thème (renvoyé par /api/list-skins) dans SkinName — pas un ID numérique.
• Pour Définir le texte de chargement, le champ est CustomLoadingText ; envoyer LoadingText sera rejeté comme champ inconnu.
• Pour Définir l'image d'arrière-plan, il n'y a pas de galerie intégrée — tu fournis toi-même l'URL de l'image.