Различия

Показаны различия между двумя версиями страницы.

--- ordersboard [2021/09/14 13:56] – [Управление списком заказов] kuld
+++ ordersboard [2021/09/15 10:09] – [Термины и определения] kuld
@@ Строка 11: / Строка 11: @@
   * Постоянное подключение к Интернет
-===== Архитектура =====
+===== Термины и определения =====
+| **Устройство** | Пользовательское устройство с экраном для отображения и/или управления //Табло заказов//. Может быть Android устройством с установленным приложением или сторонним программным обеспечением, использующим [[ordersboard#web_api|Web API]]. |
+| **Слот** | Предприятие общественного питания, магазин, или иное предприятие -- сущность, объединяющая 2 и более устройств в единое информационное пространство. Все устройства, объединенные в единый слот работают с общим набором заказов. |
+| **Заказ** | Заказ покупателя, отображаемый устройствами. Характеризуется номером и статусом. Номер -- это целое число, уникальный идентификатор заказа в пределах слота, при этом на табло отображается только 3 последних разряда этого числа. Заказ может находится в одном из трех статусов: //Ожидание//, //Готов// или //Закрыт//.  |
 ===== Руководство пользователя =====
@@ Строка 76: / Строка 80: @@
 Для очистки всего списка готовых заказов воспользуйтесь кнопкой {{:android:notification-clear-all.png|}} внизу списка готовых заказов.
+Что бы полностью очистить всё табло перейдите в //Главное меню// и нажмите кнопку //Очистить табло//.
@@ Строка 82: / Строка 87: @@
 ===== Программный интерфейс (API) =====
+//Табло заказов// предоставляет программный интерфейс для интеграции со сторонним программным обеспечением.
+==== Web API ====
+Интеграция по //Web API// подойдет разработчикам на любых платформах. Web API предоставляет функции:
+  * создания устройств и слотов,
+  * объединения устройств в слоты,
+  * чтения состояния слотов,
+  * создание заказов с указанием их содержимого,
+  * изменение статуса заказов,
+  * чтение состояния заказов.
+Вам потребуется //API ключ разработчика//. Для его получения направьте запрос в [[support@lineris.ru|службу технической поддержки]].
+==== Android Intent API ====
+Интеграция //Android Intent API// подойдет только разработчикам на операционной системе Android. Для его использования на устройство нужно установить [[https://play.google.com/store/apps/details?id=ru.lineris.ordersboard|приложение Табло заказов]].
+Android Intent API позволяет из вашего приложения создать новый заказ в статусе ожидания на Табло заказов с указанием его содержимого.