API-довідник

Повний довідник для Widget API та REST-ендпоінтів.

Widget API

Глобальний об'єкт window.LaunchChatWidget надає методи для програмного керування віджетом.

Методи

open()

Програмно відкриває вікно чату.

window.LaunchChatWidget.open();

close()

Закриває вікно чату.

window.LaunchChatWidget.close();

destroy()

Повністю видаляє віджет зі сторінки. Корисно для SPA при навігації.

window.LaunchChatWidget.destroy();

init(config)

Повторно ініціалізує віджет з новою конфігурацією.

window.LaunchChatWidget.init({ widgetId: "new-widget-id" });

on(event, callback)

Підписатися на події віджета.

window.LaunchChatWidget.on('message', (data) => {
  console.log('New message:', data);
});

off(event, callback)

Відписатися від подій віджета.

Події

Подія	Payload	Опис
`open`	`{ timestamp }`	Вікно чату відкрито
`close`	`{ timestamp }`	Вікно чату закрито
`message`	`{ content, role }`	Повідомлення надіслано або отримано
`escalate`	`{ email, message }`	Користувач запросив живу підтримку
`feedback`	`{ messageId, type }`	Користувач надав відгук (позитивний/негативний)

REST API

POST /api/widget/chat

Надіслати повідомлення та отримати AI-згенеровану відповідь.

Тіло запиту

{
  "widgetId": "string",      // Required
  "message": "string",       // Required - user's question
  "conversationId": "string", // Optional - for context
  "visitorId": "string",     // Optional - track visitor
  "pageUrl": "string"        // Optional - current page
}

Відповідь

{
  "conversationId": "uuid",
  "messageId": "uuid",
  "answer": "string",
  "citations": [
    {
      "pageId": "string",
      "pageTitle": "string",
      "pageUrl": "string",
      "excerpt": "string"
    }
  ],
  "relatedArticles": [...],
  "confidenceScore": 0.85,
  "wasRefused": false
}

Коди помилок

Код	Статус	Опис
`400`	Невірний запит	Відсутні обов'язкові поля
`403`	Заборонено	Домен не в списку дозволених
`404`	Не знайдено	Віджет не знайдено або він неактивний
`429`	Перевищено ліміт	Перевищено квоту повідомлень
`500`	Помилка сервера	Внутрішня помилка обробки

TypeScript типи

Скопіюйте ці типи у свій проєкт для повної типобезпеки:

interface LaunchChatConfig {
  widgetId: string;
  primaryColor?: string;
  greeting?: string;
  placeholder?: string;
  position?: 'bottom-right' | 'bottom-left';
  theme?: 'light' | 'dark' | 'auto';
}

interface WidgetAPI {
  open(): void;
  close(): void;
  destroy(): void;
  init(config: { widgetId: string }): Promise<void>;
  on<E extends keyof WidgetEvents>(
    event: E,
    callback: (data: WidgetEvents[E]) => void
  ): void;
  off<E extends keyof WidgetEvents>(
    event: E,
    callback: (data: WidgetEvents[E]) => void
  ): void;
}

interface WidgetEvents {
  open: { timestamp: number };
  close: { timestamp: number };
  message: { content: string; role: 'user' | 'assistant' };
  escalate: { email: string; message: string };
  feedback: { messageId: string; type: 'positive' | 'negative' };
}

declare global {
  interface Window {
    LaunchChatConfig?: LaunchChatConfig;
    LaunchChatWidget?: WidgetAPI;
  }
}