Краткое руководство по разработке плагинов с использованием iikoFront Api v1

Краткое руководство по разработке плагинов с использованием iikoFront Api v1

Архитектура

• 
  Структуры данныx (заказы, меню, залы и столы и т.п.);
  
• 
  Методы чтения данных;
  
• 
  Методы изменения данных;
  
• 
  Методы отслеживания изменений данных.
  

Структуры данных

• 
  Security – содержит данные, необходимые для авторизации плагина;
  
• 
  Cheques – позволяет вставлять в чеки дополнительную информацию;
  
• 
  Sections – структура предприятия (предприятие, группа терминалов, отделения и столы);
  
• 
  Assortment – номенклатура меню (продукты, групповые и обычные модификаторы);
  
• 
  Orders – заказы, включая гостей, блюда, модификаторы, скидки и т.п.;
  
• 
  Brd – аббревиатура от «банкеты, резервы и доставки», помимо перечисленного содержит также клиентов (Customer) с их адресами и номерами телефонов.
  

Методы чтения данных

Методы изменения данных

• 
  Создание сессии изменения данных, этот объект хранит промежуточную информацию и предоставляет методы для манипуляции данными;
  
• 
  Изменение данных. Действия не выполняются, а только накапливаются в соответствующей сессии;
  
• 
  Применение пакета изменений, сделанных в течение сессии. Предпринимается попытка выполнить действия. С некоторыми оговорками можно считать, что изменения применяются транзакционно – всё или ничего. iikoFront может отказать в применении изменений, если хотя бы одно действие противоречит техническим ограничениям или бизнес-правилам, а также если к изменяемым в сессии данным применены конфликтующие изменения⁴ другими плагинами или iikoFront. В случае неуспешной попытки, вызванной конкурентным редактированием, можно повторить операцию, начав с первого шага (создать новую сессию и использовать обновлённые версии данных).
  

Методы отслеживания изменений данных

• 
  Изменение данных (заказы, меню, доставки, адресная база гостей и т.п.);
  
• 
  Печать гостевого счёта или кассового чека (позволяет дополнить чек);
  
• 
  Изменение суммы сдачи текущего заказа (для дополнительного экрана покупателя);
  
• 
  Переходы между экранами iikoFront (экран редактирования заказа, экран оплаты заказа, остальные экраны).
  

Примеры

• 
  Дополнение чеков рекламной информацией
  
• 
  Работа с заказами (создание заказа, добавление гостей, добавление и удаление блюд и модификаторов, изменение количества порций)
  
• 
  Работа с доставками
  
• 
  Отображение уведомлений на экране терминала
  
• 
  Просмотр структуры предприятия (залы, столы, сотрудники)
  
• 
  Просмотр иерархического меню (блюда, модификаторы)