Mettre en place un formulaire de capture de prospects

Ce que tu peux faire

Un formulaire de capture de prospects est une barrière qui collecte les informations du lecteur avant qu'il ne lise le flipbook. Quatre endpoints te permettent de construire et de configurer ce formulaire entièrement via l'API :

• Activer et configurer la barrière de base — active la capture de prospects, définis son titre, autorise (ou bloque) le fait de passer, et contrôle au bout de combien de pages le formulaire apparaît.
• Basculer les champs standard — nom, e-mail, téléphone, entreprise, date — et marque chacun comme obligatoire ou facultatif.
• Définir des champs personnalisés supplémentaires au-delà de l'ensemble standard, avec leurs propres libellés.
• Définir les libellés d'affichage et le texte d'aide affichés pour chaque champ.

Chaque endpoint cible un flipbook par son {flipbookId} et applique les changements avec un seul PUT.

Avant de commencer

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou sous la forme Authorization: Bearer YOUR_API_KEY, à chaque requête.
• L'{flipbookId} — l'ID numérique du flipbook, renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list. C'est un paramètre de chemin sur les quatre endpoints.
• Toutes les requêtes vont vers l'URL de base https://go.fliplink.me.
• Chaque corps de requête est form-urlencoded (pas du JSON) — envoie les champs avec --data-urlencode.

Activer et configurer la barrière de base

PUT /api/set-lead-capture/{flipbookId} active et configure le formulaire de capture de prospects de base. L'indicateur d'activation est IsLeadCapture (une erreur courante est de chercher IsEnabled — ce champ n'existe pas ici).

curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=true' \
  --data-urlencode 'LeadCaptureTitle=Please share your details to continue' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=Skip' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'

Réponse :

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

Le corps porte l'indicateur d'activation (IsLeadCapture), un titre de formulaire (LeadCaptureTitle), un basculement de saut (IsLeadAllowSkip), et son LeadSkipText — le libellé affiché sur le bouton de saut (par défaut Skip). Il porte aussi deux champs de comptage de pages indépendants, LeadFormAfterPages et LeadAfterPages, chacun stocké séparément. Les deux comptages de pages contrôlent, côté lecteur, le moment où le formulaire apparaît ; définis les deux délibérément pour obtenir le comportement voulu.

Basculer les champs standard

PUT /api/set-lead-fields/{flipbookId} bascule chaque champ standard de capture de prospects (nom, e-mail, téléphone, entreprise, date) et indique s'il est obligatoire. Chaque champ a un indicateur Is… pour l'afficher et un indicateur Is…Mandatory pour le rendre obligatoire.

Le corps porte aussi LeadPhoneCountry, qui définit le pays / l'indicatif par défaut pour le champ téléphone. Il accepte une valeur telle que US ou +1 et est stocké tel quel ; il est vide par défaut.

curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry='

Réponse :

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

Définir des champs personnalisés

PUT /api/set-lead-custom-fields/{flipbookId} définit des champs personnalisés supplémentaires sur le formulaire de capture de prospects, au-delà des champs standard nom/e-mail/téléphone. Chaque champ personnalisé a un indicateur d'affichage, un indicateur d'obligation, et un libellé.

curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label='

Réponse :

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

Définir les libellés des champs

PUT /api/set-lead-labels/{flipbookId} définit les libellés d'affichage et le texte d'aide pour les champs du formulaire de capture de prospects, y compris le bouton d'envoi.

curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=' \
  --data-urlencode 'LeadName=' \
  --data-urlencode 'LeadPhone=' \
  --data-urlencode 'LeadCompany=' \
  --data-urlencode 'LeadDate=' \
  --data-urlencode 'LeadButton='

Réponse :

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

Erreurs possibles

Elles s'appliquent aux quatre endpoints :

• 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 (ou Authorization: Bearer) est présent et correct.
• ID d'élément introuvable ou non détenu par ta clé → HTTP 200 avec Message: "Item not found".
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message: "Unknown field(s) '…'. Expected: …". Respecte l'orthographe et la casse exactes de chaque nom de champ des exemples ci-dessus.

Remarques

• Pour activer la capture de prospects, active-la via set-lead-capture (IsLeadCapture=true) avant de compter sur les endpoints de champs, de champs personnalisés et de libellés — ceux-ci configurent le formulaire que présente la barrière de base.