API для разработчиков · REST

Справочник по FlipLink API

Создавайте flipbooks и документы, настраивайте вьюер, собирайте лиды и управляйте собственными доменами — всё программно. Аутентифицируйтесь своим API-ключом и пробуйте каждый эндпоинт вживую прямо на этой странице.

Базовый URL https://go.fliplink.me

Получить ключ →

Введение

REST API FlipLink позволяет программно создавать flipbooks и документы и управлять ими — загружать PDF, настраивать вьюер, собирать лиды, управлять собственными доменами и не только. Каждый эндпоинт доступен по базовому URL ниже и аутентифицируется вашим API-ключом.

Базовый URL
https://go.fliplink.me

Аутентификация

Передавайте свой API-ключ в каждом запросе. Поддерживаются два варианта заголовка — используйте тот, что удобнее вашему HTTP-клиенту:

Заголовки аутентификации
X-Api-Key: YOUR_API_KEY
# — or —
Authorization: Bearer YOUR_API_KEY

Отсутствующий или неверный ключ отклоняется с HTTP 401 (HTML-страница «Unauthorized» — тела JSON нет, поэтому не пытайтесь его разобрать при 401). Как только ключ верен, любая другая ошибка приходит как HTTP 200 с Result: ERROR (см. ниже). Держите ключ в секрете — никогда не раскрывайте его в клиентском коде, который вы поставляете конечным пользователям.

Формат ответа и типы результата

Все ответы — в формате JSON и содержат поле верхнего уровня Result — у него ровно два значения:

  • "Result": "OK" — успех. Эндпоинты чтения добавляют свою нагрузку; эндпоинты записи добавляют понятное человеку Message (например, "Updated successfully"), а create/duplicate возвращают новые ID и URL.
  • "Result": "ERROR" — сбой, с полем Message, объясняющим причину.

Важно: только сбои аутентификации (401), слишком большие загрузки (413) и превышение лимита запросов (429) используют HTTP-статус, отличный от 200. Всё остальное — проверка данных, «не найдено», бизнес-правила — возвращает HTTP 200 с Result: ERROR, поэтому проверяйте Result, а не только статус.

Постраничная разбивка

Эндпоинты списков принимают query-параметры PageNo, PageSize и Offset. Опустите их, чтобы получить разумные значения по умолчанию.

Лимиты запросов

Каждый API-ключ ограничен 300 запросами в минуту. Окно фиксированное и сбрасывается на начале минуты по часам (это не скользящие 60 секунд). В каждом ответе текущий остаток приходит в заголовках:

Заголовки лимита запросов
X-RateLimit-Limit: 300          # requests allowed per minute
X-RateLimit-Remaining: 287      # requests left in the current window
X-RateLimit-Reset: 1781962140   # Unix epoch (seconds) when the window resets

При превышении лимита вы получаете HTTP 429. Дождитесь X-RateLimit-Reset (или сделайте паузу и повторите запрос) и следите за X-RateLimit-Remaining, чтобы оставаться в пределах лимита.

Лимиты и квоты тарифа

Ваша квота flipbooks возвращается в ответах create и в get-subscription-details как Flipbooks_Count / Flipbooks_Max / Flipbooks_Left. Максимальный размер загрузки доступен как MaxFileSizeMB.

Ошибки

Типичные ситуации, которые стоит обрабатывать (у каждого эндпоинта есть свои ниже):

  • 401 — отсутствует или неверный API-ключ (HTML-страница, без JSON)
  • 413 — загрузка превышает максимальный размер файла по тарифу
  • 429 — превышен лимит запросов; сделайте паузу и повторите
  • 200 + Result:ERROR — всё остальное: не найдено ("Item not found"), ошибка проверки ("Unknown field(s) …") или бизнес-правило ("This custom URL is already in use…", "File is not a valid PDF")

Профиль

Кто я

Возвращает аккаунт, которому принадлежит API-ключ, — UserID/VendorID, имя, email, бренд, URL приложения и максимальный размер загрузки по тарифу (MaxFileSizeMB).

GEThttps://go.fliplink.me/api/whoami

Предусловия — нет. Это корневой вызов: он аутентифицирует ваш API-ключ — предусловие для всех остальных эндпоинтов.

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/whoami
curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Получить профиль

Возвращает профиль аккаунта для этого API-ключа: отображаемое имя, телефон и URL изображения профиля.

GEThttps://go.fliplink.me/api/get-profile
ПредусловияКто я(нужен действующий API-ключ)Получить профиль

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/get-profile
curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Обновить профиль (частично)

Частичное обновление — пропущенные поля сохраняют прежние значения. Нужно передать хотя бы одно поле.

PUThttps://go.fliplink.me/api/set-profile
ПредусловияКто я(нужен действующий API-ключ)Обновить профиль (частично)

Параметры тела

Nameнапример Mark Stevens
Phonephoneнапример +14155550142
ProfileImageURLнапример https://...

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-profile
curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры тела

Подписка и платежи

Получить данные подписки

Возвращает текущий тариф и квоту: название плана, статус, стоимость, дату следующего счёта, максимальный размер файла, лимит элементов и CNAME, а также флаги функций.

