Pages de couverture, expiration du lien et épinglage

Ce que tu peux faire

Ces cinq endpoints te permettent de gérer les pages de couverture d'un flipbook, l'expiration de son lien et son état épinglé — sans passer par le tableau de bord :

• Ajoute les pages de couverture avant et/ou arrière à partir d'un fichier PDF téléversé.
• Ajoute les pages de couverture avant et/ou arrière à partir d'une URL de PDF distante.
• Supprime l'habillage avant/arrière, ce qui rétablit le PDF principal nu du flipbook.
• Définis ou retire une expiration automatique sur le flipbook.
• Épingle ou désépingle le flipbook pour qu'il remonte en haut de ton tableau de bord.

Avant de commencer

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou via Authorization: Bearer YOUR_API_KEY, à chaque requête.
• Chaque endpoint ici prend le paramètre de chemin {flipbookId} — l'ID numérique du flipbook, renvoyé par create-by-file / create-by-url (sous ID) ou par list. Les exemples ci-dessous utilisent 96216.
• Toutes les requêtes sont adressées à l'URL de base https://go.fliplink.me.
• Les endpoints page de couverture par URL et set-expiry envoient un corps form-urlencoded (pas du JSON). L'endpoint page de couverture par fichier envoie du multipart form-data (téléversement de fichiers). Les endpoints clear et pin ne prennent aucun corps.

Définir les pages de couverture avant/arrière à partir d'un fichier

Ajoute les pages de couverture et/ou arrière à partir de fichiers PDF téléversés. Front et Back sont l'un comme l'autre optionnels — au moins l'un des deux est requis. Les pages sont refusionnées avec le PDF principal existant.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Réponse :

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Définir les pages de couverture avant/arrière à partir d'une URL

La variante par URL de ce qui précède — ajoute les pages de couverture/arrière à partir d'une URL de PDF distante plutôt que d'un fichier téléversé. Les champs Front et Back sont envoyés en form-urlencoded.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Réponse :

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Supprimer les pages de couverture avant/arrière

Supprime l'habillage avant/arrière, ce qui rétablit FilePDF au PDF principal nu (MiddlePDF). C'est idempotent — un flipbook sans habillage renvoie OK et ne change rien. La réponse inclut l'URL S3 du PDF principal rétabli. Les anciens objets S3 fusionnés/avant/arrière ne sont pas supprimés. Ne prend aucun corps.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Réponse :

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Définir ou retirer l'expiration

Définit ou retire l'expiration automatique d'un flipbook. Envoie Days et Hours sous forme d'entiers. Hours est optionnel et vaut 0 par défaut. Envoyer Days=-1, Hours=0 retire complètement l'expiration.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Réponse :

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

Pour retirer l'expiration, envoie Days=-1 :

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Épingler ou désépingler

Épingle ou désépingle le flipbook (l'état marqué d'une étoile) pour qu'il remonte en haut de ton tableau de bord. C'est une bascule et ne prend aucun corps.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

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 est présent et correct.
• flipbookId inconnu (ou non rattaché à ta clé) → HTTP 200 avec "Message": "Item not found".
• Définir la page avant/arrière (fichier) — PDF invalide → HTTP 200 avec "Message": "File is not a valid PDF." lorsque le fichier téléversé n'est pas un PDF lisible.
• Définir la page avant/arrière (fichier) — fichier trop volumineux → HTTP 413 avec "Message": "File exceeds the maximum allowed upload size." lorsque le téléversement dépasse la taille de fichier maximale de ton offre.
• Définir la page avant/arrière (URL) et Définir l'expiration — champ inconnu → HTTP 200 avec "Message": "Unknown field(s) '…'. Expected: …" lorsqu'un champ du corps est mal orthographié ou non reconnu.