Общие сведения
Визуальный конструктор ботов Chat API позволяет реализовать широкий спектр задач:
- Отправка нотификаций в мессенджеры со своего веб-сайта;
- Выгрузка базы контактов (пользователей);
- Конфигурирование чат-бота из сторонней системы;
- Комплексные решения с участием внешних систем.
Архитектура API
1 - API построено по принципам REST: используются методы GET, POST, PATCH, DELETE.
2 - Результат всех запросов приходит в формате JSON: Content-type: application/json
3 - Запросы, возвращающие список результатов, используют limit - offset пагинацию.
- limit - максимальное кол-во результатов в запросе (не более 100).
- offset - сдвиг по порядковому номеру (по умолчанию: 0).
Авторизация в API
Все API-запросы защищены token-based авторизацией. Для получения токена отправьте запрос /api/auth/login/ со своими авторизационными данными.
Каждый API-запрос должен содержать заголовок: Authorization: Bearer {{token}}
Основные сущности
- Магазин (Shop) - центральная сущность в платформе HighTouch. Объединяет в себе сценарии работы бота, подключенные каналы, базу пользователей и заявок и набор настроек. Один пользователь платформы может управлять несколькими магазинами. Например, партнер получает доступ к своему магазину и магазинам подключенных клиентов.
- Бот (Bot) - это аккаунт в мессенджере, через который ведется коммуникация с пользователем.
- Пользователь (BotUser) - пользователь в мессенджере, ведущий переписку с ботом. Один и тот же человек в разных мессенджерах будет представлен разными пользователями!
- Заявка (Lead) - это заполненные пользователями формы (анкеты).
- Заказ (Order) - заказ товаров в интернет-магазине. Заказы содержат контактные данные покупателя и корзину товаров.
- Шаг (Step) - основной строительный блок сценария работы бота. Чаще всего шаг - это одно сообщение, отправленное ботом пользователю, следом за отправкой которого платформа выполняет определенные действия в зависимости от типа шага.
- Пункт меню (MenuItem) - кнопки, при помощи которых происходит переключение пользователя между шагами.
