Руководство по интеграции для разработчиков
Обзор для разработчиков
WebChatAgent предлагает три способа предоставить Chatbot вашим пользователям. Выберите вариант в зависимости от того, какой уровень контроля над интерфейсом вам необходим.
| Интеграция | Что вы получаете | Лучше всего подходит для |
|---|---|---|
| Встраивание Widget | Готовый интерфейс чата с помощью одного тега script | Сайты и веб-приложения |
| REST API | Отправка сообщения, получение ответа (запрос/ответ) | Пользовательские интерфейсы, мобильные приложения, серверные скрипты |
| WebSocket API | Поток сообщений в реальном времени с индикацией набора текста и присутствия | Панели управления для live-чата, инструменты операторов |
| JavaScript SDK | Типизированный npm-пакет для REST и WebSocket API | Пользовательские интерфейсы чата на JavaScript или TypeScript |
| Вебхук | Новые лиды и встречи в виде подписанного JSON-запроса на ваш сервер | Синхронизация с CRM, автоматизации |
Все три варианта взаимодействуют с одним и тем же Chatbot, используют общую Базу знаний и расходуют единую квоту сообщений. Вы можете комбинировать их, например, встроить Widget на свой Сайт и создать внутреннюю Панель управления оператора на базе WebSocket API.
Встраивание Widget (Самая быстрая настройка)
Добавьте Chatbot на любой Сайт с помощью одного тега script и пользовательского HTML-элемента (<web-chat-agent chatbot-id="...">). Без фреймворков и этапа сборки. Все цвета, тексты и Инструменты настраиваются в Панели управления и применяются автоматически. Это подходящий выбор для 90% сайтов.
- Руководство по встраиванию Widget: тег script, пользовательский элемент, все HTML-атрибуты, Пользовательский CSS, режим Встроенного чата и использование в SPA
REST API
Если вам нужен собственный интерфейс чата (мобильное приложение, пользовательский веб-компонент или бэкенд-автоматизация), вызывайте эндпоинт чата напрямую. Вы отправляете message вместе с вашим chatbotId и получаете сгенерированный ИИ reply со ссылками на Источники. ID сессии, возвращаемый в заголовке ответа, сохраняет контекст многоэтапных Бесед.
- Справочник по REST API: эндпоинты, авторизация по Домену, поля запроса и ответа, коды ошибок и примеры кода на cURL, JavaScript, Python и PHP
JavaScript SDK
Создаете собственный интерфейс чата на JavaScript или TypeScript? Npm-пакет webchatagent оборачивает REST и WebSocket API: потоковые Ответы, Загрузка файлов, обратная связь, Формы для Лидов и live-чат с вашей командой, с полной поддержкой типов TypeScript и без зависимостей.
- JavaScript SDK: установка, первое Сообщение, потоковая передача, передача диалога человеку. Пакет в npm, исходный код на GitHub
WebSocket API
Для live-чата, где Сообщения должны доставляться мгновенно, требуются индикаторы набора текста, статус присутствия и автоматический Перевод. Тот же сокет обеспечивает работу пользовательских виджетов и Панели управления оператора. Используйте его для создания собственной консоли оператора или для управления live-чатом из вашего бэкенда.
- Справочник по WebSocket API: Подключение, Роли, отправляемые и получаемые события, а также рабочий пример клиента
Что выбрать?
| Сценарий использования | Рекомендуется |
|---|---|
| Добавить Chatbot на Сайт | Встраивание Widget |
| Отобразить Чат внутри макета вашей страницы | Встроенный чат (встраивание Widget) |
| Пользовательский интерфейс чата на JavaScript или TypeScript | JavaScript SDK |
| Пользовательский интерфейс чата или мобильное приложение | REST API |
| Автоматизация между серверами (без UI) | REST API |
| Панель управления live-чатом в реальном времени для операторов | WebSocket API |
Ознакомьтесь с разделом Сценарии использования, чтобы узнать о конкретных возможностях, которые открывают эти Интеграции.
