Ein Lead-Erfassungsformular einrichten

Was du tun kannst

Ein Lead-Erfassungsformular ist eine Sperre, die Betrachterdaten sammelt, bevor sie das Flipbook lesen. Vier Endpunkte lassen dich dieses Formular vollständig über die API bauen und konfigurieren:

• Die Basis-Sperre aktivieren und konfigurieren – schalte die Lead-Erfassung ein, lege ihren Titel fest, erlaube (oder blockiere) das Überspringen und steuere, nach wie vielen Seiten das Formular erscheint.
• Die Standardfelder umschalten – Name, E-Mail, Telefon, Firma, Datum – und markiere jedes als Pflicht- oder Wahlfeld.
• Zusätzliche benutzerdefinierte Felder definieren über den Standardsatz hinaus, mit eigenen Beschriftungen.
• Die Anzeigebeschriftungen festlegen und den Platzhaltertext, der für jedes Feld gezeigt wird.

Jeder Endpunkt zielt über die {flipbookId} auf ein Flipbook und wendet Änderungen mit einem einzigen PUT an.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks, zurückgegeben von create-by-file / create-by-url (als ID) oder von list. Sie ist bei allen vier Endpunkten ein Pfadparameter.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Jeder Request-Body ist form-urlencoded (kein JSON) – sende Felder mit --data-urlencode.

Die Basis-Sperre aktivieren und konfigurieren

PUT /api/set-lead-capture/{flipbookId} aktiviert und konfiguriert das Basis-Lead-Erfassungsformular. Das Aktivierungs-Flag ist IsLeadCapture (ein häufiger Fehler ist, nach IsEnabled zu suchen – dieses Feld gibt es hier nicht).

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'

Antwort:

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

Der Body trägt das Aktivierungs-Flag (IsLeadCapture), eine Formularüberschrift (LeadCaptureTitle), einen Überspringen-Umschalter (IsLeadAllowSkip) und seinen LeadSkipText – die Beschriftung auf dem Überspringen-Button (Standard Skip). Er trägt außerdem zwei unabhängige Seitenzahl-Felder, LeadFormAfterPages und LeadAfterPages, die jeweils für sich gespeichert werden. Die beiden Seitenzahlen steuern betrachterseitig, wann das Formular erscheint; setze beide bewusst für das gewünschte Verhalten.

Die Standardfelder umschalten

PUT /api/set-lead-fields/{flipbookId} schaltet jedes Standard-Lead-Erfassungsfeld um (Name, E-Mail, Telefon, Firma, Datum) und legt fest, ob es Pflicht ist. Jedes Feld hat ein Is…-Flag, um es anzuzeigen, und ein Is…Mandatory-Flag, um es zu erfordern.

Der Body trägt außerdem LeadPhoneCountry, das das Standardland / die Standard-Vorwahl für das Telefonfeld festlegt. Es akzeptiert einen Wert wie US oder +1 und wird unverändert gespeichert; standardmäßig ist es leer.

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

Antwort:

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

Benutzerdefinierte Felder definieren

PUT /api/set-lead-custom-fields/{flipbookId} definiert zusätzliche benutzerdefinierte Felder auf dem Lead-Erfassungsformular, über die Standardfelder Name/E-Mail/Telefon hinaus. Jedes benutzerdefinierte Feld hat ein Anzeige-Flag, ein Pflicht-Flag und eine Beschriftung.

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

Antwort:

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

Die Feldbeschriftungen festlegen

PUT /api/set-lead-labels/{flipbookId} legt die Anzeigebeschriftungen und den Platzhaltertext für die Felder des Lead-Erfassungsformulars fest, inklusive des Absende-Buttons.

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

Antwort:

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

Mögliche Fehler

Diese gelten für alle vier Endpunkte:

• 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 (oder Authorization: Bearer) 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: …". Gleiche die genaue Schreibweise und Groß-/Kleinschreibung jedes Feldnamens mit den Beispielen oben ab.

Hinweise

• Um die Lead-Erfassung einzuschalten, aktiviere sie über set-lead-capture (IsLeadCapture=true), bevor du dich auf die Feld-, benutzerdefinierten Feld- und Beschriftungs-Endpunkte verlässt – diese konfigurieren das Formular, das die Basis-Sperre präsentiert.