Взаимодействие с учетной системой

Интеграция с учетной системой iiko

Последнее обновление:

В данном блоке описано взаимодействие платформы Loyalhub и инфраструктуры iiko. Интеграция позволяет автоматически передавать заказы с вашего сайта, мобильного приложения, Telegram-бота и других каналов платформы напрямую в iiko, а также синхронизировать программы лояльности настроенные на iikoCARD, меню, стоп-листы и прочую информацию (в том числе трансляция изменения статуса заказа в iiko).

Требования к учётной системе iiko

Для корректной работы интеграции необходимо выполнить следующие требования на стороне iiko:

Рекомендуемая версия iiko: 8.5 или выше.

Минимальная версия iiko: 8.3.

Требуемые модули: Работа с iikoCloud API.

Важно: Для уточнения прочих параметров интеграции необходимо обратиться в нашу техническую поддержку.

Методы iikoCloud API которые используются на платформе

Наша платформа использует часть методов iikoCloud API, необходимых для полноценного взаимодействия с учётной системой.

1. Базовое взаимодействие и проверки

Авторизация: https://api-ru.iiko.services/api/1/access_token

Проверка терминалов: https://api-ru.iiko.services/api/1/terminal_groups/is_alive

Проверка остатков: https://api-ru.iiko.services/api/1/stop_lists/check

Проверка статуса операций: https://api-ru.iiko.services/api/1/operations

2. Начальная настройка и справочники

Организации: https://api-ru.iiko.services/api/1/organizations

Терминальные группы: https://api-ru.iiko.services/api/1/terminal_groups

Типы заказов: https://api-ru.iiko.services/api/1/deliveries/order_types

Типы оплат: https://api-ru.iiko.services/api/1/payment_types

Источники заказов: https://api-ru.iiko.services/api/1/marketing_sources

Ручные скидки: https://api-ru.iiko.services/api/1/discounts

Причины отмены: https://api-ru.iiko.services/api/1/cancel_causes

Справочники адресов: https://api-ru.iiko.services/api/1/addresses

3. Работа с меню

Выгрузка основного меню: https://api-ru.iiko.services/api/1/nomenclature

Список внешних меню: https://api-ru.iiko.services/api/2/menu

Внешнее меню по ID: https://api-ru.iiko.services/api/2/menu/by_id

4. Расчет акций и скидок

Расчет акций для заказа: https://api-ru.iiko.services/api/1/loyalty/iiko/calculate

5. Создание и управление заказами

Заказы на доставку и самовывоз:

Создание заказа: https://api-ru.iiko.services/api/1/deliveries/create

История заказа: https://api-ru.iiko.services/api/1/deliveries/by_id

Заказы на стол (для киосков и тейбл-тентов):

Создание заказа: https://api-ru.iiko.services/api/1/order/create

История заказа: https://api-ru.iiko.services/api/1/order/by_id

Черновики заказов:

Создание черновика: https://api-ru.iiko.services/api/1/deliveries/drafts/create

6. Вебхуки (Webhooks)

Для настройки используется метод:

Настройка вебхука: https://api-ru.iiko.services/api/1/webhooks/update_settings

Наша платформа получает обновления по следующим URL iiko:

Обновление стоп-листов: https://[наш-адрес]/webhooks/iiko/stoplist

Обновление заказов на доставку: https://[наш-адрес]/webhooks/iiko/delivery

Обновление заказов на стол: https://[наш-адрес]/webhooks/iiko/table

7. Управление гостями (Лояльность)

Категории гостей: Все методы блока https://api-ru.iiko.services/api/1/customer_categories/...

Работа с гостем: