Gérer la liste d'e-mails autorisés d'un flipbook
Contrôle d'accèsContrôle précisément qui peut ouvrir un flipbook restreint en lisant, en complétant, en réduisant ou en remplaçant, via l'API, sa liste d'e-mails autorisés pour les lecteurs.
API utilisées dans cette discussion
Ce que tu peux faire
Quand un flipbook est restreint par e-mail, seules les adresses présentes sur sa liste d'autorisation peuvent l'ouvrir. L'API te donne quatre façons de gérer cette liste sans jamais passer par le tableau de bord :
- Lire la liste actuelle, pour ne jamais avoir à la suivre toi-même.
- Ajouter une ou plusieurs adresses (sans toucher à celles déjà présentes).
- Supprimer des adresses précises.
- Remplacer toute la liste en un seul appel.
Ce guide passe en revue chacune d'elles, la forme exacte de la requête, les réponses que tu obtiens, et le seul piège qui fait trébucher tout le monde (la différence entre ajouter et remplacer).
Avant de commencer
Tu auras besoin de :
- Une clé d'API — envoyée dans l'en-tête
X-Api-Keysur chaque requête. (Ta clé se trouve sur la page API de ton compte.) - Le
flipbookIdd'un flipbook restreint par e-mail. La liste d'autorisation régit l'accès des lecteurs sur les flipbooks restreints par e-mail. - Toutes les requêtes sont envoyées à l'URL de base
https://go.fliplink.me.
Le champ EmailsAllowed sur les requêtes d'écriture est form-urlencoded (pas du JSON) et séparé par des points-virgules
(alice@corp.com;bob@corp.com). Les virgules sont acceptées et automatiquement converties en points-virgules.
Les quatre endpoints en un coup d'œil
| Objectif | Méthode et chemin | Effet |
|---|---|---|
| Lire la liste | GET /api/get-email-allow-list/{flipbookId} | Renvoie les adresses actuelles + un décompte |
| Ajouter des adresses | POST /api/add-email-allow-list/{flipbookId} | Ajoute à la liste (conserve l'existant) |
| Supprimer des adresses | DELETE /api/delete-email-allow-list/{flipbookId} | Supprime uniquement les adresses nommées |
| Remplacer toute la liste | PUT /api/set-email-allow-list/{flipbookId} | Écrase toute la liste |
Lire la liste actuelle
Commence toujours ici — lis la liste pour connaître son état exact avant de changer quoi que ce soit.
curl -X GET 'https://go.fliplink.me/api/get-email-allow-list/96464' \
-H 'X-Api-Key: YOUR_API_KEY'
Réponse :
{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com"], "Count": 2 }
EmailsAllowed revient sous la forme d'un tableau JSON propre (pas d'une chaîne à points-virgules), et Count est sa longueur.
Ajouter des adresses (sans effacer le reste)
Pour donner accès à de nouvelles personnes tout en conservant toutes celles déjà sur la liste, utilise Add. C'est additif — cela ne supprimera personne.
curl -X POST 'https://go.fliplink.me/api/add-email-allow-list/96464' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'EmailsAllowed=carol@corp.com;dan@corp.com'
Réponse (la liste complète et mise à jour) :
{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "carol@corp.com", "dan@corp.com"], "Count": 4 }
Supprimer des adresses précises
Pour révoquer l'accès de personnes nommées, utilise Delete. Seules les adresses que tu indiques sont supprimées ; tout le monde reste.
curl -X DELETE 'https://go.fliplink.me/api/delete-email-allow-list/96464' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'EmailsAllowed=carol@corp.com'
Réponse :
{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "dan@corp.com"], "Count": 3 }
Remplacer toute la liste ⚠️
Set écrase toute la liste d'autorisation avec exactement les adresses que tu envoies. C'est là le piège : envoyer une seule adresse efface tous les autres.
# This does NOT add one person — it makes the list ONLY this one person.
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'EmailsAllowed=alice@corp.com'
Après cet appel, alice@corp.com est la seule adresse qui peut voir le flipbook. N'utilise Set que lorsque tu veux
vraiment définir la liste complète à partir de zéro (par exemple, initialiser un tout nouveau flipbook). Pour les changements
quotidiens du type « donner l'accès à cette personne / le révoquer pour telle autre », utilise plutôt Add et Delete.
Pour vider entièrement la liste, envoie une valeur vide :
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'EmailsAllowed='
Erreurs possibles
- Clé d'API manquante ou invalide → HTTP
401. Cela renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-têteX-Api-Keyest présent et correct. flipbookIdinconnu (ou non détenu par ta clé) → HTTP200avec{ "Result": "ERROR", "Message": "Item not found" }.
Une règle simple : Result: "OK" signifie que le changement a été appliqué ; Result: "ERROR" signifie qu'il ne l'a pas été
— lis le Message pour connaître la raison.
Modèle recommandé
Pour des changements sûrs et prévisibles :
- GET la liste actuelle.
- Décide qui ajouter ou supprimer.
- Utilise Add / Delete pour des changements granulaires (ils ne touchent jamais au reste de la liste).
- Réserve Set aux cas où tu veux vraiment remplacer toute la liste d'un coup.
- Refais un GET pour confirmer l'état final.
Cette boucle « lire → modifier → relire » fait que tu n'as jamais à suivre la liste dans ton propre système, et que tu n'effaces jamais l'accès par accident en utilisant Set alors que tu voulais Add.