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

Подключение виджета, API‑справка и устранение проблем.

Подключение виджета (быстрый старт)
Чаще всего используют

Для большинства интеграций достаточно виджета: он автоматически обрабатывает end‑user tokens, UI и выбранную персону.

1
Выберите способ подключения
<RiserWidget
  projectKey="YOUR_PUBLISHABLE_KEY"
  apiBase="https://riserlabs.io"
  title="AI chat"
  position="right"
/>

Используйте Publishable Key из панели проекта.

2
Подключите widget.js один раз

Этот сниппет подключает /widget.js и настраивает window.RiserChatWidget.

"use client";
import { useEffect } from "react";

type Props = {
  projectKey: string;
  apiBase: string;
  title?: string;
  position?: "left" | "right";
};

export function RiserWidget({
  projectKey,
  apiBase,
  title = "AI chat",
  position = "right",
}: Props) {
  useEffect(() => {
    const base = apiBase.replace(/\/+$/, "");

    // 1) Config BEFORE loading widget.js
    (window as any).RiserChatWidget = {
      projectKey,
      apiBase: base,
      title,
      position,
      // optional:
      // locale: "en",
      // theme: "auto",
      // externalUserId: "user_123",
    };

    // 2) Load widget.js once
    const id = "riser-widget-loader";
    if (document.getElementById(id)) return;

    const s = document.createElement("script");
    s.id = id;
    s.async = true;
    s.src = `${base}/widget.js`;
    document.body.appendChild(s);
  }, [projectKey, apiBase, title, position]);

  return null;
}
3
Настройте проект в панели

Перед запуском, пожалуйста, проверьте:

Чек‑лист безопасности

Рекомендуемые настройки безопасности для production:

  • Ограничьте Allowed Domains (domain‑gate).
  • Не выполняйте действия напрямую из ответа модели (CTA — только на сервере).
  • Включайте captcha/лимиты, если виджет доступен публично.

Если у Вас внедрён hostToken‑flow — укажите это как стандартное усиление безопасности.

Кастомизация (внешний вид и часы работы)

Вы можете настроить цвет, вид кнопки запуска, часы работы, юридические ссылки/согласия.

UI поддерживает светлую/тёмную тему через Tailwind‑классы 'dark:'.

Источники и сканирование каталога

Источники используются для формирования контекста ассистента (политики, товары, документы).

  • URL‑источники периодически синхронизируются и извлекаются.
  • Файлы (PDF/XLSX/CSV) можно загружать для пополнения базы знаний.
  • YML‑фиды можно трактовать как каталог, если добавлять префикс [CATALOG] в title.

Управление источниками: Settings → Sources

Персоны и поведение модели

Персона задаёт system‑правила: тон общения, продажи/поддержку, отказы и строгость следования контексту.

Настройка персоны: Settings → Persona

CTA‑кнопки (контролируемые действия)

CTA настраиваются в панели и выполняются на сервере — это снижает риск prompt injection и фишинга.

Управление CTA: Settings → CTA actions

Лиды и интеграции (Email / Telegram / Webhook / CRM)

Лиды сохраняют контакты пользователя + саммари чата + UTM и могут отправляться во внешние системы.

  • Таблица лидов: Settings → Leads
  • Доставка: В Leads Settings включается отправка в Email / Telegram / Webhook.
  • CRM: Через Webhook можно передавать лиды в Вашу CRM.