Configurar um formulário de captação de leads

O que você pode fazer

Um formulário de captação de leads é uma barreira que coleta os dados do leitor antes de ele ler o flipbook. Quatro endpoints permitem montar e configurar esse formulário inteiramente pela API:

• Ativar e configurar a barreira base — ative a captação de leads, defina o título, permita (ou bloqueie) pular, e controle depois de quantas páginas o formulário aparece.
• Alternar os campos padrão — nome, e-mail, telefone, empresa, data — e marcar cada um como obrigatório ou opcional.
• Definir campos personalizados extras além do conjunto padrão, com seus próprios rótulos.
• Definir os rótulos de exibição e o texto de placeholder mostrados em cada campo.

Cada endpoint atua sobre um flipbook pelo seu {flipbookId} e aplica as mudanças com um único PUT.

Antes de começar

• Uma chave de API — enviada como cabeçalho X-Api-Key, ou como Authorization: Bearer YOUR_API_KEY, em toda requisição.
• O {flipbookId} — o ID numérico do flipbook, retornado por create-by-file / create-by-url (como ID) ou por list. É um parâmetro de caminho nos quatro endpoints.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• Cada corpo de requisição é form-urlencoded (não JSON) — envie os campos com --data-urlencode.

Ative e configure a barreira base

PUT /api/set-lead-capture/{flipbookId} ativa e configura o formulário base de captação de leads. A flag de ativação é IsLeadCapture (um erro comum é procurar por IsEnabled — esse campo não existe aqui).

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'

Resposta:

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

O corpo carrega a flag de ativação (IsLeadCapture), um título de formulário (LeadCaptureTitle), um toggle de pular (IsLeadAllowSkip) e o LeadSkipText dele — o rótulo mostrado no botão de pular (padrão Skip). Ele também carrega dois campos independentes de contagem de páginas, LeadFormAfterPages e LeadAfterPages, cada um armazenado por conta própria. As duas contagens de páginas controlam, no lado do visualizador, quando o formulário aparece; defina os dois de propósito para o comportamento que você quer.

Alterne os campos padrão

PUT /api/set-lead-fields/{flipbookId} alterna cada campo padrão de captação de leads (nome, e-mail, telefone, empresa, data) e se ele é obrigatório. Cada campo tem uma flag Is… para exibi-lo e uma flag Is…Mandatory para torná-lo obrigatório.

O corpo também carrega LeadPhoneCountry, que define o país / código de discagem padrão do campo de telefone. Ele aceita um valor como US ou +1 e é armazenado como está; tem padrão vazio.

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

Resposta:

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

Defina campos personalizados

PUT /api/set-lead-custom-fields/{flipbookId} define campos personalizados extras no formulário de captação de leads, além dos campos padrão de nome/e-mail/telefone. Cada campo personalizado tem uma flag de exibição, uma flag de obrigatório e um rótulo.

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

Resposta:

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

Defina os rótulos dos campos

PUT /api/set-lead-labels/{flipbookId} define os rótulos de exibição e o texto de placeholder dos campos do formulário de captação de leads, incluindo o botão de envio.

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

Resposta:

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

Erros possíveis

Estes se aplicam aos quatro endpoints:

• Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key (ou Authorization: Bearer) está presente e correto.
• ID do item não encontrado ou não pertencente à sua chave → HTTP 200 com Message: "Item not found".
• Campo do corpo desconhecido ou digitado errado → HTTP 200 com Message: "Unknown field(s) '…'. Expected: …". Combine a grafia e o uso de maiúsculas/minúsculas exatos de cada nome de campo dos exemplos acima.

Notas

• Para ativar a captação de leads, habilite-a via set-lead-capture (IsLeadCapture=true) antes de depender dos endpoints de campo, campo personalizado e rótulo — eles configuram o formulário que a barreira base apresenta.