Настройка просмотра и чтения флипбука

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

Эти пять эндпоинтов настраивают то, как один флипбук отображается в просмотрщике. Каждый нацелен на один флипбук по его {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). Передавайте каждое поле через --data-urlencode.

Задать элементы управления просмотрщика

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

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Ответ:

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

Задать навигацию читателя

Настраивает навигацию читателя в просмотрщике — то, как читатели переходят между страницами. Четыре поля тела:

• BookLayout (число) — числовой макет страницы. API сохраняет любое переданное значение.
• ScrollBehaviour (число) — числовой режим прокрутки; по умолчанию 1. Смысл каждого значения интерпретируется на стороне просмотрщика, а API сохраняет любое переданное значение.
• IsNavFirstLast (булево, true/false) — переключает навигацию к первой/последней странице.
• IsRightToLeft (булево, true/false) — задаёт чтение справа налево.

Примечание: эти настройки навигации читателя применяются только к флипбукам. Для элемента-документа они игнорируются — API отвечает This setting applies to Flipbook items only.

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Ответ:

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

Задать автоперелистывание

Включает или выключает автоматическое перелистывание страниц в просмотрщике и его интервал. Значение AutoFlipInSecs, несмотря на название, задаётся в миллисекундах: 0 = выкл., 3000 = 3 с, 5000 = 5 с и т. д.

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Ответ:

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

Задать фоновую музыку

Задаёт или очищает трек фоновой музыки, играющий в просмотрщике. Используйте имя файла предустановленного трека из /api/list-background-music в BackgroundMusic или URL собственной загруженной музыки в BackgroundMusicCustom.

curl -X PUT 'https://go.fliplink.me/api/set-background-music/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=' \
  --data-urlencode 'BackgroundMusicCustom=' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Ответ:

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

Задать макет колонтитулов

Задаёт содержимое, показываемое в четырёх углах (колонтитулах) обрамления просмотрщика: TopLeft, TopRight, BottomLeft и BottomRight.

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=' \
  --data-urlencode 'TopRight=' \
  --data-urlencode 'BottomLeft=' \
  --data-urlencode 'BottomRight='

Ответ:

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

Result, равный "OK", означает, что изменение применено; иначе читайте Message, чтобы узнать причину.