Lead-Datenschutz und E-Mail-Verifizierung

Was du tun kannst

Wenn ein Flipbook Leads erfasst, kannst du über die API zwei Teile dieses Erlebnisses gestalten:

• Datenschutz / Einwilligung – konfiguriere den Datenschutz-/Einwilligungstext und die Optionen der Lead-Erfassung (zum Beispiel die DSGVO-Einwilligungs-Checkbox), inklusive eines Links zu deiner Datenschutzerklärung.
• E-Mail-Verifizierung – schalte die E-Mail-Verifizierung von Leads ein oder aus, sodass Betrachter ihre E-Mail-Adresse vor dem Zugriff bestätigen müssen.

Bevor du loslegst

Du brauchst:

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks/Dokuments. Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben. Beide Endpunkte nehmen sie als Pfadparameter entgegen.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.

Der Request-Body ist bei beiden Endpunkten form-urlencoded (kein JSON).

Datenschutz und Einwilligung konfigurieren

PUT /api/set-lead-privacy/{flipbookId} konfiguriert den Datenschutz-/Einwilligungstext und die Optionen der Lead-Erfassung (z. B. die DSGVO-Einwilligungs-Checkbox).

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='

Antwort:

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

E-Mail-Verifizierung konfigurieren

PUT /api/set-lead-verification/{flipbookId} schaltet die E-Mail-Verifizierung von Leads ein oder aus, sodass Betrachter ihre E-Mail-Adresse vor dem Zugriff bestätigen müssen.

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='

Antwort:

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

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header vorhanden und korrekt ist.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels → HTTP 200 mit Message Item not found.
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message Unknown field(s) '…'. Expected: ….

Hinweise

• Das Feld TwillioAPIKey behält die ursprüngliche Schreibweise Twillio bei – sende es unter genau diesem Namen.