Renta / Документация / Источники / IikoCloud

IikoCloud

Renta выгружает в ваше хранилище данных доставки IikoCloud: заказ со статусом, временем, клиентом, адресом, оплатами, скидками и составом.

Пайплайн охватывает организации, которые вы выбираете из своего аккаунта iiko, и загружает доставки за указанный период.

Аутентификация

Renta авторизуется в IikoCloud по API-ключу. Ключ принадлежит интеграции iikoCloud API в веб-офисе iiko, там он называется apiLogin.

Токен доступа Renta не хранит. Она меняет ключ на короткоживущий токен в начале каждого запуска, поэтому отзыв ключа в iiko сразу отрезает Renta от данных.

Подключение источника IikoCloud

Выполните эти шаги, чтобы добавить IikoCloud как источник данных в Renta.

Перейдите в каталогStep 1
  1. В консоли Renta откройте Connections > Catalog в левом меню.
  2. Разверните категорию CRM и нажмите карточку IikoCloud. Соседняя карточка IikoWeb относится к другому коннектору, для веб-офиса iiko.
Карточка IikoCloud в категории CRM каталога подключений Renta
Введите API-ключStep 2
  1. API Key.
    Значение apiLogin вашей интеграции iikoCloud API.
Поле API Key в форме нового подключения IikoCloud
Назовите подключение и сохранитеStep 3

Заполните Source name (название используется только внутри консоли Renta) и нажмите Save.

Поле Source name и кнопка Save в форме подключения IikoCloud
Проверьте подключениеStep 4

Подключение появится в списке Sources со статусом Active и будет готово к использованию в пайплайнах.

Список Sources с новым подключением IikoCloud в статусе Active

Создание пайплайна

Пайплайн связывает подключение IikoCloud с назначением, которое принимает данные.

Создание пайплайна IikoCloud

Свяжите подключение IikoCloud с назначением и настройте пайплайн.

Выберите IikoCloud как источникStep 1

В левом меню нажмите New pipeline. Оставьте выбранной вкладку ETL, найдите IikoCloud в блоке Already connected и нажмите Next step. Каталог длинный, поэтому быстрее всего добраться через поиск.

Шаг выбора источника в мастере пайплайна с найденным через поиск IikoCloud
Выберите подключениеStep 2

Выберите созданное подключение IikoCloud и нажмите Next step.

Шаг выбора подключения IikoCloud с API login на карточке
Выберите назначениеStep 3

На шаге Destination выберите хранилище, которое примет данные, и нажмите Next step.

Шаг выбора назначения с подключёнными хранилищами
Выберите подключение назначенияStep 4

Выберите подключение назначения и нажмите Next step.

Шаг выбора подключения назначения

Настройка пайплайна

Последний шаг мастера собирает все настройки в одну длинную форму.

Организация

В аккаунте iiko может быть несколько организаций, и пайплайн читает только те, что вы отметите здесь.

Пикер Organisation с одной отмеченной организацией

Список приходит из вашего аккаунта iiko, под названием каждой организации подписан её идентификатор. Если отметить несколько, все они попадут в одну таблицу, а строки будет различать колонка organizationId.

Тип отчёта

Тип отчёта определяет, что именно извлекает пайплайн.

Выпадающий список Report Types пайплайна IikoCloud
Тип отчётаОписание
Delivery ordersДоставки выбранного периода по отмеченным организациям, в любом состоянии от Unconfirmed до Cancelled. Одна строка на заказ: статус, время, клиент, адрес, оплаты, скидки и состав.

Параметры

Отметьте поля, которые нужно загружать. Каждое выбранное поле станет колонкой таблицы назначения.

Пикер Parameters отчёта Delivery orders со всеми отмеченными полями

Заказ приходит развёрнутым в плоскую строку. Вложенные части ответа iiko сохраняют свой путь в имени поля, поэтому order.loyaltyInfo.appliedManualConditions остаётся одним полем, а в колонке назначения точки заменяются на подчёркивания.

