Организация флипбуков с помощью папок и шаблонов

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

Эти три эндпоинта позволяют держать флипбуки в порядке, не заходя в панель управления:

• Получить список ваших папок, каждая из которых возвращается как имя и GUID папки.
• Назначить флипбук в папку — папки создаются по требованию, а отправка пустой папки убирает флипбук из его папки.
• Сохранить флипбук как многоразовый шаблон или убрать его из ваших шаблонов.

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

• API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY в каждом запросе.
• Все запросы идут на базовый URL https://go.fliplink.me.
• Два эндпоинта записи (assign-to-folder и save-as-template) используют параметр пути {flipbookId} — числовой ID флипбука, возвращаемый из create-by-file / create-by-url (как ID) или из list.
• Эти эндпоинты записи принимают тело в формате form-urlencoded (не JSON).

Получить список ваших папок

GET /api/list-folders выводит список ваших папок, каждую как { Folder (имя), URL (GUID папки) }. Папки выводятся из назначений флипбуков, поэтому пустая папка в списке не отображается.

curl -X GET 'https://go.fliplink.me/api/list-folders' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Назначить флипбук в папку

PUT /api/assign-to-folder/{flipbookId} перемещает флипбук в папку. Папки создаются по требованию — укажите имя папки, которой ещё нет, и она создастся автоматически (отдельного вызова «создать папку» нет). Имена папок могут содержать / (например, Marketing/Q2). Папка существует, только пока в ней есть хотя бы один флипбук, поэтому перемещение последнего флипбука из неё убирает папку из list-folders.

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

Ответ:

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Чтобы убрать флипбук из его папки, отправьте пустой Folder:

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder='

Сохранить флипбук как шаблон

PUT /api/save-as-template/{flipbookId} помечает флипбук как многоразовый шаблон (Status=true) или убирает его из шаблонов (Status=false). Шаблоны появляются в list-templates и могут служить основой для новых флипбуков. Status по умолчанию равен true, если он опущен.

curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

Ответ:

{
  "Result": "OK",
  "Message": "Saved as template"
}

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

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет.
• ID элемента не найден или не принадлежит вашему ключу (assign-to-folder, save-as-template) → HTTP 200 с Message: "Item not found".
• Неизвестное поле тела запроса или опечатка в нём (assign-to-folder, save-as-template) → HTTP 200 с Message: "Unknown field(s) '…'. Expected: …".

Примечания

• Имя Folder, которое вы назначаете, — это то же значение, что появляется под Folder в list-folders, поэтому вы можете повторно использовать имя существующей папки, чтобы добавить в неё больше флипбуков.