Метаданные, произвольный URL и публикация

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

Эти четыре эндпоинта управляют тем, как флипбук представляет себя, — его заголовком и SEO-метаданными, его состоянием публикации, его URL для общего доступа и видом опыта чтения. Каждый нацелен на один флипбук по его {flipbookId}:

• Задать заголовок и SEO-мета — Title, Description, TitleColor и флаг IsPublished.
• Опубликовать или снять с публикации, не трогая заголовок или описание.
• Дать ему произвольный (красивый) slug для URL общего доступа.
• Настроить вид страницы в просмотрщике — глубину страницы и тип обложки.

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

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

Задать заголовок и SEO-мета

PUT /api/set-meta/{flipbookId} задаёт заголовок и SEO-мета флипбука — Title, Description, TitleColor и флаг IsPublished. Это перезаписывает Title/Description/TitleColor. Чтобы изменить только состояние публикации, используйте set-published (ниже). TitleColor принимает hex-цвет с ведущим # (например, #1a1a1a; по умолчанию #000000) и сохраняется как есть.

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

Ответ:

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

Опубликовать или снять с публикации

PUT /api/set-published/{flipbookId} переключает ТОЛЬКО флаг публикации, оставляя Title/Description/TitleColor нетронутыми (в отличие от set-meta). Используйте его, чтобы (пере)опубликовать флипбук — например, тот, что вернулся неопубликованным из create-by-file. IsPublished обязателен: true/1 = опубликовать, false/0 = снять с публикации.

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

Ответ:

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

Задать произвольный URL

PUT /api/set-custom-url/{flipbookId} задаёт произвольный (красивый) slug для URL общего доступа флипбука через поле CustomURL. Slug должен быть уникальным — занятый slug возвращает Result: "ERROR" (см. ошибки ниже).

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

Ответ:

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

Задать вид страницы

PUT /api/set-page-appearance/{flipbookId} настраивает вид страницы в просмотрщике. Этот эндпоинт сейчас предоставляет только два задаваемых поля: PageDepth (принимает flat, thin или thick) и CoverType (принимает soft или hard). Значения сохраняются дословно; более старые элементы при чтении через Get one могут возвращать другие значения (например, regular или числовое 1).

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Ответ:

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

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

Эти ошибки относятся ко всем четырём эндпоинтам (у custom-URL есть ещё одна своя):

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key (или Authorization: Bearer) присутствует и указан верно.
• ID элемента не найден или не принадлежит вашему ключу → HTTP 200 с { "Result": "ERROR", "Message": "Item not found" }.
• Произвольный URL уже занят (только set-custom-url) → HTTP 200 с { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Неизвестное поле тела запроса или опечатка в нём → HTTP 200 с Message: "Unknown field(s) '…'. Expected: …".

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

Примечания

• set-meta против set-published: set-meta перезаписывает Title/Description/TitleColor, поэтому если вы хотите изменить только состояние публикации, используйте set-published — он оставляет эти поля нетронутыми.