Обложка и превью-изображения

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

Два эндпоинта записи управляют PDF-файлами, которые заменяют флипбук, пока читатель не получит полный доступ:

• Задать превью-PDF, показываемый читателям до захвата лидов / оплаты.
• Задать PDF из изображений, используемый для миниатюр и превью.

Каждый вызов нацелен на один флипбук по его {flipbookId} и возвращает простой результат успеха.

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

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

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

Задать превью-PDF

PUT /api/set-preview-pdf/{flipbookId} задаёт превью-PDF, показываемый читателям до захвата лидов / оплаты. Он автоматически очищается, если выключены и захват лидов, и режим продажи.

Передавайте URL используемого PDF как PreviewPDF:

• PreviewPDF — URL PDF, показываемого как превью. Значение сохраняется как есть; API не проверяет, что URL доступен (проверено на живом сервере), поэтому передавайте корректный, доступный URL PDF. По умолчанию пусто (превью-PDF нет).

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

Ответ:

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

Задать PDF из изображений

PUT /api/set-image-pdf/{flipbookId} задаёт PDF из одних изображений/превью, используемый для миниатюр и превью. Передавайте URL используемого PDF как IMGPdf:

• IMGPdf — URL PDF из одних изображений, используемого для миниатюр и превью. Значение сохраняется как есть; API не проверяет, что URL доступен (проверено на живом сервере), поэтому передавайте корректный, доступный URL PDF. По умолчанию — заглушка без изображения, а отправка пустого значения сохраняет существующий PDF из изображений.

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'

Ответ:

{
  "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: ….

Примечания

• Для обоих полей значение URL сохраняется как есть — API не проверяет, что PDF доступен (проверено на живом сервере). Всегда передавайте корректный, доступный URL PDF.
• Превью-PDF (PreviewPDF) по умолчанию пуст и автоматически очищается, если выключены и захват лидов, и режим продажи.
• PDF из изображений (IMGPdf) по умолчанию — заглушка без изображения; отправка пустого значения сохраняет существующий PDF из изображений.