Справочные списки (шаблоны, скины, валюты, музыка)

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

Четыре эндпоинта только для чтения возвращают справочные списки, на которые вы опираетесь при настройке флипбука. Каждый выводит допустимые варианты для конкретной настройки, поэтому вы можете выбрать ID или имя из списка и передать его в соответствующий эндпоинт записи:

• List templates — многоразовые шаблоны флипбуков, сохранённые в вашем аккаунте.
• List skins — доступные скины/темы просмотрщика, каждый со своим встроенным URL фона.
• List currencies — валюты, доступные при продаже флипбука.
• List background music — встроенные треки фоновой музыки, которые можно прикрепить к просмотрщику флипбука.

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

• Пройдите аутентификацию с помощью API-ключа — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY.
• Базовый URL: https://go.fliplink.me.
• Это GET-запросы без тела запроса и без параметров пути — варианты передаются как строки запроса там, где указано.

Список шаблонов

Выводит список многоразовых шаблонов флипбуков, сохранённых в вашем аккаунте. Фильтруйте по DocType. Используйте ID шаблона в сценариях save-as-template / create.

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Query-параметр DocType принимает 0 = Flipbook (по умолчанию) или 1 = Document.

Список скинов

Выводит список доступных скинов/тем просмотрщика; каждая строка содержит встроенный URL фона скина. Используйте Name скина с set-skin.

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

Query-параметр Type — булев: false = скины Flipbook, true = скины Document.

Список валют

Выводит список валют, доступных при продаже флипбука (для настроек продажи / оформления заказа).

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

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Список фоновой музыки

Выводит список встроенных треков фоновой музыки, которые можно прикрепить к просмотрщику флипбука.

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

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

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

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Это относится ко всем четырём эндпоинтам.