Добавьте order_created_date, если хотите инкрементальную загрузку. Это единственное поле, по которому Renta умеет партиционировать таблицу назначения, и настройка Overwrite Period появляется только после его выбора.

Имя интеграции и таблицы

Задайте название пайплайна в Renta и имя таблицы в назначении.

Поля Integration name и Table name в настройках пайплайна
  1. Integration name.
    Отображаемое название пайплайна в консоли Renta.
  2. Table name.
    Таблица в вашем назначении. Оставьте сгенерированное имя или введите своё.

Диапазон дат

Диапазон дат задаёт, за какие дни доставки загружаются заказы.

Поля Date start и Date end блока Date Range
  1. Date start.
    Первый день доставки, который нужно загрузить.
  2. Date end.
    Последний: фиксированная дата или подвижная граница, например Today.

Date start не может быть глубже 90 дней. Запуск с датой за пределами этого окна останавливается с ошибкой до первого запроса, таблица назначения при этом не меняется. Ограничение действует и на ручной Full refresh, поэтому таблицу старше 90 дней нельзя пересобрать с нуля.

Период перезаписи

Период перезаписи определяет, насколько глубоко назад каждый плановый запуск перезагружает уже загруженные дни. Настройка появляется, как только среди выбранных параметров есть order_created_date.

Выпадающи�й список Overwrite Period пайплайна IikoCloud

Заказы меняются после создания: проходят путь от WaitCooking через OnWay до Delivered или Cancelled. Именно окно перезаписи подтягивает эти изменения в таблицу, поэтому берите его не короче, чем заказы у вас остаются открытыми.

Расписание

Расписание решает, как часто выполняется пайплайн. Указанное здесь время Renta читает в UTC.

Выбор типа расписания с отмеченным вариантом Daily
Тип расписанияОписание
ManualПайплайн запускается только вручную из консоли Renta или через API.
DailyПайплайн запускается раз в сутки в указанное время обновления.
IntervalПайплайн запускается через заданные интервалы времени.
Cron ExpressionПайплайн запускается по расписанию, заданному cron-выражением.

Для расписания Daily укажите Update time (точное время старта каждого запуска) и нажмите Create pipeline.

Выпадающий список Update time и кнопка Create pipeline

Renta также поддерживает запуск по API и работу с оркестраторами: Apache Airflow, Dagster, Prefect. Подробности в документации по расписанию.

Пайплайн появится в разделе Pipelines на вкладке ETL вместе с именем таблицы назначения, прогрессом запуска и количеством извлечённых строк.

Список Pipelines с новой интеграцией IikoCloud

Стратегия синхронизации

В таблице ниже описано, как Renta синхронизирует тип отчёта IikoCloud.

СтратегияПоддерживаемые типы отчётовОписание
Инкрементальное обновлениеDelivery orders (с выбранным order_created_date)Таблица назначения партиционируется по order_created_date. Каждый запуск удаляет дни окна перезаписи и загружает их заново, поэтому изменения статусов по открытым заказам доезжают до таблицы.
Полная перезагрузкаDelivery orders (без order_created_date)Без колонки с датой таблицу нельзя партиционировать, поэтому каждый запуск заменяет всё её содержимое текущим диапазоном дат.

Ограничение в 90 дней и полная перезагрузка плохо сочетаются. Пайплайн без order_created_date переписывает таблицу на каждом запуске и дотягивается максимум на 90 дней назад, поэтому история глубже теряется на следующем же запуске. Выбирайте order_created_date всегда, когда собираетесь хранить больше квартала заказов.

Часто задаваемые вопросы

Ready to get started?

Build your data pipeline today or get a personalized demo. Start free!

Need help?

Get expert support to ensure your project succeeds. We're here to help!

Feature requests?

Help shape our product! Share your ideas for new features and integrations.