Получение флипбуков и их данных

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

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

• Получить один флипбук — его полную запись по flipbookId.
• Найти по URL — найти флипбук по его публичному URL / ссылке для общего доступа.
• Получить список ваших флипбуков/документов с постраничной разбивкой.
• Получить URL PDF — публичную S3-ссылку на основной PDF элемента.
• Получить ссылку для общего доступа — публичный URL просмотрщика элемента.

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

• API-ключ — передаётся в каждом запросе как заголовок X-Api-Key или Authorization: Bearer YOUR_API_KEY.
• Все запросы идут на базовый URL https://go.fliplink.me.
• Три из этих эндпоинтов принимают параметр пути {flipbookId} — числовой ID флипбука/документа, возвращаемый из create-by-file / create-by-url (как ID) или из List. Два других (Find by URL, List) принимают вместо этого параметры строки запроса.
• Все пять — это GET-запросы, тело запроса они не отправляют.

Получить один флипбук

GET /api/get/{flipbookId} возвращает полную запись одного флипбука/документа по ID — каждый сохранённый столбец: заголовок, URL-ы, счётчики просмотров/лидов/продаж, папку и флаги статуса. Полная запись возвращается обёрнутой в объект Item с ~190 столбцами; пример ниже — сокращённое, репрезентативное подмножество.

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

Ответ:

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

Найти флипбук по URL

GET /api/find-by-url находит флипбук по его публичному URL / ссылке для общего доступа и возвращает его полную запись (та же форма, что и у Get one). Передавайте полный URL просмотрщика, URL CNAME или просто голый slug CustomURL в query-параметре URL — сервер использует последний сегмент пути как slug.

curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https://go.fliplink.me/view/your-flipbook-slug' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ (сокращённый — полная запись содержит ~190 столбцов):

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "Pages": 8,
    "Folder": "-Folder",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsPublished": true,
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

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

GET /api/list выводит список ваших флипбуков/документов с постраничной разбивкой (PageNo/PageSize). Каждый элемент включает ID, заголовок, URL-ы, счётчики просмотров/лидов/продаж, папку и флаги статуса. Также можно фильтровать с помощью Folder и SearchText, листать через PageNo, PageSize и Offset и сортировать через SortBy и SortOrder.

SortBy принимает одно из Name, DocType, CreatedOn, NoOfViews, NoOfLeads (пусто = сортировка по умолчанию; неизвестные значения откатываются к значению по умолчанию). SortOrder — это ASC или DESC — игнорируется, если SortBy пусто, а неизвестные значения молча откатываются к значению по умолчанию.

curl -X GET 'https://go.fliplink.me/api/list?Folder=&SearchText=&PageNo=1&PageSize=25&Offset=0&SortBy=&SortOrder=' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

Получить URL PDF флипбука

GET /api/get-pdf/{flipbookId} возвращает публичный S3-URL основного PDF элемента (объединённую версию, если прикреплены передняя/задняя обёртки).

curl -X GET 'https://go.fliplink.me/api/get-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

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

Получить ссылку для общего доступа флипбука

GET /api/get-share-link/{flipbookId} возвращает публичный URL просмотрщика флипбука (его префикс собственного домена/хоста плюс публичный slug флипбука).

curl -X GET 'https://go.fliplink.me/api/get-share-link/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Ответ:

{
  "Result": "OK",
  "URL": "https://go.fliplink.me/view/your-flipbook-slug"
}

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

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key (или Authorization: Bearer) присутствует и указан верно. Это относится ко всем пяти эндпоинтам.
• Неизвестный flipbookId (или не принадлежащий вашему ключу) → HTTP 200, сообщение Item not found. Это относится к Get one, Get PDF URL и Get Share Link.

Примечания

• Get one и Find by URL возвращают одинаковую форму полной записи, обёрнутую в объект Item.
• List оборачивает свои результаты в массив Items и включает поля постраничной разбивки (TotalRecordCount, TotalItems, UserItems, PageSize, Capped).
• Get PDF URL и Get Share Link возвращают лишь одно поле URL рядом с Result.