Configurare un modulo di cattura lead

Cosa puoi fare

Un modulo di cattura lead è una barriera che raccoglie i dati del lettore prima che questi legga il flipbook. Quattro endpoint ti permettono di costruire e configurare quel modulo interamente tramite l'API:

• Attivare e configurare la barriera di base — attiva la cattura lead, imposta il suo titolo, consenti (o blocca) di saltarla e controlla dopo quante pagine compare il modulo.
• Attivare/disattivare i campi standard — nome, email, telefono, azienda, data — e contrassegnare ciascuno come obbligatorio o facoltativo.
• Definire campi personalizzati extra oltre a quelli standard, con le proprie etichette.
• Impostare le etichette e il testo placeholder mostrati per ciascun campo.

Ogni endpoint agisce su un flipbook tramite il suo {flipbookId} e applica le modifiche con un unico PUT.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key, o come Authorization: Bearer YOUR_API_KEY, in ogni richiesta.
• Il {flipbookId} — l'ID numerico del flipbook, restituito da create-by-file / create-by-url (come ID) o da list. È un parametro nel percorso in tutti e quattro gli endpoint.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Ogni body di richiesta è form-urlencoded (non JSON) — invia i campi con --data-urlencode.

Attivare e configurare la barriera di base

PUT /api/set-lead-capture/{flipbookId} attiva e configura il modulo di cattura lead di base. Il flag di attivazione è IsLeadCapture (un errore comune è cercare IsEnabled — quel campo qui non esiste).

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'

Risposta:

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

Il body contiene il flag di attivazione (IsLeadCapture), un titolo del modulo (LeadCaptureTitle), un toggle per saltare (IsLeadAllowSkip) e il suo LeadSkipText — l'etichetta mostrata sul pulsante per saltare (predefinito Skip). Contiene anche due campi indipendenti per il conteggio delle pagine, LeadFormAfterPages e LeadAfterPages, ciascuno memorizzato per proprio conto. I due conteggi di pagine controllano lato lettore il momento in cui compare il modulo; impostali entrambi con attenzione per ottenere il comportamento che vuoi.

Attivare/disattivare i campi standard

PUT /api/set-lead-fields/{flipbookId} attiva/disattiva ciascun campo standard di cattura lead (nome, email, telefono, azienda, data) e se è obbligatorio. Ogni campo ha un flag Is… per mostrarlo e un flag Is…Mandatory per renderlo obbligatorio.

Il body contiene anche LeadPhoneCountry, che imposta il paese / prefisso predefinito per il campo del telefono. Accetta un valore come US o +1 e viene memorizzato così com'è; è vuoto per impostazione predefinita.

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

Risposta:

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

Definire campi personalizzati

PUT /api/set-lead-custom-fields/{flipbookId} definisce campi personalizzati extra sul modulo di cattura lead, oltre ai campi standard nome/email/telefono. Ogni campo personalizzato ha un flag di visualizzazione, un flag di obbligatorietà e un'etichetta.

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

Risposta:

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

Impostare le etichette dei campi

PUT /api/set-lead-labels/{flipbookId} imposta le etichette e il testo placeholder per i campi del modulo di cattura lead, incluso il pulsante di invio.

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

Risposta:

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

Errori possibili

Questi valgono per tutti e quattro gli endpoint:

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con Message: "Item not found".
• Campo del body sconosciuto o scritto male → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …". Rispetta l'esatta ortografia e le maiuscole/minuscole di ogni nome di campo negli esempi qui sopra.

Note

• Per attivare la cattura lead, abilitala tramite set-lead-capture (IsLeadCapture=true) prima di affidarti agli endpoint dei campi, dei campi personalizzati e delle etichette — quelli configurano il modulo che la barriera di base presenta.