Organiser les flipbooks avec des dossiers et des modèles
FlipbooksListe tes dossiers, déplace un flipbook dans un dossier (créé à la demande) ou retire-le, et marque un flipbook comme modèle réutilisable ou supprime-le.
API utilisées dans cette discussion
Ce que tu peux faire
Ces trois endpoints te permettent de garder tes flipbooks organisés sans passer par le tableau de bord :
- List — liste tes dossiers, chacun renvoyé sous la forme d'un nom et d'un GUID de dossier.
- Assign — assigne un flipbook à un dossier — les dossiers sont créés à la demande, et envoyer un dossier vide retire le flipbook de son dossier.
- Save — enregistre un flipbook comme modèle réutilisable, ou retire-le de tes modèles.
Avant de commencer
- Une clé d'API — envoyée à chaque requête, soit dans l'en-tête
X-Api-Key, soit viaAuthorization: Bearer YOUR_API_KEY. - Toutes les requêtes sont adressées à l'URL de base
https://go.fliplink.me. - Les deux endpoints d'écriture (assign-to-folder et save-as-template) utilisent un paramètre de chemin
{flipbookId}— l'ID numérique du flipbook, renvoyé par create-by-file / create-by-url (sousID) ou par list. - Ces endpoints d'écriture prennent un corps form-urlencoded (pas du JSON).
Lister tes dossiers
GET /api/list-folders liste tes dossiers, chacun sous la forme { Folder (nom), URL (un GUID de dossier) }. Les dossiers sont
dérivés des assignations de flipbooks, donc un dossier vide n'est pas listé.
curl -X GET 'https://go.fliplink.me/api/list-folders' \
-H 'X-Api-Key: YOUR_API_KEY'
Réponse :
{
"Result": "OK",
"Items": [
{
"Folder": "Marketing",
"URL": "00000000-0000-0000-0000-000000000001"
},
{
"Folder": "Marketing/Q2",
"URL": "00000000-0000-0000-0000-000000000002"
}
]
}
Assigner un flipbook à un dossier
PUT /api/assign-to-folder/{flipbookId} déplace le flipbook dans un dossier. Les dossiers sont créés à la demande —
assigne à un nom de dossier qui n'existe pas encore et il est créé automatiquement (il n'y a pas d'appel séparé « créer un
dossier »). Les noms de dossiers peuvent contenir / (par ex. Marketing/Q2). Un dossier n'existe que tant qu'au moins un
flipbook s'y trouve, donc déplacer le dernier flipbook hors du dossier fait disparaître celui-ci de list-folders.
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'Folder=Marketing/Q2'
Réponse :
{
"Result": "OK",
"Message": "Folder updated successfully"
}
Pour retirer le flipbook de son dossier, envoie un Folder vide :
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'Folder='
Enregistrer un flipbook comme modèle
PUT /api/save-as-template/{flipbookId} marque le flipbook comme modèle réutilisable (Status=true) ou le retire
des modèles (Status=false). Les modèles apparaissent dans list-templates et peuvent servir de base à de nouveaux flipbooks. Status
vaut true par défaut si omis.
curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'Status=true'
Réponse :
{
"Result": "OK",
"Message": "Saved as template"
}
Erreurs possibles
- Clé d'API manquante ou invalide → HTTP
401. Renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. - ID d'élément introuvable ou non rattaché à ta clé (assign-to-folder, save-as-template) → HTTP
200avecMessage: "Item not found". - Champ du corps inconnu ou mal orthographié (assign-to-folder, save-as-template) → HTTP
200avecMessage: "Unknown field(s) '…'. Expected: …".
Notes
- Le nom de
Folderque tu assignes est la même valeur qui apparaît sousFolderdans list-folders, donc tu peux réutiliser un nom de dossier existant pour y ajouter d'autres flipbooks.