HoneyStat API

Что такое HoneyStat

С помощью HoneyStat API вы можете использовать сервисы платформы с целью интеграции вашего сайта или Android, iOS приложения для получения информации о товарных рекомендациях для каждого вашего клиента, а так же другие аналитические данные.

1. Загрузить список товаров интернет-магазина

Входные параметры:
  • Токен магазина * (тип string)
  • www путь к YML файлу * (тип string)
Выходные параметры:
  • Количество активных товаров учитываемых системой (тип integer)

2. Показать иерархию групп товаров

Входные параметры:

  • Токен магазина * (тип string)
  • ID группа товаров (тип integer)

Выходные параметры:
  • ID группы товаров (тип integer)
  • Название группы товаров (тип string)
  • Уровениь иерархии (тип integer)
  • ID родительской группы товаров (тип integer)
  • Название родительской группы товара (тип string)

3. Показать группы товаров

Входные параметры:

  • Токен магазина * (тип string)
  • ID группа товаров (тип integer)

Выходные параметры:
  • ID группы товаров (тип integer)
  • Название группы товаров (тип string)
  • ID родительской группы товаров (тип integer)
  • Название родительской группы товара (тип string)

4. Показать вендоров (производителей) товаров интернет-магазина

Входные параметры:

  • Токен магазина * (тип string)
  • ID Вендора (тип integer)
  • ID группы товаров (тип integer)

Выходные параметры:
  • ID Вендора (тип integer)
  • Название вендора (тип string)

5. Показать товары интернет-магазина

Входные параметры:

  • Токен магазина * (тип string)
  • Признак “Наличия товара” в магазине (флаг Y, N)
  • ID группы товаров (тип integer)
  • ID Вендора (тип integer)

Выходные параметры:
  • ID товара в интернет-магазине (тип integer)
  • ID группы товаров (тип integer)
  • Название группы товаров (тип string)
  • ID родительской группы товаров (тип integer)
  • Название родительской группы товара (тип string)
  • Название товара (тип string)
  • Описание товара (тип string)
  • ID Вендора (тип integer)
  • Вендор (тип string)
  • Код вендора(тип string)
  • Цена (тип numeric)
  • Ссылка на товар (тип string)
  • Ссылка на картинку товара (тип string)
  • Признак “Наличия товара” в магазине (флаг Y, N)

6. Показать картинки товаров интернет-магазинов

Входные параметры:

  • Токен магазина * (тип string)
  • ID товара в интернет-магазине (тип integer)

Выходные параметры:
  • ID товара в интернет-магазине (тип integer)
  • Ссылка на картинку товара (тип string)

7. Показать параметры товара интернет магазина

Входные параметры:

  • Токен магазина * (тип string)
  • ID товара в интернет-магазине (тип integer)

Выходные параметры:
  • Название параметра
  • Единица измерения
  • Значение

8. Сгенерировать уникальный ID пользователя и определить местоположение пользователя

Входные параметры:

  • Токен магазина * (тип string)
  • IP пользователя * (тип string)

Выходные параметры:
  • ID пользователя (тип integer)
  • HoneyStat ID Местоположения
  • Название Страны
  • Название Города
  • Название Области

9. Передать в HoneyStat информацию о просмотренном товаре

Входные параметры:

  • Токен магазина * (тип string)
  • IP пользователя (тип string)
  • ID товара * (тип integer) (ID товара в базе данных интернет- магазина)
  • ID ref-товара (скоторого был переход на текущий товар) (тип integer) (ID товара в базе данных интернет- магазина)
  • ID пользователя (тип string)

Выходные параметры:
  • ID транзакции (тип integer)

10. Передать в HoneyStat информацию о понравившемся товаре (отложенном в корзину)

Входные параметры:

  • Токен магазина * (тип string)
  • IP пользователя (тип string)
  • ID товара * (тип integer) (ID товара в базе данных интернет- магазина)
  • ID ref-товара (скоторого был переход на текущий товар) (тип integer) (ID товара в базе данных интернет- магазина)
  • ID пользователя (тип string)

Выходные параметры:
  • ID транзакции (тип integer)

11. Передать в HoneyStat информацию о заказанном (купленном) товаре

Входные параметры:

  • Токен магазина * (тип string)
  • IP пользователя (тип string)
  • ID товара * (тип integer) (ID товара в базе данных интернет- магазина)
  • ID ref-товара (скоторого был переход на текущий товар) (тип integer) (ID товара в базе данных интернет- магазина)
  • ID пользователя (тип string)

Выходные параметры:
ID транзакции (тип integer)

12. Показать товары вендора (на основе аналитического расчета HoneyStat)

Входные параметры:

  • Токен виджета * (тип string)
  • ID группы товаров (тип integer)
  • ID Вендора (тип integer)
  • Тип алгоритма отображения данных * (string) (“POP” - товары с максимальным спросом, “UNPOP” - товары не пользующиеся спросом)
  • Количество товаров которое необходимо отобразить (тип integer) (если не указано, учитывается 10)

Выходные параметры:
  • Название виджета (тип string)
  • Рейтинг (1 - максимально релевантный товар заданным критериям) (тип integer)
  • ID товара в интернет-магазине (тип integer)
  • ID группы товаров (тип integer)
  • Название группы товаров (тип string)
  • ID родительской группы товаров (тип integer)
  • Название родительской группы товара (тип string)
  • Название товара (тип string)
  • Описание товара (тип string)
  • Вендор (тип string)
  • Цена (тип numeric)
  • Ссылка на товар (тип string)
  • Ссылка на картинку товара (тип string)
  • Признак “Новый товар” в магазине (флаг Y, N)

13. Показать товары интернет-магазина в соответствии с настройками виджета в Личном Кабинете (на основе аналитического расчета HoneyStat)

Входные параметры:

  • Токен виджета * (тип string)
  • IP пользователя (тип string) (указание параметра влияет на отображение данных с учетом местоположения пользователя)
  • ID товара (тип integer)
  • ID пользователя (тип string)

Выходные параметры:
  • Название виджета (тип string)
  • Рейтинг (1 - максимально релевантный товар заданным критериям) (тип integer)
  • ID товара в интернет-магазине (тип integer)
  • ID группы товаров (тип integer)
  • Название группы товаров (тип string)
  • ID родительской группы товаров (тип integer)
  • Название родительской группы товара (тип string)
  • Название товара (тип string)
  • Описание товара (тип string)
  • Вендор (тип string)
  • Цена (тип numeric)
  • Ссылка на товар (тип string)
  • Ссылка на картинку товара (тип string)
  • Признак “Новый товар” в магазине (флаг Y, N)