FlipLink

Добавление призывов к действию во флипбук

Призывы к действию

Настраивайте основную и дополнительную кнопки призыва к действию флипбука и управляйте тем, скрывается ли CTA, пока читатели находятся в режиме предпросмотра.

API, используемые в этом обсуждении

Что-то в этом руководстве неточно или устарело?

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

Просмотрщик флипбука может показывать кнопки призыва к действию (CTA), которые ведут читателей туда, куда вы выберете. Настроить их через API позволяют три эндпоинта:

  • Задать основную кнопку CTA — её надпись, URL, цвет и то, показывается ли она.
  • Задать дополнительную кнопку CTA — вторую кнопку через поля с суффиксом 2.
  • Задать правила предпросмотра — управлять тем, скрывается ли CTA, пока читатель находится в предпросмотре.

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

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

Настройка основной кнопки CTA

Настраивает основную кнопку призыва к действию в просмотрщике (надпись, URL, цвет). Поля — это IsCTAButton, CTAButtonText, CTAButtonURL (плюс поля цвета), а не Text/URL/Position. Значение CTAButtonURL с префиксом mailto: / tel: автоматически нормализуется на стороне сервера.

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=' \
  --data-urlencode 'CTAButtonColor=' \
  --data-urlencode 'CTAButtonURL=' \
  --data-urlencode 'CTAButtonTextColor='

Ответ:

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

Настройка дополнительной кнопки CTA

Настраивает дополнительную кнопку призыва к действию в просмотрщике. Дополнительная кнопка использует поля с суффиксом 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (плюс поля цвета с суффиксом 2).

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=' \
  --data-urlencode 'CTAButtonColor2=' \
  --data-urlencode 'CTAButtonTextColor2=' \
  --data-urlencode 'CTAButtonURL2='

Ответ:

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

Настройка правил предпросмотра

Настраивает, когда призыв к действию показывается читателям, — правило заслона в предпросмотре. Передавайте IsCTAHiddenInPreview, чтобы управлять тем, скрывается ли CTA, пока читатель находится в предпросмотре.

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

Ответ:

{
  "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: …". Перепроверьте точное написание полей (например, поля дополнительной кнопки с суффиксом 2).

Примечания

  • Все три эндпоинта используют один и тот же параметр пути {flipbookId} и одинаковую форму успешного ответа { "Result": "OK", "Message": "Updated successfully" }.
  • Основная и дополнительная кнопки настраиваются независимо — эндпоинт дополнительной кнопки принимает только имена полей с суффиксом 2.