GEThttps://go.fliplink.me/api/get-subscription-details
ПредусловияКто я(нужен действующий API-ключ)Получить данные подписки

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/get-subscription-details
curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Список платежей

Возвращает историю оплат — каждую покупку или продление тарифа с order ID, суммой, планом, датой и количеством элементов.

GEThttps://go.fliplink.me/api/list-payments
ПредусловияКто я(нужен действующий API-ключ)Список платежей

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-payments
curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Элементы — создание

Создать из файла

Создаёт flipbook (или document) из загруженного PDF, отправленного как multipart/form-data. Файл сохраняется, для него создаётся миниатюра, и запись регистрируется.

Примечания
- Что вы получите — Flipbook или Document — определяет заголовок запроса Host: go.fliplink.me (по умолчанию) возвращает Flipbooks, go.doclink.me — Documents.
- *_Count / *_Max / *_Left отражают квоту вашего тарифа уже после создания.
- Используйте полученный ID для последующих вызовов (set-meta, set-cta-primary, save-as-template и т. д.).
- Максимальный размер файла зависит от тарифа (см. MaxFileSizeMB из who-am-i).

POSThttps://go.fliplink.me/api/create-by-file
ПредусловияКто я(нужен действующий API-ключ)Создать из файла

Тело (multipart/form-data)

Filefile
Nameнапример My Document
Titleнапример My Title
DocTypeenumFlipbook или Document. На go.doclink.me всегда трактуется как Document.Одно из: Flipbook, Document

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/create-by-file
curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'
Пример ответа200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Тело (form-data)

Создать по URL

Создаёт flipbook (или document) из PDF по ссылке. Сервер скачивает FileURL, загружает файл в S3, создаёт миниатюру и регистрирует запись.

Примечания
- Префикс имён полей Flipbooks_* или Documents_* определяет заголовок запроса Host: go.fliplink.me (по умолчанию) возвращает Flipbooks, go.doclink.me — Documents.
- *_Count / *_Max / *_Left отражают квоту тарифа аккаунта уже после создания.
- Исходный URL должен ответить в пределах 60 секунд — медленные или недоступные источники завершаются ошибкой Source URL timed out after 60s. Для ненадёжных источников лучше использовать /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url
ПредусловияКто я(нужен действующий API-ключ)Создать по URL

Параметры тела

FileURLURLнапример https://example.com/document.pdf
Nameнапример My Document
Titleнапример My Title
DocTypeenumнапример FlipbookОдно из: Flipbook, Document

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200FileURL host is private / not allowed{ "Result": "ERROR", "Message": "FileURL host is not allowed." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/create-by-url
curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'
Пример ответа200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры тела

Элементы — чтение

Получить один

Возвращает полную запись одного flipbook или document по ID — все сохранённые столбцы: заголовок, URL, счётчики просмотров/лидов/продаж, папку и флаги статуса. Полная запись возвращается внутри объекта `Item` и содержит около 190 столбцов; пример ниже — сокращённое, репрезентативное подмножество.

GEThttps://go.fliplink.me/api/get/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Получить один

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/get/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "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"
  }
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Найти по URL

Находит flipbook по его публичному URL для просмотра/шаринга и возвращает полную запись (тот же формат, что и у get).

GEThttps://go.fliplink.me/api/find-by-url
ПредусловияКто я(нужен действующий API-ключ)Найти по URL

Query-параметры

URLURLПолный URL вьюера, URL на CNAME или просто чистый слаг CustomURL. Сервер берёт последний сегмент пути как слаг.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/find-by-url
curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "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",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Список

Выводит ваши flipbooks/documents с постраничной разбивкой (PageNo/PageSize). Каждый элемент включает ID, заголовок, URL, счётчики просмотров/лидов/продаж, папку и флаги статуса.

GEThttps://go.fliplink.me/api/list
ПредусловияКто я(нужен действующий API-ключ)Список

Query-параметры

Folder
SearchText
PageNonumberнапример 1
PageSizenumberнапример 25
Offsetnumberнапример 0
SortByenumНеобязательно. Одно из: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Пусто — сортировка по умолчанию; неизвестные значения тоже сбрасываются к ней.Одно из: Name, DocType, CreatedOn, NoOfViews, NoOfLeads
SortOrderenumНеобязательно. `ASC` или `DESC`. Игнорируется, если SortBy пуст. Неизвестные значения без предупреждения сбрасываются к значению по умолчанию.Одно из: ASC, DESC

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list
curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "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
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Получить URL PDF

Возвращает публичный URL основного PDF элемента в S3 (объединённую версию, если обёрнут передней/задней обложкой).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Получить URL PDF

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/get-pdf/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Элементы — изменение

Дублировать

