Что синхронизировать с Loyalty-Iiko
Для обеспечения полноценного взаимодействия внешней CRM или ERP с экосистемой Iiko через Loyalty API, необходимо настроить синхронизацию следующих сущностей:
- Client Profile (Профиль клиента): Синхронизация данных пользователя (имя, телефон, ID) между CRM и Iiko. Метод:
POST /loyalty/iiko/customer/createOrUpdate. - Bonus Balance (Бонусный баланс): Актуализация баллов клиента. Синхронизируется с ERP для отображения в личном кабинете. Метод:
GET /loyalty/iiko/customer/balance. - Transaction History (История операций): Передача транзакций для аналитики. Внешние BI-системы забирают данные через
GET /loyalty/iiko/transactions/list. - Loyalty Programs (Программы лояльности): Привязка клиента к конкретной акции или уровню. Метод:
POST /loyalty/iiko/customer/assignLoyaltyProgram. - Digital Coupons (Промокоды/Купоны): Валидация и списание купонов сторонних сервисов. Метод:
POST /loyalty/iiko/coupons/apply. - Order Data (Данные заказа): Привязка чека к карте лояльности для начисления баллов. Метод:
POST /loyalty/iiko/orders/add. - Catalog/Menu (Каталог товаров): Синхронизация SKU для поддержки продуктовых акций. Метод:
GET /loyalty/iiko/catalog.
Технические особенности API Loyalty-Iiko
- Аутентификация: Используется Bearer-токен, который получается через метод
/auth/loginс передачей API-логина и пароля, выданных в IikoOffice. - Формат данных: Обмен данными осуществляется исключительно через JSON. Все запросы должны содержать заголовок
Content-Type: application/json. - Rate Limiting: Действует ограничение до 50 запросов в секунду на один API-ключ. При превышении сервер возвращает код ошибки 429 (Too Many Requests).
- Обработка ошибок: Система возвращает стандартные HTTP-коды: 401 (ошибка авторизации), 403 (недостаточно прав), 404 (объект не найден), 500 (внутренняя ошибка сервера).
- Версионирование: Актуальная версия API передается в URL запроса (например,
/api/1.0/...или/api/2.0/...). - Webhooks: API поддерживает подписку на события (создание заказа, обновление баланса) через регистрацию Callback-URL.
- Песочница: Предоставляется через IikoCloud Sandbox — изолированную среду с актуальной версией API для тестирования нагрузки и логики интеграции.
Часто задаваемые вопросы о Loyalty-Iiko
Как получить API-ключ?
Ключ генерируется в панели управления IikoOffice в разделе «Администрирование» -> «API». Необходимо создать отдельного пользователя с правами доступа к модулю лояльности, чтобы получить логин и пароль для аутентификации.
Есть ли ограничения на частоту запросов?
Да, установлены лимиты на количество обращений к API для предотвращения нагрузки на серверы iikoCloud. При достижении лимита 50 req/sec рекомендуется использовать очереди сообщений для сглаживания трафика.
Поддерживает ли API real-time события через вебхуки?
Да, API Loyalty-Iiko позволяет настроить уведомления о транзакциях и изменениях профиля клиента. Вы передаете свой Endpoint, на который система будет отправлять POST-запросы при наступлении триггеров.
Существует ли тестовый режим (sandbox)?
Да, для разработчиков доступна среда iikoCloud Sandbox, которая полностью дублирует функционал боевого сервера. В ней можно проводить транзакции, не влияющие на реальные финансовые показатели ресторана.
Совместимость версий API?
API является обратно совместимым в рамках одной мажорной версии. При выходе новой версии (например, с v1 на v2) старая версия некоторое время поддерживается параллельно, после чего устаревает согласно регламенту Iiko.
Где искать актуальную документацию?
Полное техническое описание методов, схем объектов и параметров запросов доступно на официальном портале developers.iiko.ru. Также там представлены Swagger-спецификации для генерации клиентских библиотек. Настроить интеграцию Loyalty-Iiko под ключ — flowframe.ru, от 40 000 ₽, срок 7-21 день.