Images de couverture et d'aperçu
Image de marque et contenuDéfinis l'aperçu que voient les lecteurs avant la capture de prospects ou le paiement, ainsi que le PDF image utilisé pour les miniatures et les aperçus, via l'API.
API utilisées dans cette discussion
Ce que tu peux faire
Deux endpoints d'écriture contrôlent les PDF qui représentent un flipbook avant qu'un lecteur n'obtienne l'accès complet :
- Définir le PDF d'aperçu montré aux lecteurs avant la capture de prospects / le paiement.
- Définir le PDF image utilisé pour les miniatures et les aperçus.
Chaque appel cible un seul flipbook via son {flipbookId} et renvoie un simple résultat de succès.
Avant de commencer
Il te faut :
- Une clé d'API — envoyée dans l'en-tête
X-Api-Key, ou sous la formeAuthorization: Bearer YOUR_API_KEY, sur chaque requête. - Le
{flipbookId}— l'ID numérique du flipbook/document, renvoyé par create-by-file / create-by-url (sous la formeID) ou par list. - Toutes les requêtes utilisent l'URL de base
https://go.fliplink.me.
Les deux endpoints prennent un corps form-urlencoded (pas du JSON).
Définir le PDF d'aperçu
PUT /api/set-preview-pdf/{flipbookId} définit le PDF d'aperçu montré aux lecteurs avant la capture de prospects / le paiement. Il est effacé automatiquement si la capture de prospects et le mode vente sont tous deux désactivés.
Envoie l'URL du PDF à utiliser dans PreviewPDF :
PreviewPDF— l'URL du PDF à afficher comme aperçu. La valeur est stockée telle quelle ; l'API ne vérifie pas que l'URL est joignable (testé en direct), alors envoie une URL de PDF valide et joignable. La valeur par défaut est vide (pas de PDF d'aperçu).
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'
Réponse :
{
"Result": "OK",
"Message": "Updated successfully"
}
Définir le PDF image
PUT /api/set-image-pdf/{flipbookId} définit le PDF image (aperçu uniquement) utilisé pour les miniatures et les aperçus. Envoie l'URL du PDF à utiliser dans IMGPdf :
IMGPdf— l'URL du PDF image à utiliser pour les miniatures et les aperçus. La valeur est stockée telle quelle ; l'API ne vérifie pas que l'URL est joignable (testé en direct), alors envoie une URL de PDF valide et joignable. La valeur par défaut est une image de substitution vide, et envoyer une valeur vide conserve le PDF image existant.
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'
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êteX-Api-Key(ouAuthorization: Bearer) est présent et correct. - ID d'élément introuvable ou non détenu par ta clé → HTTP
200avecMessageItem not found. - Champ de corps inconnu ou mal orthographié → HTTP
200avecMessageUnknown field(s) '…'. Expected: ….
Notes
- Pour les deux champs, la valeur de l'URL est stockée telle quelle — l'API ne vérifie pas que le PDF est joignable (testé en direct). Envoie toujours une URL de PDF valide et joignable.
- Le PDF d'aperçu (
PreviewPDF) est vide par défaut et est effacé automatiquement si la capture de prospects et le mode vente sont tous deux désactivés. - Le PDF image (
IMGPdf) est par défaut une image de substitution vide ; envoyer une valeur vide conserve le PDF image existant.