Configurer le lecteur et l'expérience de lecture

Ce que tu peux faire

Ces cinq endpoints configurent la façon dont un flipbook se présente dans le lecteur. Chacun cible un flipbook par son {flipbookId} et met à jour un aspect de l'expérience d'affichage et de lecture :

• Afficher ou masquer chaque bouton de la barre d'outils du lecteur (téléchargement, impression, partage, plein écran, zoom, miniatures, etc.).
• Configurer la navigation de lecture — miniatures de pages, table des matières et façon dont les lecteurs passent d'une page à l'autre.
• Activer ou désactiver le tournage automatique des pages et en définir l'intervalle.
• Définir ou retirer la piste de musique de fond qui joue dans le lecteur.
• Définir le contenu affiché dans les quatre coins (en-tête/pied de page) de l'habillage 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 à chaque requête.
• Le {flipbookId} — l'ID numérique du flipbook, renvoyé par create-by-file / create-by-url (dans ID) ou par list. Chaque endpoint ici le prend comme paramètre de chemin.
• Toutes les requêtes sont adressées à l'URL de base https://go.fliplink.me.
• Chaque corps de requête ici est form-urlencoded (pas JSON). Envoie chaque champ avec --data-urlencode.

Définir les commandes du lecteur

Affiche ou masque chaque bouton de la barre d'outils du lecteur (téléchargement, impression, partage, plein écran, zoom, miniatures, etc.).

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Réponse :

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

Définir la navigation de lecture

Configure la navigation de lecture dans le lecteur — la façon dont les lecteurs passent d'une page à l'autre. Les quatre champs du corps :

• BookLayout (nombre) — une mise en page numérique. L'API stocke la valeur que tu envoies, quelle qu'elle soit.
• ScrollBehaviour (nombre) — un mode de défilement numérique ; la valeur par défaut est 1. La signification de chaque valeur est interprétée côté lecteur, et l'API stocke la valeur que tu envoies, quelle qu'elle soit.
• IsNavFirstLast (booléen, true/false) — active la navigation vers la première/dernière page.
• IsRightToLeft (booléen, true/false) — active la lecture de droite à gauche.

Remarque : ces paramètres de navigation de lecture s'appliquent aux flipbooks uniquement. Sur un élément Document, ils sont ignorés — l'API répond This setting applies to Flipbook items only.

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Réponse :

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

Définir le tournage automatique

Active ou désactive le tournage automatique des pages dans le lecteur, ainsi que son intervalle. La valeur AutoFlipInSecs est en millisecondes malgré son nom : 0 = désactivé, 3000 = 3 s, 5000 = 5 s, etc.

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Réponse :

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

Définir la musique de fond

Définit ou retire la piste de musique de fond qui joue dans le lecteur. Utilise un nom de fichier de piste prédéfinie issu de /api/list-background-music dans BackgroundMusic, ou l'URL d'une musique personnalisée téléversée dans BackgroundMusicCustom.

curl -X PUT 'https://go.fliplink.me/api/set-background-music/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=' \
  --data-urlencode 'BackgroundMusicCustom=' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Réponse :

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

Définir la disposition en-tête/pied de page

Définit le contenu affiché dans les quatre coins (en-tête/pied de page) de l'habillage du lecteur : TopLeft, TopRight, BottomLeft et BottomRight.

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=' \
  --data-urlencode 'TopRight=' \
  --data-urlencode 'BottomLeft=' \
  --data-urlencode 'BottomRight='

Réponse :

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

Erreurs possibles

Les cinq endpoints partagent le même comportement en cas d'erreur :

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — sans 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 rattaché à ta clé → HTTP 200 avec Message "Item not found".
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message "Unknown field(s) '…'. Expected: …".

Un Result égal à "OK" signifie que la modification a été appliquée ; sinon, lis le Message pour en connaître la raison.