Создаёт одну или несколько серверных копий flipbook — каждая копия получает собственный новый ID и URL для шаринга. За один раз можно создать до 20 копий (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Дублировать

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

Countnumber1–500 (на сервере ограничивается этим диапазоном)

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/duplicate/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'
Пример ответа200 OK
{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Заменить PDF (файл)

Загрузка через multipart. Автоматически заново объединяет с прикреплёнными передней/задней обложками, если они есть.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Заменить PDF (файл)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Тело (multipart/form-data)

Filefile

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/replace-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Тело (form-data)

Заменить PDF (URL)

Заменяет PDF существующего flipbook на файл, который сервер скачивает по указанной вами ссылке. Flipbook сохраняет свой ID, настройки и ссылку для шаринга.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Заменить PDF (URL)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

FileURLнапример https://example.com/new.pdf

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/replace-pdf-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Сохранить как шаблон (переключатель)

Помечает flipbook как многоразовый шаблон (Status=true) или убирает его из шаблонов (Status=false). Шаблоны появляются в list-templates и могут служить основой для новых flipbooks.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Сохранить как шаблон (переключатель)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

Statustrue | falsetrue/false. Если не указано, по умолчанию true.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/save-as-template/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Saved as template"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

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

Перемещает flipbook в папку для удобной организации. Папки создаются по запросу — укажите имя папки, которой ещё нет, и она создастся автоматически (отдельного вызова «создать папку» нет). Передайте пустое значение Folder, чтобы убрать flipbook из папки. Папка существует, только пока в ней есть хотя бы один flipbook, поэтому если убрать последний — папка исчезнет из list-folders. Имена папок могут содержать / (например, Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Назначить в папку

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

FolderИмя папки, в которую переместить flipbook — создаётся, если её нет (или используйте имя из list-folders). Передайте пустое значение, чтобы снять назначение.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/assign-to-folder/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать переднюю/заднюю обложку (файл)

Передняя и задняя обложки необязательны по отдельности — нужна хотя бы одна. Заново объединяется с существующим основным PDF.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать переднюю/заднюю обложку (файл)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Тело (multipart/form-data)

Frontfile
Backfile

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Тело (form-data)

Задать переднюю/заднюю обложку (URL)

Вариант set-front-back-page по ссылке — берёт переднюю/заднюю обложку из удалённого PDF по URL вместо загруженного файла.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать переднюю/заднюю обложку (URL)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

FrontURLнапример https://example.com/front.pdf
BackURLнапример https://example.com/back.pdf

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-front-back-page-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Убрать переднюю/заднюю обложку

Снимает обёртку из передней/задней обложки и восстанавливает FilePDF до исходного PDF без обёртки (MiddlePDF). Идемпотентно — flipbook без обёртки возвращает OK и ничего не меняет. Возвращает { Result, Message, URL (URL исходного PDF в S3) }. Старые объекты в S3 (объединённый / передняя / задняя обложка) не удаляются.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Убрать переднюю/заднюю обложку

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/clear-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Задать срок / снять срок действия

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

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать срок / снять срок действия

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

DaysnumberПередайте -1, чтобы снять срок действия
HoursnumberНеобязательно, по умолчанию 0

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-expiry/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Закрепить (переключатель)

Закрепляет или открепляет flipbook (состояние «со звёздочкой»), чтобы он поднимался в начало вашей панели.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Закрепить (переключатель)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

СвязанноеСписок
PUT/api/set-pin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Элементы — удаление

Удалить

Безвозвратно удаляет запись flipbook в базе данных. Учтите: связанные файлы в S3 при этом автоматически не удаляются.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Удалить

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

DELETE/api/delete/{flipbookId}
curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

CNAME (собственные домены)

Добавить CNAME

Привязывает уже активированный собственный домен (CNAME) к flipbook. Домен сначала нужно добавить и подтвердить через веб-панель (она настраивает DNS и SSL); этот эндпоинт лишь сохраняет привязку — он не проверяет DNS и не выпускает сертификаты.

Предусловия:
- CNAME уже должен быть в вашем аккаунте (добавлен через панель). Иначе: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Он должен укладываться в лимит CNAME вашего тарифа.

Параметры:
- CNAME (обязательно) — полное имя хоста, например docs.example.com
- IsCloudflare (необязательно, по умолчанию 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Добавить CNAME

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

CNAMEнапример docs.example.com
IsCloudflaretrue | falseНеобязательно. 0 (по умолчанию) или 1. Передайте 1, если ваш DNS работает через прокси Cloudflare.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/add-cname/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Список CNAME

Все собственные CNAME вызывающего аккаунта. Каждый элемент: { CNAME, Documents (число активных flipbooks), FlipbookIDs ([...] — ID активных flipbooks, привязанных к этому CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames
ПредусловияКто я(нужен действующий API-ключ)Список CNAME

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-cnames
curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Удалить CNAME

Удаляет привязку собственного домена (CNAME) от одного или всех ваших flipbooks. Два режима:

  • Массовый (по умолчанию): передайте CNAME=<host> и оставьте FlipbookID пустым — CNAME удаляется со всех ваших flipbooks.
  • Для одного flipbook: передайте FlipbookID=<id> — CNAME берётся из этого flipbook. Используйте для действия «Удалить CNAME» в строке таблицы.

Ответ (для одного flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Ответ (массовый): { "Result": "OK", "Message": "CNAME removed successfully" }
Отсутствуют оба: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Примечание: передавайте CNAME как query-параметр (а не как сегмент URL), чтобы избежать проблем с точками в имени хоста.

DELETEhttps://go.fliplink.me/api/delete-cname
ПредусловияКто я(нужен действующий API-ключ)Список CNAME(найдите CNAME / FlipbookID)Удалить CNAME

Query-параметры

CNAMEОбязательно для МАССОВОГО режима (удаляет CNAME со всех ваших flipbooks). Игнорируется, когда FlipbookID > 0 — тогда CNAME берётся из этого flipbook.
FlipbookIDnumberНеобязательно. Передайте ID flipbook > 0, чтобы удалить CNAME ТОЛЬКО с этого одного flipbook (режим для одного flipbook). Оставьте пустым/опустите/0 для массового режима (удалить со всех).

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

DELETE/api/delete-cname
curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Папки

Список папок

Выводит ваши папки, каждую как { Folder (имя), URL (GUID папки) }. Папки выводятся из назначений flipbooks (созданных через assign-to-folder), поэтому пустая папка не отображается. Имена папок используются в assign-to-folder (чтобы поместить flipbook) и set-team-member (чтобы ограничить доступ участника команды).

GEThttps://go.fliplink.me/api/list-folders
ПредусловияКто я(нужен действующий API-ключ)Список папок

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-folders
curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Участники команды

Список участников команды

Выводит участников команды (пользователей-вендоров) в вашем аккаунте с данными их доступа, в том числе папками, назначенными каждому участнику. Пароли никогда не возвращаются. Фильтр по IsActive.

GEThttps://go.fliplink.me/api/list-team-members
ПредусловияКто я(нужен действующий API-ключ)Список участников команды

Query-параметры

IsActivetrue | false1=активные (по умолчанию), 0=неактивные

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-team-members
curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Получить участника команды

Возвращает одного участника команды по его member ID (ID из list-team-members) — имя, email, статус активности и папки, назначенные участнику. Участник команды ограничен папками, заданными через set-team-member (поле Folders), поэтому ему доступны только flipbooks внутри этих папок. Пароли никогда не возвращаются. memberId — это ID участника команды (из List Team Members), а не ID flipbook; передача ID flipbook вернёт «Team member not found». Участник возвращается внутри объекта Item; Folders — это список папок через запятую, к которым у него есть доступ (пусто = без ограничения по папкам).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}
ПредусловияКто я(нужен действующий API-ключ)Создать или обновить участника команды(сначала создайте участника)Получить участника команды

Параметры пути

memberIdnumberID участника команды (из list-team-members). НЕ ID flipbook.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200No team member with that ID (e.g. you passed a flipbook ID){ "Result": "ERROR", "Message": "Team member not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/get-team-member/{memberId}
curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Создать или обновить участника команды

Создаёт нового участника команды (пользователя-вендора) или обновляет существующего — определяет, кто имеет доступ к вашему аккаунту и, через поле Folders, какими папками он ограничен (участник видит только flipbooks внутри назначенных ему папок). При успехе создаётся запись в журнале аудита.

Частые ошибки: имя участника — это одно поле Name, отдельных FirstName/LastName нет. Folders — это список имён папок через запятую из List Folders (например, Marketing,Sales); оставьте пустым, чтобы не ограничивать папками. Создание участника возвращает { Result:"OK", Message:"Team member created" } (путь обновления — когда передан ID — возвращает «Updated successfully»). Email участника не должен уже принадлежать пользователю FlipLink, а email с +-алиасами отклоняются.

POSThttps://go.fliplink.me/api/set-team-member
ПредусловияКто я(нужен действующий API-ключ)Список папок(имена для области Folders)Создать или обновить участника команды

Параметры тела

Nameнапример Jane
Emailemailнапример jane@example.com
IDnumberОпустите или -1, чтобы создать. >0, чтобы обновить.
PasswordОткрытый текст; шифруется на сервере. Пустое значение при обновлении сохраняет существующий пароль.
ProfileImageURL
FoldersПапки, которыми ограничен участник, — список имён папок через разделитель (из list-folders). Участнику доступны только flipbooks внутри этих папок.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/set-team-member
curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Team member created"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры тела

Сделать участника команды активным

Активирует или деактивирует участника команды, определяя, может ли он входить и работать с аккаунтом.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}
ПредусловияКто я(нужен действующий API-ключ)Создать или обновить участника команды(сначала создайте участника)Сделать участника команды активным

Параметры пути

memberIdnumberID участника команды (из list-team-members). НЕ ID flipbook.

Параметры тела

IsActivetrue | falseнапример true

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-team-member-active/{memberId}
curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Удалить участника команды

Мягкое удаление (деактивация). Участники команды никогда не удаляются окончательно — этот вызов деактивирует участника (REST-алиас для set-team-member-active с IsActive=false). История его платежей и ссылки в аудите остаются нетронутыми, и позже его можно снова активировать через PUT /api/set-team-member-active (IsActive=true).

Ответ: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}
ПредусловияКто я(нужен действующий API-ключ)Создать или обновить участника команды(сначала создайте участника)Удалить участника команды

Параметры пути

memberIdnumberID участника команды (из list-team-members). НЕ ID flipbook.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

DELETE/api/delete-team-member/{memberId}
curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Лиды и продажи

Список лидов

Выводит заявки лид-формы, собранные вашими flipbooks. Возвращает Items[], динамическую схему Columns[] (чтобы построить таблицу) и TotalRecordCount. Поддерживает постраничную разбивку и экспорт в CSV через IsDownload.

GEThttps://go.fliplink.me/api/list-leads
ПредусловияКто я(нужен действующий API-ключ)Список лидов

Query-параметры

ItemIDsID flipbooks через запятую ИЛИ вертикальную черту (пусто = все)
SearchText
PageNonumberнапример 1
Offsetnumberнапример 0
IsDownloadtrue | falseнапример true

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-leads
curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Список продаж

Выводит записи о продажах/покупках по вашим flipbooks (email покупателя, flipbook, сумма, дата) плюс определения столбцов для таблицы продаж. Поддерживает постраничную разбивку и экспорт в CSV через IsDownload.

GEThttps://go.fliplink.me/api/list-sales
ПредусловияКто я(нужен действующий API-ключ)Список продаж

Query-параметры

ItemIDs
SearchText
PageNonumberнапример 1
Offsetnumberнапример 0
IsDownloadtrue | falseнапример true
IsAbandonedtrue | falsetrue → возвращает продажи с брошенными корзинами вместо завершённых продаж

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-sales
curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Удалить лид

Удаляет один захваченный лид по его ID. Сегмент пути — это leadId; также передайте Email лида и его FlipbookID как query-параметры.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}
ПредусловияКто я(нужен действующий API-ключ)Список лидов(получите ID лида)Удалить лид

Параметры пути

leadIdnumberID лида (LeadID из list-leads).

Query-параметры

Emailemailнапример foo@example.com
FlipbookIDnumberнапример {{flipbookId}}

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

DELETE/api/delete-lead/{leadId}
curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Query-параметры

Удалить лиды (массово)

Массовое удаление лидов по фильтру. ОБЯЗАТЕЛЬНО хотя бы ОДНО из FlipbookID/Email/DateFrom/DateTo — вызов без фильтра отклоняется (пути «удалить всё» нет). Всегда ограничено вендором. Возвращает { Result, Deleted (количество) }. Заодно подчищает дочерние строки (журнал просмотров / клики по CTA / журнал экспорта в таблицу).

DELETEhttps://go.fliplink.me/api/delete-leads
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(ограничьте по FlipbookID)Удалить лиды (массово)

Query-параметры

FlipbookIDnumberНеобязательно. Удалить лиды только этого flipbook.
EmailemailНеобязательно. Точное совпадение email.
DateFromНеобязательно. Удалить лиды, захваченные в эту дату или позже (сверяется с Lead.CreatedOn). Любая распознаваемая дата, например 2026-01-01 или 2026-01-01T00:00:00Z.
DateToНеобязательно. Удалить лиды, захваченные в эту дату или раньше.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

DELETE/api/delete-leads
curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Записать покупку flipbook

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

Параметр пути: {flipbookId} — flipbook, помечаемый как купленный.

Тело (urlencoded):
- Email — email покупателя (обязательно)
- PaymentRef — ссылка вашего платёжного шлюза, например ID PaymentIntent в Stripe (обязательно)

Ответ (успех): { "Result": "OK", "Message": "Purchase recorded successfully" }
Ответ (ошибка): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Частые ошибки: передавайте PaymentRef; НЕ передавайте Amount/Currency — они выводятся на сервере из вашей платёжной ссылки.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Записать покупку flipbook

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailemailEmail покупателя (обязательно).
PaymentRefСсылка на платёж (payment-intent) от шлюза (обязательно). Для Stripe это ID PaymentIntent (`pi_...`).

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/set-flipbook-purchase/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Справочники

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

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

GEThttps://go.fliplink.me/api/list-templates
ПредусловияКто я(нужен действующий API-ключ)Список шаблонов

Query-параметры

DocTypenumber0 = Flipbook (по умолчанию), 1 = Document

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-templates
curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

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

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

GEThttps://go.fliplink.me/api/list-skins
ПредусловияКто я(нужен действующий API-ключ)Список скинов

Query-параметры

Typetrue | false0=скины Flipbook, 1=скины Document

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

СвязанноеЗадать скин
GET/api/list-skins
curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "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"
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Query-параметры

Список валют

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

GEThttps://go.fliplink.me/api/list-currencies
ПредусловияКто я(нужен действующий API-ключ)Список валют

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-currencies
curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

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

Выводит встроенные треки фоновой музыки, которые можно привязать к вьюеру flipbook.

GEThttps://go.fliplink.me/api/list-background-music
ПредусловияКто я(нужен действующий API-ключ)Список фоновой музыки

Без параметров.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

GET/api/list-background-music
curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Разделы — брендинг и контент

Задать мета

Задаёт заголовок и SEO-мета flipbook — Title, Description, TitleColor и флаг IsPublished.

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

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать мета

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

Title
Description
TitleColor
IsPublishedtrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-meta/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

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

Публикует или снимает с публикации flipbook — переключает ТОЛЬКО флаг публикации, не трогая Title/Description/TitleColor (в отличие от set-meta). Используйте, чтобы (повторно) опубликовать flipbook, например тот, что вернулся неопубликованным из create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Опубликовать / снять с публикации

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsPublishedtrue | falsetrue/1 = опубликовать, false/0 = снять с публикации (обязательно).

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

СвязанноеЗадать мета
PUT/api/set-published/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать скин

Применяет скин/тему вьюера к flipbook; сервер сам сопоставляет имя скина с его ID.

Частые ошибки: поле называется SkinName (строка из list-skins), а не числовой ID.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Список скинов(выберите SkinName)Задать скин

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

SkinNameИз /api/list-skins → столбец Name

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

СвязанноеСписок скинов
PUT/api/set-skin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать фоновое изображение

Задаёт фоновое изображение вьюера из указанного вами URL (встроенной галереи нет).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать фоновое изображение

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

BackgroundIMGURLURL изображения ИЛИ URL-заглушка вида https://plchldr.co/i/100x100?text=&bg=HEX

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-background-image/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать фавикон

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

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать фавикон

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

FaviconIMGURL

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

СвязанноеЗадать логотип
PUT/api/set-favicon/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

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

Настраивает внешний вид страницы вьюера — фон, тень страницы, отступы и другие параметры оформления. Значения сохраняются как есть; у более старых элементов при чтении через Get one могут отображаться другие значения (например, regular или число 1).

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать вид страницы

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

PageDepthenumflat | thin | thickОдно из: flat, thin, thick
CoverTypeenumsoft | hardОдно из: soft, hard

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-page-appearance/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать текст загрузки

Задаёт свой текст, который показывается на экране загрузки вьюера.

Частые ошибки: поле называется CustomLoadingText, а не LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать текст загрузки

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

CustomLoadingText

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-loading-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать свой URL

Задаёт собственный (запоминающийся) слаг для URL шаринга flipbook. Должен быть уникальным; занятый слаг возвращает Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать свой URL

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

CustomURL

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Custom URL already taken{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-custom-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать предпросмотр PDF

Задаёт PDF предпросмотра, который показывается читателям до захвата лида / оплаты. Автоматически очищается, если выключены и захват лидов, и режим продажи.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать предпросмотр PDF

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

PreviewPDFURL

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-preview-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать графический PDF

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

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать графический PDF

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IMGPdfURL

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-image-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — вьюер и чтение

Задать элементы управления вьюера

Показывает или скрывает отдельные кнопки панели вьюера (скачать, печать, поделиться, во весь экран, масштаб, миниатюры и т. д.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать элементы управления вьюера

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsShowControlstrue | falseнапример true
IsPrinttrue | falseнапример false
IsDownloadtrue | falseнапример false
IsThumbnailstrue | falseнапример true
IsSearchtrue | falseнапример true
IsSoundtrue | falseнапример true
IsFullscreentrue | falseнапример true
IsZoomtrue | falseнапример true
IsNotestrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-viewer-controls/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать навигацию читателя

Настраивает навигацию читателя во вьюере — миниатюры страниц, оглавление и способ перемещения между страницами.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать навигацию читателя

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsNavFirstLasttrue | falseнапример true
BookLayoutenum1=одиночная, 2=двойнаяОдно из: 1, 2
IsRightToLefttrue | falseнапример false
ScrollBehaviournumberЧисловой режим прокрутки

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-reader-navigation/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать автолистание

Включает или выключает автоматическое перелистывание страниц во вьюере и задаёт его интервал.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать автолистание

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

AutoFlipInSecsnumberВ МИЛЛИСЕКУНДАХ, несмотря на название. 0 = выкл., 3000 = 3 с, 5000 = 5 с и т. д.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-auto-flip/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать фоновую музыку

Задаёт или сбрасывает трек фоновой музыки, который играет во вьюере. Доступные треки см. в list-background-music.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Список фоновой музыки(выберите трек)Задать фоновую музыку

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

BackgroundMusicИмя файла встроенного трека (из /api/list-background-music)
BackgroundMusicCustomURLURL загруженного вами музыкального файла
IsBackgroundMusicLooptrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-background-music/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — CTA

Задать основной CTA

Настраивает основную кнопку призыва к действию во вьюере (текст, URL, положение, цвет).

Частые ошибки: поля называются IsCTAButton, CTAButtonText, CTAButtonURL (плюс положение/цвет), а не Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать основной CTA

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsCTAButtontrue | falseнапример false
CTAButtonText
CTAButtonColor
CTAButtonURLURLПрефиксы mailto: / tel: нормализуются на сервере автоматически
CTAButtonTextColor

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-cta-primary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать дополнительный CTA

Настраивает дополнительную кнопку призыва к действию во вьюере.

Частые ошибки: у дополнительной кнопки поля с суффиксом 2IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать дополнительный CTA

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsCTAButton2true | falseнапример false
CTAButtonText2
CTAButtonColor2
CTAButtonTextColor2
CTAButtonURL2URL

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-cta-secondary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать правила показа CTA

Настраивает, когда показывать призыв к действию читателям — например, после N страниц или N секунд (правила предпросмотра).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать правила показа CTA

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsCTAHiddenInPreviewtrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-cta-preview-rules/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — контроль доступа

Задать доступ по паролю

Включает или выключает защиту flipbook паролем и задаёт пароль доступа.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать доступ по паролю

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsPasswordProtectedtrue | falseнапример false
Password
PwdTitle
PwdPlaceholder
PwdButton

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-password-access/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать индексацию

Управляет индексацией размещённого flipbook поисковыми системами. IsNoIndex=true добавляет robots noindex, чтобы страница не индексировалась.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать индексацию

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsNoIndextrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-indexing/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать список разрешённых email

Ограничивает доступ к вьюеру списком разрешённых email-адресов (просмотр по приглашению).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать список разрешённых email

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailsAllowedСписок разрешённых email через разделитель

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-email-allow-list/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=<EmailsAllowed>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — захват лидов

Задать захват лидов (основное)

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

Частые ошибки: флаг включения называется IsLeadCapture, а не IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsLeadCapturetrue | falseнапример false
LeadCaptureTitle
IsLeadAllowSkiptrue | falseнапример false
LeadSkipText
LeadFormAfterPagesnumberнапример 0
LeadAfterPagesnumberнапример 0

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-capture/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать поля лида

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

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать поля лида

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsLeadEmailtrue | falseнапример true
IsLeadEmailMandatorytrue | falseнапример true
IsLeadNametrue | falseнапример true
IsLeadNameMandatorytrue | falseнапример false
IsLeadPhonetrue | falseнапример false
IsLeadPhoneMandatorytrue | falseнапример false
IsLeadCompanytrue | falseнапример false
IsLeadCompanyMandatorytrue | falseнапример false
IsLeadDatetrue | falseнапример false
IsLeadDateMandatorytrue | falseнапример false
LeadPhoneCountry

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать пользовательские поля лида

Определяет дополнительные пользовательские поля в форме захвата лидов, помимо стандартных имени/email/телефона.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать пользовательские поля лида

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsLeadCustom1true | falseнапример false
IsLeadCustom1Mandatorytrue | falseнапример false
Custom1Label
IsLeadCustom2true | falseнапример false
IsLeadCustom2Mandatorytrue | falseнапример false
Custom2Label

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-custom-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать подписи полей лида

Задаёт отображаемые подписи и текст-подсказки для полей формы захвата лидов.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать подписи полей лида

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

LeadEmailemail
LeadName
LeadPhonephone
LeadCompany
LeadDate
LeadButton

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-labels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать приватность лидов

Настраивает текст и параметры согласия/конфиденциальности для захвата лидов (например, чекбокс согласия по GDPR).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать приватность лидов

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsLeadPrivacyPolicytrue | falseнапример false
PrivacyPolicyURLURL
PrivacyPolicyText

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-privacy/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать проверку лидов

Включает или выключает проверку email лида, требуя от читателей подтвердить email перед доступом.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать проверку лидов

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsVerifyEmailtrue | falseнапример false
IsVerifyMobiletrue | falseнапример false
TwillioAPIKeyВаш API-ключ Twilio (имя поля сохраняет исходное написание «Twillio»).
EmailVerifyTitleText
EmailVerifyButtonText

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-verification/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать webhook для лидов

Задаёт URL webhook, который получает каждый новый лид (сохраняется как webhook нового лида). Используйте test-webhook, чтобы проверить, что он срабатывает.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать webhook для лидов

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

WebhookURL_NewLeadURLURL вашего эндпоинта — получает JSON-нагрузку по каждому новому лиду.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-webhook/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Проверить webhook

Отправляет ТЕСТОВУЮ нагрузку на настроенный webhook лидов flipbook, чтобы вы могли проверить формат доставки без реального лида. Возвращает ERROR «No lead webhook is configured for this flipbook.», если webhook не задан. Форма нагрузки совпадает с реальным лидом (ключи: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), но содержит фиктивные значения (pdf_id:"-1", pdf_name:"Test PDF", ...). Реальный лид не сохраняется, и уведомление по email не отправляется.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать webhook для лидов(сначала нужно настроить webhook)Проверить webhook

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

POST/api/test-webhook/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Задать Google Sheets для лидов

Подключает захват лидов к Google-таблице — новые лиды добавляются в указанную вами таблицу (sheet ID + имя).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать захват лидов (основное)(включите захват лидов)Задать Google Sheets для лидов

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

GoogleSheetURLURL
GoogleSheetIDKey
GoogleSheetName

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-lead-google-sheets/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — уведомления и шаблоны писем

Задать уведомления

Настраивает, какие email-уведомления вы получаете по этому flipbook (новый лид, новый просмотр, новая продажа).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать уведомления

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

NotificationsEmailemail
IsSendEmailOnViewtrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-notifications/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать шаблон письма — новый лид

Задаёт письмо, отправляемое при событии нового лида. Передайте пустые значения, чтобы восстановить шаблон NEW_LEAD по умолчанию.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать шаблон письма — новый лид

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailLeadSubject
EmailLeadBody

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-email-template-lead/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать шаблон письма — новый просмотр

Задаёт шаблон письма, отправляемого при уведомлении о новом просмотре. Передайте пустое значение, чтобы восстановить шаблон NEW_VIEW по умолчанию.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать шаблон письма — новый просмотр

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailViewSubject
EmailViewBody

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-email-template-view/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать шаблон письма — новая продажа

Задаёт шаблон письма, отправляемого при уведомлении о новой продаже. Передайте пустое значение, чтобы восстановить шаблон NEW_SALE по умолчанию.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать шаблон письма — новая продажа

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailSaleSubject
EmailSaleBody

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-email-template-sale/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — продажи

Задать настройки продажи

Настраивает продажу flipbook (цена, валюта, параметры). Включение режима продажи автоматически включает проверку email и делает email лида обязательным.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Список валют(выберите SaleCurr)Задать настройки продажи

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsForSaletrue | falseнапример false
SaleCurrИз /api/list-currencies
SaleAmountnumberнапример 0

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-sale-settings/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать текст страницы продажи

Задаёт маркетинговый текст, который показывается на странице продажи / оформления покупки flipbook.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать настройки продажи(включите продажу)Задать текст страницы продажи

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

SalePageTitle
SaleAccessPageTitle
SalePurchaseButtonText
SaleButtonText
SaleAccessButtonText
SaleButtonColor

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-sale-page-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать платёжный шлюз

Выбирает и настраивает платёжный шлюз, используемый при продаже этого flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать настройки продажи(включите продажу)Задать платёжный шлюз

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

SaleGatewayName
SaleGatewayKey
SaleGatewaySecret

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-sale-gateway/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — согласование

Задать кнопку согласования

Добавляет во вьюер кнопку запроса согласования. Её включение запускает рабочий процесс запроса на согласование.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(DocType=document — только элементы Document)Задать кнопку согласования

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsApprovalButtontrue | falseнапример false
ApprovalButtonText
ApprovalButtonColor
ApprovalButtonTextColor

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-approval-button/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать шаблоны писем согласования

Задаёт шаблоны писем, используемые в рабочем процессе согласования. Пустые значения подставляют шаблоны по умолчанию.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(DocType=document — только элементы Document)Задать шаблоны писем согласования

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

EmailApproveRequestSubject
EmailApproveRequestBody
EmailApproveRemindSubject
EmailApproveRemindBody
EmailApproveSubmitSubject
EmailApproveSubmitBody

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-approval-email-templates/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — шаринг

Задать главный переключатель шаринга

Главный выключатель кнопок шаринга во вьюере.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать главный переключатель шаринга

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsShareButtonstrue | falseнапример false

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-share-master/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать каналы шаринга

Включает каждый канал социального шаринга по отдельности (Facebook, X, LinkedIn, WhatsApp, email и т. д.) в меню шаринга вьюера.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать каналы шаринга

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsShareFacebooktrue | falseнапример true
IsShareTwittertrue | falseнапример true
IsShareWhatsApptrue | falseнапример true
IsShareTelegramtrue | falseнапример false
IsShareLinkedIntrue | falseнапример true
IsSharePinteresttrue | falseнапример false
IsShareReddittrue | falseнапример false
IsShareTumblrtrue | falseнапример false
IsShareMessengertrue | falseнапример false
IsShareEmailtrue | falseнапример true
IsShareLinetrue | falseнапример false
IsShareWeChattrue | falseнапример false
IsShareInstagramtrue | falseнапример false
IsShareFlipboardtrue | falseнапример false
IsShareGeneraltrue | falseнапример true

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-share-channels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Разделы — отслеживание и ИИ

Задать отслеживание аналитики

Добавляет ваши собственные ID отслеживания аналитики (например, Google Analytics, GTM, Facebook Pixel) в размещённый flipbook.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать отслеживание аналитики

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

FacebookAnalyticsCode
GoogleAnalyticsCode
GoogleTagManager

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-analytics-tracking/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать провайдера ИИ

Настраивает провайдера ИИ, используемого для ИИ-функций, — имя провайдера и его API-ключ.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать провайдера ИИ

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

AIProvider
AIKey

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-ai-provider/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать виртуального ассистента

Настраивает базовые параметры встроенного во вьюер виртуального ассистента (чат/помощь).

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать виртуального ассистента

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

IsVAtrue | falseнапример false
VAButtonText
VAButtonColor
VAButtonTextColor
VATextПромпт / инструкции для ассистента
VAEmbeddingsБлоб эмбеддингов (строка)

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-virtual-assistant/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела

Задать текст статусов виртуального ассистента

Задаёт текст статуса/приветствия, который показывает встроенный во вьюер виртуальный ассистент.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}
ПредусловияКто я(нужен действующий API-ключ)Создать из файла(получите flipbookId)Задать текст статусов виртуального ассистента

Параметры пути

flipbookIdnumberЧисловой ID flipbook/document — возвращается create-by-file / create-by-url (как ID) или list.

Параметры тела

VAButtonStatus1Подпись статуса прослушивания
VAButtonStatus2Подпись статуса записи
VAButtonStatus3Подпись статуса обработки
VAButtonStatus4Подпись статуса речи

Ответы с ошибкой

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

Отсутствующий/неверный ключ отклоняется с HTTP 401 (HTML-страница, без JSON). Любая другая ошибка возвращает HTTP 200 с { "Result": "ERROR", "Message": … } — поэтому всегда ветвитесь по Result, а не только по HTTP-статусу.

PUT/api/set-virtual-assistant-status-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'
Пример ответа200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

Вставьте свой API-ключ в поле «Ваш API-ключ» сверху — затем заполните поля ниже и отправьте.

Параметры пути — нужны, чтобы идентифицировать элемент

Параметры тела