Брендирование флипбука (логотип, фавикон, скин, фон)

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

Пять эндпоинтов записи позволяют брендировать размещённый просмотрщик флипбука, не заходя в панель управления. Каждый нацелен на один флипбук (по его {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-logo/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=' \
  --data-urlencode 'LogoURL=' \
  --data-urlencode 'IsShowLogoMobile=false'

Этот эндпоинт принимает три поля тела:

• LogoIMG — само изображение логотипа (его URL/путь). Это изображение показывается в области заголовка/брендинга просмотрщика.
• LogoURL — ссылка перехода, на которую указывает логотип; клик по логотипу открывает этот URL. По умолчанию https://fliplink.me.
• IsShowLogoMobile — булево (true / false, по умолчанию false), которое переключает, показывается ли логотип на мобильных устройствах.

Ответ:

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

Задать фавикон

Задаёт фавикон (иконку вкладки браузера), используемый страницей размещённого просмотрщика флипбука.

curl -X PUT 'https://go.fliplink.me/api/set-favicon/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG='

Ответ:

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

Применить скин

Применяет скин/тему просмотрщика к флипбуку; сервер сопоставляет имя скина с его ID. Поле — это SkinName (строка из list-skins), а не числовой ID.

curl -X PUT 'https://go.fliplink.me/api/set-skin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName='

Ответ:

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

Задать фоновое изображение

Задаёт фоновое изображение просмотрщика из указанного вами URL (встроенной галереи нет). BackgroundIMG принимает URL изображения или URL-заглушку вроде https://plchldr.co/i/100x100?text=&bg=HEX. Любое значение цвета — это hex-строка #RRGGBB и сохраняется как есть.

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

Ответ:

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

Задать текст загрузки

Задаёт произвольный текст, показываемый на экране загрузки просмотрщика. Поле — это CustomLoadingText, а не LoadingText.

curl -X PUT 'https://go.fliplink.me/api/set-loading-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText='

Ответ:

{
  "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 Skin передавайте Name скина (из /api/list-skins) в SkinName — а не числовой ID.
• Для Set Loading Text поле — это CustomLoadingText; отправка LoadingText будет отклонена как неизвестное поле.
• Для Set Background Image встроенной галереи нет — URL изображения вы указываете сами.