Документация

Инструкции по установке виджета, настройке и использованию API

Быстрый старт

После регистрации в личном кабинете вы получите уникальный идентификатор магазина (Shop UUID). Используйте его для установки виджета.

Установка виджета

Добавьте следующий скрипт перед закрывающим тегом </body> на все страницы вашего сайта:

<script async src="https://cdn.kesh-a.ru/widget.js" data-shop-id="SHOP_UUID"></script>

Замените SHOP_UUID на ваш идентификатор из личного кабинета.

Проверка установки

В разделе «Интеграция» личного кабинета есть кнопка «Проверить установку». Система отправит тестовое сообщение и подтвердит, что виджет корректно подключён.

Настройка в личном кабинете

  1. Сценарии — создайте дерево диалогов с условиями перехода, кнопками быстрого выбора и триггерами (ключевые слова).
  2. База знаний — загрузите PDF, DOCX, TXT или добавьте FAQ. Можно импортировать данные с сайта через URL-скрапинг.
  3. Дизайн — настройте цветовую схему виджета, аватар бота, приветственное сообщение и позицию на странице.
  4. Интеграция — подключите Telegram-бот для канала в мессенджере.

API (для разработчиков)

Виджет взаимодействует с backend через REST API и WebSocket. Основные эндпоинты:

Инициализация виджета

POST /api/v1/widget/init

Возвращает настройки дизайна, приветственное сообщение и создаёт сессию диалога. Параметры: shop_id (из data-атрибута скрипта).

Отправка сообщения (HTTP fallback)

POST /api/v1/widget/message

Используется, если WebSocket недоступен. Параметры: conversation_id, text, опционально quick_reply_id.

WebSocket (реалтайм)

WebSocket /ws/chat/{conversationUuid}

Канал для обмена сообщениями в реальном времени. События: MessageReceived, BotResponseReady, BotTyping, ConversationStatusChanged.

CORS и безопасность

API виджета проверяет заголовок Origin — он должен соответствовать домену, указанному в настройках магазина. Rate limiting: 30 сообщений в минуту на visitor_id.

Ещё не зарегистрированы? Попробуйте бесплатно

Остались вопросы? Напишите нам!