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

Два способа подключить ИИ-чат-бота Helpi к вашему продукту: готовый виджет для сайта и REST API для собственных интеграций.

Обновлено: 20 июля 2026

Два способа подключения

Helpi можно интегрировать в ваш продукт двумя способами. Для большинства сайтов достаточно виджета — он подключается одним фрагментом кода и не требует разработки. Если вам нужен собственный интерфейс чата или интеграция бота во внешнюю систему, используйте REST API.

Виджет — рекомендуется

Готовое окно чата на вашем сайте. Достаточно вставить один фрагмент кода — бот сразу начнёт отвечать посетителям, а обращения будут попадать в операторский инбокс.

REST API

Прямые запросы к ассистенту из вашего кода. Подходит для мобильных приложений, кастомных интерфейсов и серверных интеграций, где нужен полный контроль над логикой.

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

Виджет — самый быстрый способ запустить бота. Вставьте фрагмент ниже в HTML-код каждой страницы, где должно появляться окно чата: перед закрывающим тегом </head> или в конце <body>. Скрипт загружается асинхронно и не замедляет отрисовку страницы.

<script>
  (function () {
    var s = document.createElement('script');
    s.src = 'https://app.helpi.pro/widget/chatbot.js';
    s.async = true;
    s.setAttribute('data-website-id', 'ВАШ_ID_САЙТА');
    document.head.appendChild(s);
  })();
</script>

Замените ВАШ_ID_САЙТА на идентификатор вашего сайта. Его можно скопировать в личном кабинете: откройте нужный сайт и перейдите в раздел Виджет — там же доступны настройки внешнего вида и поведения окна чата.

  1. Получите идентификатор

    В личном кабинете откройте раздел сайта и вкладку «Виджет». Скопируйте значение идентификатора сайта.

  2. Вставьте фрагмент кода

    Добавьте скрипт выше в шаблон страниц, подставив идентификатор в атрибут data-website-id.

  3. Проверьте результат

    Обновите сайт — в углу страницы появится кнопка чата. Задайте боту вопрос, чтобы убедиться, что он отвечает и обращения приходят в инбокс.

Бот обучается на контенте вашего сайта. Если вы недавно опубликовали новые страницы, дайте боту немного времени на их индексацию, чтобы ответы учитывали свежую информацию.

REST API

REST API позволяет обращаться к ассистенту напрямую из вашего кода — например, чтобы встроить чат в мобильное приложение или собственный интерфейс. Запросы отправляются по HTTPS, тело и ответы передаются в формате JSON.

Базовый URL всех методов:

https://api.helpi.pro/api/v1

Авторизация

Каждый запрос авторизуется API-ключом, который выдаётся в личном кабинете. Передавайте его в заголовке Authorization по схеме Bearer:

Authorization: Bearer ВАШ_API_КЛЮЧ

API-ключ даёт доступ к вашему аккаунту — храните его на стороне сервера и не размещайте в коде, доступном посетителям (например, в JavaScript на странице). Для клиентских сценариев используйте виджет.

Метод POST /chat

Основной метод для общения с ассистентом. Отправьте POST-запрос на /chat с JSON-телом, в котором указаны идентификатор сайта и текст сообщения посетителя. В ответ придёт JSON с ответом ассистента.

Пример запроса через curl:

curl -X POST https://api.helpi.pro/api/v1/chat \
  -H "Authorization: Bearer ВАШ_API_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{
    "website_id": "ВАШ_ID_САЙТА",
    "message": "Здравствуйте! Как оформить подписку?"
  }'

Параметры тела запроса

ПолеТипОписание
website_idстрокаИдентификатор вашего сайта из личного кабинета.
messageстрокаТекст сообщения посетителя, на который ответит ассистент.

Ответ

При успешном запросе сервер возвращает JSON с ответом ассистента — текстом, сформированным на основе контента вашего сайта:

{
  "reply": "Здравствуйте! Выбрать и оформить подписку можно на странице тарифов…"
}

Помимо поля reply, ответ может содержать дополнительные служебные поля. Новые поля добавляются обратно совместимо, поэтому используйте нужные вам ключи и игнорируйте незнакомые.

Число доступных сообщений в месяц зависит от вашего тарифа:

ТарифСообщений в месяц
Free0
Starter1 000
Business5 000
Pro20 000

Актуальные цены и условия смотрите на странице тарифов.

Коды ошибок

Если запрос не выполнен, сервер возвращает соответствующий HTTP-код. Основные ситуации:

КодЗначениеЧто делать
401Неверный или отсутствующий ключПроверьте заголовок Authorization и корректность API-ключа из личного кабинета.
402Требуется активный тарифАктивируйте подходящий тариф на странице тарифов, чтобы продолжить работу с API.
429Превышен месячный лимитИсчерпан лимит сообщений по вашему тарифу. Дождитесь следующего периода или перейдите на тариф выше.

Нужна полная спецификация методов или помощь с интеграцией? Напишите нам — support@helpi.pro. Подскажем по параметрам, лимитам и подключению под вашу задачу.

Больше материалов

Если вы только начинаете, загляните в пошаговые руководства и базу знаний — там подробно разобраны настройка бота, сценарии и подключение каналов.

Руководства

Пошаговые инструкции по настройке и запуску Helpi — от первого подключения до продвинутых сценариев.

База знаний

Ответы на частые вопросы и справочные статьи по возможностям продукта.

Поддержка и реквизиты

По вопросам подключения, полной спецификации методов, лимитов и оплаты напишите нам — support@helpi.pro. Поможем подобрать способ интеграции под вашу задачу.

Условия использования сервиса, обработки данных и возврата средств описаны в отдельных документах:

Полные реквизиты продавца (наименование и ИНН) указаны в Оферте и Политике конфиденциальности.