Руководство по интеграции для разработчиков
Обзор для разработчиков
WebChatAgent предоставляет три способа встроить Chatbot для ваших пользователей. Выберите подходящий в зависимости от того, какой уровень контроля над интерфейсом вам требуется.
| Интеграция | Что вы получаете | Оптимально для |
|---|---|---|
| Встраивание Widget | Готовый интерфейс Chat с помощью одного тега script | Сайты и веб-приложения |
| REST API | Отправка сообщения и получение ответа (запрос/ответ) | Пользовательские интерфейсы, мобильные приложения, серверные скрипты |
| WebSocket API | Поток сообщений в реальном времени с индикацией набора текста и статуса присутствия | Панели управления онлайн-чатом, инструменты операторов |
Все три варианта работают с одним и тем же 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
WebSocket API
Для онлайн-чата, где Сообщения должны доставляться мгновенно, а также требуются индикаторы набора текста, статус присутствия и автоматический Перевод. Тот же сокет обеспечивает работу пользовательских виджетов и Панели управления оператора. Используйте его для создания кастомной консоли оператора или для управления онлайн-чатом со своего бэкенда.
- Справочник по WebSocket API, Подключение, роли, отправляемые и получаемые события, а также рабочий пример клиента
Что выбрать?
| Сценарий использования | Рекомендуемое решение |
|---|---|
| Добавить Chatbot на Сайт | Встраивание Widget |
| Отобразить Чат внутри макета страницы | Встроенный чат (встраивание Widget) |
| Пользовательский интерфейс чата или мобильное приложение | REST API |
| Автоматизация взаимодействия между серверами (без интерфейса) | REST API |
| Панель управления онлайн-чатом в реальном времени для операторов | WebSocket API |
Ознакомьтесь с разделом Сценарии использования, чтобы узнать о практических возможностях применения этих интеграций.