Страницы обложки, истечение срока ссылки и закрепление

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

Эти пять эндпоинтов позволяют управлять страницами обложки флипбука, истечением срока его ссылки и тем, закреплён ли он, — не заходя в панель управления:

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

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

• API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY в каждом запросе.
• Каждый эндпоинт здесь принимает параметр пути {flipbookId} — числовой ID флипбука, возвращаемый из create-by-file / create-by-url (как ID) или из list. В примерах ниже используется 96216.
• Все запросы идут на базовый URL https://go.fliplink.me.
• Эндпоинты страницы обложки из URL и set-expiry отправляют тело в формате form-urlencoded (не JSON). Эндпоинт страницы обложки из файла отправляет multipart form-data (загрузка файлов). Эндпоинты clear и pin тела не принимают.

Задать страницы обложки из файла

Прикрепите переднюю и/или заднюю страницы из загруженных PDF-файлов. Front/Back — каждое или оба необязательны, но хотя бы одно требуется. Страницы заново объединяются с существующим основным PDF.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Ответ:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Задать страницы обложки из URL

URL-вариант вышеописанного — прикрепляет переднюю/заднюю страницы из удалённого URL PDF вместо загруженного файла. Поля Front и Back отправляются как form-urlencoded.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Ответ:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Очистить страницы обложки

Убирает переднюю/заднюю обёртку, восстанавливая FilePDF до исходного PDF без обёртки (MiddlePDF). Операция идемпотентна — флипбук без обёртки возвращает OK и ничего не меняет. Ответ включает S3-URL восстановленного исходного PDF. Старые объединённые/передние/задние объекты S3 не удаляются. Тело не принимает.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Задать или убрать истечение срока

Задаёт или убирает автоистечение флипбука. Передавайте Days и Hours как целые числа. Hours необязателен и по умолчанию равен 0. Отправка Days=-1, Hours=0 полностью убирает истечение срока.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Ответ:

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

Чтобы убрать истечение срока, отправьте Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Закрепить или открепить

Закрепляет или открепляет флипбук (состояние со звёздочкой), чтобы он сортировался вверху вашей панели управления. Это переключатель, тело не принимает.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

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

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

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key присутствует и указан верно.
• Неизвестный flipbookId (или не принадлежащий вашему ключу) → HTTP 200 с "Message": "Item not found".
• Set front/back page (файл) — недопустимый PDF → HTTP 200 с "Message": "File is not a valid PDF.", когда загруженный файл не является читаемым PDF.
• Set front/back page (файл) — файл слишком велик → HTTP 413 с "Message": "File exceeds the maximum allowed upload size.", когда загрузка превышает максимальный размер файла тарифа.
• Set front/back page (URL) и Set expiry — неизвестное поле → HTTP 200 с "Message": "Unknown field(s) '…'. Expected: …", когда поле тела запроса написано с опечаткой или не распознано.