Protéger un flipbook par mot de passe

Ce que tu peux faire

La protection par mot de passe place une barrière devant un flipbook : les lecteurs doivent saisir le bon mot de passe avant que le contenu ne se charge. En un seul appel d'API, tu peux :

• Activer la protection et définir le mot de passe d'accès.
• Désactiver la protection à nouveau.
• Personnaliser l'écran de mot de passe — le titre, le texte indicatif du champ et le libellé du bouton.

Avant de commencer

Tu auras besoin de :

• Une clé d'API — envoyée dans l'en-tête X-Api-Key sur chaque requête.
• Le flipbookId — l'identifiant numérique renvoyé lorsque tu crées un flipbook (sous ID) ou depuis les endpoints de liste.
• Les requêtes sont envoyées à l'URL de base https://go.fliplink.me.

Le corps est form-urlencoded (pas du JSON).

Paramètres

Envoie ces champs en urlencoded sur PUT /api/set-password-access/{flipbookId} :

Activer la protection par mot de passe

Définis IsPasswordProtected=true et fournis le Password. Les trois champs Pwd* sont facultatifs — inclus-les pour personnaliser ce que voit le lecteur.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

Réponse :

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

Désactiver la protection par mot de passe

Définis IsPasswordProtected=false. Tu peux laisser les autres champs vides.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='

Réponse :

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

Personnaliser l'écran de mot de passe

Les champs PwdTitle, PwdPlaceholder et PwdButton te permettent d'adapter la barrière à ton public — par exemple en l'appelant « code d'accès » pour un portail client, ou en respectant le ton de ta marque. Ils sont facultatifs ; omets-les (ou envoie-les vides) pour utiliser les valeurs par défaut.

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ête X-Api-Key est présent et correct.
• flipbookId inconnu (ou non détenu par ta clé) → HTTP 200 avec { "Result": "ERROR", "Message": "Item not found" }.
• Champ de corps mal orthographié → HTTP 200 avec { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }. Revérifie les noms de champs par rapport au tableau ci-dessus.

Notes

• Partage le mot de passe par un canal séparé. Envoie le lien du flipbook et le mot de passe par des canaux distincts — un mot de passe inclus dans le même e-mail que le lien n'offre qu'une faible protection.
• La protection par mot de passe n'est qu'une couche. Elle contrôle l'entrée, pas qui est le lecteur. Pour restreindre l'accès à des personnes nommées, combine-la avec une liste d'e-mails autorisés ; pour limiter l'accès dans le temps, associe-la à une expiration du lien.