Общие сведения
HighTouch API (1.1.2)
HighTouch REST API позволяет реализовать широкий спектр задач, таких, как:
  • Отправка нотификаций в мессенджеры со своего веб-сайта;
  • Выгрузка базы контактов (пользователей);
  • Конфигурирование чат-бота из сторонней системы;
  • Комплексные решения с участием внешних систем.
Оставьте отзыв / предложение по работе API в Telegram-чате сообщества.

Архитектура API

  1. 1.
    API построено по принципам REST: используются методы GET, POST, PATCH, DELETE.
  2. 2.
    Результат всех запросов приходит в формате JSON:
    1
    Content-type: application/json
    Copied!
  3. 3.
    Запросы, возвращающие список результатов, используют limit - offset пагинацию.
    • limit - максимальное кол-во результатов в запросе (не более 100).
    • offset - сдвиг по порядковому номеру (по умолчанию: 0).

Авторизация в API

Все API-запросы защищены token-based авторизацией. Для получения токена отправьте запрос /api/auth/login/ со своими авторизационными данными (см. раздел "Авторизация").
Каждый API-запрос должен содержать заголовок:
1
Authorization: Bearer {{token}}
Copied!
Большинство запросов работают на уровне магазина (Shop), поэтому требуют передачи shop_id в качестве параметра.

Основные сущности

  • Магазин (Shop) - центральная сущность в платформе HighTouch. Объединяет в себе сценарии работы бота, подключенные каналы, базу пользователей и заявок и набор настроек.
    Один пользователь платформы может управлять несколькими магазинами. Например, партнер получает доступ к своему магазину и магазинам подключенных клиентов.
  • Бот (Bot) - это аккаунт в мессенджере, через который ведется коммуникация с пользователем.
  • Пользователь (BotUser) - пользователь в мессенджере, ведущий переписку с ботом. Один и тот же человек в разных мессенджерах будет представлен разными пользователями!
  • Заявка (Lead) - это заполненные пользователями формы (анкеты).
  • Заказ (Order) - заказ товаров в интернет-магазине. Заказы содержат контактные данные покупателя и корзину товаров.
  • Шаг (Step) - основной строительный блок сценария работы бота. Чаще всего шаг - это одно сообщение, отправленное ботом пользователю, следом за отправкой которого платформа выполняет определенные действия в зависимости от типа шага.
  • Пункт меню (MenuItem) - кнопки, при помощи которых происходит переключение пользователя между шагами.
Last modified 1yr ago