Een lead-captureformulier instellen

Wat je kunt doen

Een lead-captureformulier is een gate die kijkersgegevens verzamelt voordat ze de flipbook lezen. Met vier endpoints bouw en configureer je dat formulier volledig via de API:

• Schakel de basisgate in en configureer die — zet lead capture aan, stel de titel in, sta overslaan toe (of blokkeer het), en bepaal na hoeveel pagina's het formulier verschijnt.
• Zet de standaardvelden aan of uit — naam, e-mail, telefoon, bedrijf, datum — en markeer elk als verplicht of optioneel.
• Definieer extra aangepaste velden naast de standaardset, met eigen labels.
• Stel de weergavelabels en placeholdertekst in die voor elk veld worden getoond.

Elk endpoint richt zich op één flipbook via zijn {flipbookId} en past wijzigingen toe met één PUT.

Voordat je begint

• Een API-sleutel — meegestuurd als de X-Api-Key-header, of als Authorization: Bearer YOUR_API_KEY, op elk verzoek.
• De {flipbookId} — de numerieke ID van de flipbook, teruggegeven door create-by-file / create-by-url (als ID) of door list. Het is een padparameter op alle vier de endpoints.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• Elke request-body is form-urlencoded (geen JSON) — stuur velden met --data-urlencode.

De basisgate inschakelen en configureren

PUT /api/set-lead-capture/{flipbookId} schakelt het basis-lead-captureformulier in en configureert het. De inschakelvlag is IsLeadCapture (een veelgemaakte fout is zoeken naar IsEnabled — dat veld bestaat hier niet).

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'

Response:

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

De body bevat de inschakelvlag (IsLeadCapture), een formulierkop (LeadCaptureTitle), een overslaan-toggle (IsLeadAllowSkip) en de bijbehorende LeadSkipText — het label op de overslaan-knop (standaard Skip). Hij bevat ook twee onafhankelijke paginatelvelden, LeadFormAfterPages en LeadAfterPages, die elk afzonderlijk worden opgeslagen. De twee paginatellingen bepalen aan de kijkerskant wanneer het formulier verschijnt; stel ze beide bewust in voor het gedrag dat je wilt.

De standaardvelden aan- of uitzetten

PUT /api/set-lead-fields/{flipbookId} zet elk standaard-lead-captureveld aan of uit (naam, e-mail, telefoon, bedrijf, datum) en bepaalt of het verplicht is. Elk veld heeft een Is…-vlag om het te tonen en een Is…Mandatory-vlag om het verplicht te maken.

De body bevat ook LeadPhoneCountry, dat het standaardland / de standaard-landcode voor het telefoonveld instelt. Het accepteert een waarde zoals US of +1 en wordt opgeslagen zoals hij is; standaard is het leeg.

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

Response:

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

Aangepaste velden definiëren

PUT /api/set-lead-custom-fields/{flipbookId} definieert extra aangepaste velden op het lead-captureformulier, naast de standaard naam/e-mail/telefoon. Elk aangepast veld heeft een toon-vlag, een verplicht-vlag en een label.

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

Response:

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

De veldlabels instellen

PUT /api/set-lead-labels/{flipbookId} stelt de weergavelabels en placeholdertekst in voor de velden van het lead-captureformulier, inclusief de verzendknop.

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

Response:

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

Mogelijke fouten

Deze gelden voor alle vier de endpoints:

• 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 (of Authorization: Bearer) 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: …". Neem de exacte spelling en hoofdlettergebruik van elke veldnaam over uit de voorbeelden hierboven.

Opmerkingen

• Om lead capture aan te zetten, schakel je die eerst in via set-lead-capture (IsLeadCapture=true) voordat je op de veld-, aangepaste-veld- en label-endpoints vertrouwt — die configureren het formulier dat de basisgate toont.