Оформление
Подключение точки к iiko
Инструкция помогает поддержке подключить существующую точку Beex к организации iikoCloud в рабочем окружении. Нужен доступ к административной панели и сотрудник точки, который подтвердит меню, цены и тестовый заказ.
Результат подключения:
- меню загружается в нужную точку;
- оплаты и скидки проходят проверку;
- заказы уходят в выбранную организацию;
- изменения статусов возвращаются из iiko в Beex;
- обновление работает вручную и по расписанию.
До начала работы
Не открывайте штатный приём заказов через интеграцию до успешной загрузки меню и согласованного теста обмена статусами. Ключ доступа iiko и ключи приёма уведомлений передавайте только через защищённый канал.
Кто что делает
| Участник | Ответственность |
|---|---|
| Клиент или интегратор iiko | Выдаёт доступ, подтверждает организацию, город, меню, оплаты и скидки. |
| Поддержка | Связывает настройки в административной панели, запускает загрузку и проверяет результат. |
| Технический сотрудник Beex | Проверяет готовность окружения, служебную учётную запись, расписание и ошибки обмена. |
| Сотрудник точки | Подтверждает меню, цены, состав и появление тестового заказа в iiko. |
Простые термины
| Название | Что означает |
|---|---|
| Бренд | Клиент Beex, которому принадлежат города и точки. |
| Точка | Конкретный ресторан или место выдачи. |
| Подключение iiko | Учётная запись с ключом доступа к данным iiko. |
| Привязка организации | Связь найденной организации iiko с нужной точкой Beex. |
| Привязка города | Соответствие города iiko существующему городу Beex. |
| Терминальная группа | Группа рабочих терминалов организации iiko, принимающая заказы. |
| Обновление организаций и городов | Получение организаций, городов и доступных терминальных групп из iiko. |
| Синхронизация | Загрузка меню, оплат, скидок и связанных данных в Beex. |
| Обмен статусами | Приём уведомлений iiko об изменении заказов. |
Цветом выделено русское назначение настройки. Подпись в административной панели может ещё быть не переведена; ориентируйтесь также на раздел и пояснение к настройке.
Как выбирать значения
Универсальных названий меню, кодов оплаты и организаций нет. Все значения выбираются из подключения конкретного клиента в рабочем окружении.
| Что выбираем | Основание для выбора |
|---|---|
| Бренд, город и точка | Согласованная заявка на подключение и существующие карточки Beex. |
| Организация | Подтверждённый ресторан в учётной записи iiko клиента. |
| Меню | Опубликованное меню, предназначенное для этого канала продаж. |
| Источник цен | Цены самого меню либо согласованная ценовая категория. |
| Оплаты | Типы расчётов, подготовленные интегратором для этой организации. |
| Скидки и доставка | Реально используемые сценарии баллов, промокодов и стоимости доставки. |
Совпадение названия в тестовом и рабочем окружении не гарантирует, что это одна и та же запись. Не переносите внутренние номера и настройки другого клиента.
Что запросить до начала
Получите:
- точные названия бренда, точки и города Beex;
- названия организации и города iiko;
- ключ доступа iiko через защищённый канал;
- Источник меню: общий каталог iiko или внешнее меню;
- название внешнего меню, если выбран этот способ;
- Источник цен: цены меню или ценовая категория;
- наличный тип оплаты;
- карточный тип оплаты, если используются терминал или онлайн-оплата;
- названия настроек для баллов, промокода и стоимости доставки;
- контакт сотрудника точки и время первого обновления и теста.
Интегратор заранее проверяет активность организации и хотя бы одной терминальной группы, публикацию меню и доступ к нему, доступность оплат и используемых скидок.
Предварительная проверка
Попросите технического сотрудника подтвердить:
- в окружении используется подключение iiko отдельно для каждой точки;
- выбраны правильные бренд, город и точка;
- нет другого рабочего подключения, которое будет принимать заказы той же организации;
- готова служебная учётная запись для приёма статусов либо настроен общий ключ этого окружения;
- Округление стоимости позиций заказа отключено: оно несовместимо с активной интеграцией iiko.
Эта инструкция описывает подключение по точкам. Если окружение продолжает использовать прежнюю общую настройку бренда, сначала согласуйте перенос с техническим сотрудником.
Шаг 1. Проверить бренд, город и точку
В административной панели откройте карточки бренда, города и точки. Сравните названия, адрес, положение на карте, принадлежность бренду и активность с заявкой.
Если города или точки нет, сначала выполните первичную настройку. Подключайте существующую согласованную точку, чтобы не создать второй ресторан вместо неё.
Шаг 2. Создать подключение iiko
- В административной панели откройте раздел iiko → «Подключения IIKO».
- Нажмите добавление подключения.
- Выберите Бренд.
- Заполните Название подключения, понятное сотрудникам.
- Введите Ключ доступа iiko, полученный защищённым способом.
- Включите Активность подключения и сохраните.
Одно подключение может содержать несколько организаций. Конкретную организацию выбирают позднее для точки.
Шаг 3. Получить организации и города из iiko
- Вернитесь к списку подключений и отметьте созданную запись.
- Выберите действие «Обновить организации и города из IIKO».
- Нажмите «Выполнить».
- Обновляйте страницу до завершения.
Успех подтверждается сочетанием Результат обновления — успешно, заполненного Времени последнего обновления и пустой Ошибки обновления.
При неудаче остановитесь и передайте безопасный текст ошибки. Не создавайте недостающую организацию вручную и не подставляйте номера из тестового окружения.
Шаг 4. Связать город iiko с городом Beex
- Откройте подключение.
- Найдите встроенный список городов iiko.
- Для нужного внешнего города выберите Соответствующий город Beex.
- Сохраните.
- В привязке нужной организации проверьте Доступность организации, Наличие активной терминальной группы и связанный город.
Город организации должен соответствовать городу точки. Терминальные группы загружаются из iiko и связываются с точкой при синхронизации; создавать их вручную для первичного подключения не нужно.
Шаг 5. Создать интеграцию точки
- Откройте «Интеграции департаментов IIKO» — это список подключений конкретных точек.
- Добавьте запись.
- Выберите Подключение iiko, Привязку организации и Источник меню.
- Укажите Точку.
- Пока оставьте Синхронизацию выключенной и Состояние настройки — требуется настройка.
Готовность подтверждается отдельным действием после проверки связей. Не заменяйте его ручным выбором готового состояния.
Шаг 6. Загрузить варианты из iiko
После выбора подключения и организации нажмите «Загрузить значения из IIKO». Страница перезагрузится, и в списках появятся доступные меню, оплаты и скидки.
После загрузки повторно выберите точку и проверьте принадлежность подключения, организации и точки одному бренду. Кнопка не сохраняет остальные введённые значения, поэтому заполняйте их после обновления списка.
Если нужного варианта нет:
- Прочитайте пояснение ошибки возле настройки.
- Попросите интегратора проверить доступность значения в iiko.
- Если менялись организация, город или терминальная группа, снова обновите организации и города.
- Если менялись меню, оплаты или скидки, повторно нажмите «Загрузить значения из IIKO».
- Выберите появившееся значение; не вводите внутренние номера вручную.
Шаг 7. Настроить меню
Вариант А: общий каталог iiko
Выберите Источник меню — общий каталог iiko. Оставьте Корневую категорию меню пустой для всего дерева либо выберите согласованную категорию для ограниченной части каталога.
Вариант Б: внешнее меню
Выберите:
- Источник меню — внешнее меню;
- Внешнее меню клиента;
- Версию внешнего меню;
- Источник цен;
- Ценовую категорию, если цены должны браться из неё.
Форма поддерживает версии 2, 3 и 4. Выберите версию, согласованную для опубликованного меню; значение по умолчанию не заменяет проверку интегратора.
Для Цен меню отдельная ценовая категория не обязательна. Для Цен выбранной категории её выбор обязателен.
Организация меню берётся из привязки организации. Она должна соответствовать подключаемой точке.
Шаг 8. Настроить оплаты и скидки
В блоке оплат и скидок выберите Наличный тип оплаты iiko — он обязателен. Для терминала и онлайн-оплаты также выберите Карточный тип оплаты iiko. Внутренние номера выбранных оплат определятся при синхронизации.
| Способ в Beex | Как передаётся в iiko |
|---|---|
| Наличные, QR-код, банковский перевод | Через выбранный наличный тип. |
| Терминал | Через карточный тип, с оплатой на стороне iiko. |
| Онлайн | Через карточный тип, с отметкой об оплате вне iiko. |
Согласуйте соответствие способов с интегратором. Оставлять карточный тип пустым допустимо только если карточный и онлайн-сценарии не используются.
Настройте только нужные варианты:
- Скидка для оплаты баллами;
- Скидка для промокода;
- Начисление стоимости доставки.
Выбранные скидки должны быть действующими, с произвольной суммой, без ограничения на отдельные категории и минимальную сумму заказа. Неиспользуемые настройки оставьте пустыми.
До первой успешной синхронизации отметка Типы оплаты проверены отсутствует.
Шаг 9. Решить, какие данные может заменять iiko
В блоке управления обновлением данных рядом с переключателями показывается «Сейчас в IIKO». Согласуйте отдельно замену:
- Данных города;
- Названия точки;
- Адреса точки;
- Типа обслуживания;
- Активности.
По умолчанию оставьте эти переключатели выключенными. Включение означает, что следующее обновление заменит значение Beex данными iiko.
В блоке адреса выберите Формат адреса, соответствующий настройке iiko: отдельные части улицы и дома либо формат с городом. Сверьте значение с подсказкой «Сейчас в IIKO». При несоответствии передайте вопрос интегратору до тестового заказа.
Шаг 10. Сохранить и подтвердить привязку
- Снова сравните точку, город, подключение и организацию.
- Сохраните запись.
- В списке интеграций отметьте нужную строку.
- Выберите действие Подтверждение привязки и завершение переноса прежней точки.
- Нажмите «Выполнить».
- Проверьте Состояние настройки — готово и включённую синхронизацию.
Действие проверяет подключение, организацию, терминальную группу, соответствие города и наличную оплату. Оно также сбрасывает проверку оплат до следующей синхронизации и выключает все пять переключателей замены данных из предыдущего шага.
Если замена конкретных данных согласована, снова включите только нужные переключатели после подтверждения привязки и сохраните их до первого обновления.
Перенос прежней точки
При существующей старой настройке действие может дополнить оплаты, перенести настройки внешнего меню, отключить старую дублирующую точку и её каталог, перенести терминальные группы. До выполнения технический сотрудник должен проверить целевую точку и возможный дубликат. После выполнения повторно сверяйте меню, цены и оплаты; не считайте первоначально выбранные значения неизменными.
Шаг 11. Запустить первую синхронизацию
- Отметьте запись в списке интеграций.
- Выберите действие постановки синхронизации выбранных точек в очередь.
- Нажмите «Выполнить».
- Откройте журнал синхронизаций iiko.
- Найдите запуск по бренду и точке и дождитесь окончательного результата.
Успешный результат:
- Состояние запуска — успешно;
- сообщение об ошибке пустое;
- Состояние настройки — готово;
- синхронизация включена;
- Типы оплаты проверены;
- нужная терминальная группа связана с точкой.
В очереди означает только ожидание выполнения. Требуется настройка, Ошибка и Назначена повторная попытка не являются успешным результатом.
Если настройка стала недействительной из-за оплаты, исправьте тип на стороне iiko, загрузите варианты повторно, выберите корректную оплату, заново подтвердите привязку и запустите синхронизацию. До успеха не переходите к заказу.
Шаг 12. Настроить приём статусов из iiko
Для обмена статусами используется служебная учётная запись интеграции. Если технический сотрудник подтвердил общий ключ окружения, он проверяет эту схему отдельно. Иначе в административной панели проверьте, что служебный пользователь:
- относится к подключаемому бренду;
- активен;
- состоит в Группе интеграции iiko;
- имеет действующий Ключ доступа для обмена.
Используйте служебную, а не личную учётную запись. Если таких пользователей несколько, технический сотрудник должен определить используемый вариант. Ключ не копируйте в заявку или снимок экрана.
После проверки:
- В списке интеграций отметьте точку.
- Выберите действие Регистрация и проверка приёма статусов.
- Нажмите «Выполнить».
- Дождитесь Регистрация завершена, заполненного Времени регистрации и отсутствия Ошибки регистрации.
Сообщение о нуле поставленных в очередь интеграций означает, что запись не прошла проверку готовности. Проверьте активность подключения, организацию, состояние настройки и включение синхронизации.
Регистрация адреса ещё не подтверждает весь обмен. Измените статус согласованного тестового заказа в iiko и убедитесь, что он появился в Beex. Так проверяются подтверждение, приготовление, передача курьеру, доставка и отмена в используемом сценарии.
Если служебного пользователя отключить, удалить его ключ или права интеграции, приём новых статусов может остановиться, хотя отправка заказов продолжит работать. При проблеме повторно проверьте пользователя и принадлежность бренду вместе с техническим сотрудником.
Шаг 13. Проверить обновление по расписанию
В актуальной схеме плановое обновление находит бренды по включённым интеграциям точек. Отдельная прежняя настройка бренда для этого не требуется.
- Убедитесь, что подключение активно, настройка готова, синхронизация включена и первая проверка оплат успешна.
- Уточните у технического сотрудника действующее расписание окружения.
- После ближайшего запуска проверьте журнал: есть ли плановая обработка бренда и успешное обновление нужной точки.
- Если запуска нет, передайте проверку расписания и очереди техническому сотруднику.
Успешная постановка бренда в очередь не заменяет результат самой точки. Проверяйте завершение её обновления.
При отключённой или неполной интеграции в новой схеме отправка блокируется с ошибкой настройки; автоматического перехода к прежним настройкам бренда нет. Отключение согласуйте отдельно и проверьте уже открытые заказы.
Шаг 14. Провести приёмочную проверку
Согласуйте время теста с сотрудником точки, чтобы заказ не стал неожиданной задачей кухни.
- Проверьте, что категории и блюда появились в нужной точке.
- Сверьте названия, цены, размеры, группы и варианты добавок.
- Убедитесь, что скрытые и удалённые позиции нельзя заказать.
- Создайте тестовый заказ за наличные.
- Отдельно проверьте терминал и онлайн-оплату, если они используются.
- Проверьте каждый используемый сценарий: баллы, промокод, доставка.
- Убедитесь, что заказ попал в правильную организацию и терминальную группу.
- Сверьте состав, сумму, оплату и адрес.
- Измените статус в iiko и проверьте результат в Beex.
- Закройте или отмените тестовый заказ по согласованному сценарию.
- Зафиксируйте подтверждение сотрудника точки и разрешение на штатный приём заказов.
Для платной проверки заранее согласуйте сумму и порядок возврата.
Финальный чек-лист
- [ ] Бренд, город и точка проверены.
- [ ] Ключ iiko получен защищённым способом.
- [ ] Подключение активно.
- [ ] Организации и города успешно обновлены.
- [ ] Город iiko связан с нужным городом Beex.
- [ ] Организация доступна и имеет активную терминальную группу.
- [ ] Источник меню, версия и цены согласованы.
- [ ] Наличный тип оплаты выбран.
- [ ] Карточный тип выбран для терминала и онлайн-оплаты, если они используются.
- [ ] Скидки и стоимость доставки настроены по применяемым сценариям.
- [ ] Округление позиций отключено.
- [ ] Разрешения на замену данных проверены после подтверждения привязки.
- [ ] Первая синхронизация успешна, оплаты проверены.
- [ ] Приём статусов зарегистрирован и проверен на заказе.
- [ ] Плановый запуск нужной точки проверен.
- [ ] Сотрудник точки подтвердил меню, цены и состав заказа.
- [ ] Приём штатных заказов согласован.
Стоп-сигналы и что делать
| Сигнал | Возможная причина | Действие |
|---|---|---|
| Ошибка обновления организаций | Не получены сведения iiko. | Сохраните безопасный текст ошибки и передайте техническому сотруднику. |
| Организация отсутствует | Учётной записи недоступна организация. | Проверьте доступ у интегратора, обновите список повторно. |
| Нет активной терминальной группы | Организация не готова принимать заказы. | Попросите интегратора подготовить терминальную группу. |
| Не удаётся выбрать город | Нет соответствия городов. | Свяжите внешний город с существующим городом Beex. |
| Меню отсутствует | Меню не опубликовано или недоступно. | Исправьте доступ и загрузите варианты повторно. |
| Оплата отсутствует или не проходит проверку | Тип удалён, не подходит по свойствам или назначению. | Исправьте оплату в iiko, загрузите значения, подтвердите привязку и повторите обновление. |
| Требуется настройка | Не завершена привязка или не хватает данных. | Проверьте подключение, город, организацию, терминальную группу и оплаты. |
| Оплаты не проверены | Первая синхронизация не завершена успешно. | Откройте результат запуска; заказ пока не тестируйте. |
| Ошибка синхронизации | Ошибка данных, связи или приложения. | Передайте запуск и текст ошибки; не запускайте бесконечные повторы. |
| Регистрация поставила в очередь ноль записей | Интеграция не прошла фильтр готовности. | Проверьте готовность, активность подключения, организацию и включение синхронизации. |
| Ошибка регистрации приёма статусов | Проблема адреса, прав или ключа обмена. | Проверьте схему доступа с техническим сотрудником. |
| Заказ есть в iiko, статус в Beex не меняется | Нет доставки уведомления либо оно отклонено. | Проверьте время события, учётную запись, права и результат обработки. |
| Заказ попал в другую организацию | Неверная привязка или настройка окружения. | Приостановите приём через интеграцию по регламенту и немедленно передайте инцидент. |
| Нет планового обновления | Проблема расписания, очереди или готовности точки. | Передайте время последнего запуска и состояние настройки техническому сотруднику. |
Как передать результат
В итоговом сообщении укажите:
- бренд, город и точку;
- организацию iiko;
- источник и версию меню, источник цен;
- выбранные наличную и карточную оплаты;
- результат обновления организаций;
- состояние настройки;
- время последней успешной синхронизации;
- результат проверки оплат и приёма статусов;
- результат планового запуска;
- номер тестового заказа;
- подтверждение сотрудника точки и оставшиеся замечания.
Не прикладывайте ключи доступа, закрытые адреса и необработанные журналы с секретными данными.