Настройка формы захвата лидов

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

Форма захвата лидов — это заслон, который собирает данные зрителя, прежде чем тот прочитает флипбук. Четыре эндпоинта позволяют построить и настроить эту форму целиком через API:

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

Каждый эндпоинт нацелен на один флипбук по его {flipbookId} и применяет изменения одним PUT.

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

• 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) — передавайте поля через --data-urlencode.

Включение и настройка базового заслона

PUT /api/set-lead-capture/{flipbookId} включает и настраивает базовую форму захвата лидов. Флаг включения — IsLeadCapture (частая ошибка — искать IsEnabled; такого поля здесь нет).

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'

Ответ:

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

Тело содержит флаг включения (IsLeadCapture), заголовок формы (LeadCaptureTitle), переключатель пропуска (IsLeadAllowSkip) и его LeadSkipText — подпись на кнопке пропуска (по умолчанию Skip). Оно также содержит два независимых поля счётчика страниц, LeadFormAfterPages и LeadAfterPages, каждое из которых хранится самостоятельно. Два счётчика страниц управляют на стороне просмотрщика тем, когда появляется форма; задавайте оба осознанно для нужного вам поведения.

Переключение стандартных полей

PUT /api/set-lead-fields/{flipbookId} переключает каждое стандартное поле захвата лидов (имя, email, телефон, компания, дата) и то, является ли оно обязательным. У каждого поля есть флаг Is…, чтобы показать его, и флаг Is…Mandatory, чтобы сделать его обязательным.

Тело также содержит LeadPhoneCountry, которое задаёт страну по умолчанию / телефонный код для поля телефона. Оно принимает значение вроде US или +1 и сохраняется как есть; по умолчанию пусто.

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

Ответ:

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

Определение произвольных полей

PUT /api/set-lead-custom-fields/{flipbookId} определяет дополнительные произвольные поля на форме захвата лидов, сверх стандартных имя/email/телефон. У каждого произвольного поля есть флаг показа, флаг обязательности и подпись.

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

Ответ:

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

Задание подписей полей

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

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

Ответ:

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

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

Относятся ко всем четырём эндпоинтам:

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

Примечания

• Чтобы включить захват лидов, включите его через set-lead-capture (IsLeadCapture=true), прежде чем полагаться на эндпоинты полей, произвольных полей и подписей — они настраивают форму, которую показывает базовый заслон.