Конфиденциальность лидов и подтверждение email

Что можно сделать

Когда флипбук захватывает лидов, вы можете настроить два аспекта этого процесса через API:

• Конфиденциальность / согласие — настроить текст и параметры конфиденциальности/согласия для захвата лидов (например, флажок согласия GDPR), включая ссылку на вашу политику конфиденциальности.
• Подтверждение email — включить или выключить подтверждение email лида, требуя от зрителей подтвердить свой email перед доступом.

Перед началом

Понадобится:

• API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY в каждом запросе.
• {flipbookId} — числовой ID флипбука/документа. Он возвращается из create-by-file / create-by-url (как ID) или из list. Оба эндпоинта принимают его как параметр пути.
• Все запросы идут на базовый URL https://go.fliplink.me.

Тело запроса для обоих эндпоинтов — form-urlencoded (не JSON).

Настройка конфиденциальности и согласия

PUT /api/set-lead-privacy/{flipbookId} настраивает текст и параметры конфиденциальности/согласия для захвата лидов (например, флажок согласия GDPR).

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

Ответ:

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

Настройка подтверждения email

PUT /api/set-lead-verification/{flipbookId} включает или выключает подтверждение email лида, требуя от зрителей подтвердить свой email перед доступом.

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

Ответ:

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

Возможные ошибки

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key присутствует и указан верно.
• ID элемента не найден или не принадлежит вашему ключу → HTTP 200 с Message Item not found.
• Неизвестное поле тела запроса или опечатка в нём → HTTP 200 с Message Unknown field(s) '…'. Expected: ….

Примечания

• Поле TwillioAPIKey сохраняет исходное написание Twillio — передавайте его именно под этим именем.