Privacidade de leads e verificação de e-mail

O que você pode fazer

Quando um flipbook capta leads, você pode moldar duas partes dessa experiência pela API:

• Privacidade / consentimento — configure o texto e as opções de privacidade/consentimento da captação de leads (por exemplo, a caixa de consentimento LGPD), incluindo um link para a sua política de privacidade.
• Verificação de e-mail — ative ou desative a verificação de e-mail dos leads, exigindo que os leitores confirmem o e-mail antes do acesso.

Antes de começar

Você vai precisar de:

• 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/documento. Ele é retornado por create-by-file / create-by-url (como ID) ou por list. Ambos os endpoints o recebem como parâmetro de caminho.
• Todas as requisições vão para a URL base https://go.fliplink.me.

O corpo da requisição dos dois endpoints é form-urlencoded (não JSON).

Configure privacidade e consentimento

PUT /api/set-lead-privacy/{flipbookId} configura o texto e as opções de privacidade/consentimento da captação de leads (por exemplo, a caixa de consentimento LGPD).

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

Resposta:

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

Configure a verificação de e-mail

PUT /api/set-lead-verification/{flipbookId} ativa ou desativa a verificação de e-mail dos leads, exigindo que os leitores confirmem o e-mail antes do acesso.

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

Resposta:

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

Erros possíveis

• 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 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: ….

Notas

• O campo TwillioAPIKey mantém a grafia original Twillio — envie-o com esse nome exato.