Información general sobre la API

HighTouch API (1.1.2)

HighTouch REST API permite realizar una amplia gama de tareas, como

• Envío de notificaciones a los mensajeros desde su página web o CRM

• Descarga de una base de datos de contactos (usuarios)

• Configuración de un chatbot desde un sistema de terceros;

• Soluciones integrales con sistemas externos.

Оставьте отзыв / предложение по работе API в Telegram-чате сообщества.

Arquitectura de la API

1. API se basa en los principios de REST: se utilizan métodos GET, POST, PATCH, DELETE.

2. El resultado de todas las consultas viene en el formato JSON:

    Content-type: application/json

3. Las consultas que devuelven una lista de resultados utilizan limit - offset paginación.

   • limit - número máximo de resultados por consulta (máx. 100).

   • offset - desplazamiento por número ordinal (configuración por defecto:0).

Autorización en la API

Todas las solicitudes de la API están protegidas por token-based autorización. Para recibir una ficha, envíe una solicitud a /api/auth/login/ сsobre sus datos de autorización (véase la sección "Autorización").

Cada solicitud de la API debe contener una cabecera:

 Authorization: Bearer {{token}}

La mayoría de las consultas funcionan a nivel de tienda, por lo que requieren que se pase el shop_id como parámetro.

Entidades de base

• Магазин (Shop) - центральная сущность в платформе HighTouch. Объединяет в себе сценарии работы бота, подключенные каналы, базу пользователей и заявок и набор настроек.

  Один пользователь платформы может управлять несколькими магазинами. Например, партнер получает доступ к своему магазину и магазинам подключенных клиентов.

• Бот (Bot) - это аккаунт в мессенджере, через который ведется коммуникация с пользователем.

• Пользователь (BotUser) - пользователь в мессенджере, ведущий переписку с ботом. Один и тот же человек в разных мессенджерах будет представлен разными пользователями!

• Заявка (Lead) - это заполненные пользователями формы (анкеты).

• Заказ (Order) - заказ товаров в интернет-магазине. Заказы содержат контактные данные покупателя и корзину товаров.

• Шаг (Step) - основной строительный блок сценария работы бота. Чаще всего шаг - это одно сообщение, отправленное ботом пользователю, следом за отправкой которого платформа выполняет определенные действия в зависимости от типа шага.

• Пункт меню (MenuItem) - кнопки, при помощи которых происходит переключение пользователя между шагами.