Отслеживание аналитики и ИИ-ассистент

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

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

• Добавить идентификаторы аналитики — коды Google Analytics, Google Tag Manager и Facebook Pixel.
• Задать ИИ-провайдера — имя провайдера и его API-ключ, используемые для ИИ-функций.
• Настроить виртуального ассистента — базовые настройки чат-помощника внутри просмотрщика (текст кнопки, цвета, промпт, эмбеддинги).
• Задать текст статусов ассистента — надписи, показываемые, пока ассистент слушает, записывает, обрабатывает и говорит.

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

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

Добавление идентификаторов аналитики

PUT /api/set-analytics-tracking/{flipbookId} добавляет ваши собственные идентификаторы аналитики (например, Google Analytics, GTM, Facebook Pixel) к размещённому флипбуку.

curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=' \
  --data-urlencode 'GoogleAnalyticsCode=' \
  --data-urlencode 'GoogleTagManager='

Ответ:

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

Настройка ИИ-провайдера

PUT /api/set-ai-provider/{flipbookId} настраивает ИИ-провайдера, используемого для ИИ-функций — имя провайдера (AIProvider) и его API-ключ (AIKey).

curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=' \
  --data-urlencode 'AIKey='

Ответ:

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

Настройка виртуального ассистента

PUT /api/set-virtual-assistant/{flipbookId} настраивает базовые параметры виртуального ассистента (чат/помощь) внутри просмотрщика. IsVA включает или выключает ассистента, VAText содержит промпт / инструкции ассистента, а VAEmbeddings содержит блоб эмбеддингов (строку).

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=' \
  --data-urlencode 'VAButtonColor=' \
  --data-urlencode 'VAButtonTextColor=' \
  --data-urlencode 'VAText=' \
  --data-urlencode 'VAEmbeddings='

Ответ:

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

Настройка текста статусов ассистента

PUT /api/set-virtual-assistant-status-text/{flipbookId} задаёт текст статусов/приветствия, показываемый виртуальным ассистентом внутри просмотрщика. Четыре поля — это надписи для каждого состояния: VAButtonStatus1 (слушает), VAButtonStatus2 (записывает), VAButtonStatus3 (обрабатывает) и VAButtonStatus4 (говорит).

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=' \
  --data-urlencode 'VAButtonStatus2=' \
  --data-urlencode 'VAButtonStatus3=' \
  --data-urlencode 'VAButtonStatus4='

Ответ:

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

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

У всех четырёх эндпоинтов одинаковое поведение при ошибках:

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