Leadprivacy en e-mailverificatie

Wat je kunt doen

Wanneer een flipbook leads verzamelt, kun je twee delen van die ervaring via de API vormgeven:

• Privacy / toestemming — configureer de privacy-/toestemmingstekst en -opties van de lead capture (bijvoorbeeld het AVG-toestemmingsvinkje), inclusief een link naar je privacybeleid.
• E-mailverificatie — schakel e-mailverificatie voor leads in of uit, waarbij kijkers hun e-mail moeten bevestigen voordat ze toegang krijgen.

Voordat je begint

Je hebt nodig:

• Een API-sleutel — meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• De {flipbookId} — de numerieke ID van de flipbook/het document. Die wordt teruggegeven door create-by-file / create-by-url (als ID) of door list. Beide endpoints nemen hem als padparameter.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.

De request-body voor beide endpoints is form-urlencoded (geen JSON).

Privacy en toestemming configureren

PUT /api/set-lead-privacy/{flipbookId} configureert de privacy-/toestemmingstekst en -opties van de lead capture (bijv. het AVG-toestemmingsvinkje).

curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=' \
  --data-urlencode 'PrivacyPolicyText='

Response:

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

E-mailverificatie configureren

PUT /api/set-lead-verification/{flipbookId} schakelt e-mailverificatie voor leads in of uit, waarbij kijkers hun e-mail moeten bevestigen voordat ze toegang krijgen.

curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=' \
  --data-urlencode 'EmailVerifyTitleText=' \
  --data-urlencode 'EmailVerifyButtonText='

Response:

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

Mogelijke fouten

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met Message Item not found.
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message Unknown field(s) '…'. Expected: ….

Opmerkingen

• Het veld TwillioAPIKey behoudt de originele spelling Twillio — stuur het onder precies die naam.