To enable the transmission of kiosk status metrics, navigate to Service Menu > Main Settings:
- Enable the parameter Use metrics.
- In the Metrics Service Base URL parameter, specify the address: https://rk-platform-monitoring.rkeeper.com.
- Set the State Sending Interval (seconds) — default is 60 seconds.
- Задайте A/B Testing tag for metrics — используется для дополнительной пометки метрик, значением может быть любая строка, проверки уникальности нет.
To retrieve data from the metrics service, you will need a Token. You can obtain the token by sending a request to the email: yaro@ucsrkeeper.at.
Request:
curl --location --request POST 'https://rk-platform-monitoring.rkeeper.com/api/v1/metrics/read' \
--header 'Authorization: Bearer <Token> \ The Token can be obtained by requesting at yaro@ucsrkeeper.at.
--header 'Content-Type: application/json' \
--data-raw '{
"dateFrom": "2025-05-06T00:00:00Z",
"dateTo": "2025-05-07T23:00:00Z",
"cntFrom": 12000,
"cntTo": 13000,
"total": 100,
"cashNetName": "KIOSK_1_STM",
"champsID": "387K04",
"objectCode": "527280004"
}'
- dateFrom and dateTo — the time range for the metrics (from/to).
- cntFrom and cntTo — the message counter range (field cnt).
- total — the number of metrics to return in the response.
- cashNetName — the kiosk name.
- champsID — the kiosk's champsID.
- objectCode — the kiosk object code.
Also create a separate extended properties for the restaurant:
- System Name — GA_CUSTOM_ID
- Types List — Restaurant.
In the Service > Stations and Devices directory for the restaurant, in the created extended property, specify ChampsID — the restaurant code in the global KFC system (data can be obtained from the Franchisee).
Пример ответа
[
{
"timestamp": "2025-07-08T14:57:51Z",
"payload": {
"typeData": "Time based event",
"data": {
"state": "Waiting window",
"champsID": "234234234234211",
"kioskName": {
"cashGuid": "{1E5C9B01-A065-48B0-882A-DDB46C22BC9C}",
"cashNetName": "RK7CASH004"
},
"kioskAppVersion": {
"back": " v0.0.383.21-rev.7b44ad92-j.42173",
"front": "0.0.330.21",
"theme": "KFCCee"
},
"objectCode": "199990001",
"tagAB": "AAA"
},
"cnt": 21259
}
}
]
- timestamp — дата и время сохранения метрики в сервисе
payload - typeData — тип метрики
payload - data — основная информация по метрике (зависит от типа метрики)
payload - cnt — счетчик метрик. Для каждого киоска начинается с 1, увеличивается на 1 по мере отправки метрик с киоска.
Типы метрик (typeData):
- References — отправляем список активных касс и расписание ресторана, от которого работает киоск
- Time based event — отправляем название текущего экрана киоска раз в “Интервал отправки состояния (в секундах)”
- Event based event — отправляем информацию по оплате заказа или по отправке заказа для оплаты на кассе.
Общие поля для всех типов метрик:
- champsID — код ресторана в глобальной системе KFC. Здесь может быть вписано любой текст. Уникальность не проверяется
- kioskName - cashGuid — Guid кассы, от которой работает киоск. В интерфейсе Менеджерской r_k это поле GUID
- kioskName - cashNetName — сетевое имя кассы, от которой работает киоск. В интерфейсе Менеджерской r_k это поле Network ID
kioskAppVersion - back — полная версия бэк части киоска.
Значение поля из примера: v0.0.383.21-rev.7b44ad92-j.42173:
- v0.0.383.21 — основная информация о версии бэк части киоска;
- rev.7b44ad92-j.42173 — служебная информация.
- kioskAppVersion - front — версия фронт части
- kioskAppVersion - theme — используемая тема
- objectCode — полный код ресторана, от которого работает киоск
- tagAB - тэг АБ тестирования. Используется для дополнительной пометки метрик. Задается при первичных настройках киоска в параметре A/B Testing tag for metrics. Значением может быть произвольная строка, проверки уникальности нет.
Поля, зависящие от типа метрик (поле data):
Тип метрики References
Киоск отправляет список активных касс и расписание ресторана, от которого работает киоск.
Пример
{
"timestamp": "2025-07-08T07:13:43Z",
"payload": {
"typeData": "References",
"data": {
"restaurantSchedule": [
{
"daysOfWeek": "[dwSunday]",
"startTime": 36000000,
"endTime": 72000000
},
{
"daysOfWeek": "[dwMonday]",
"startTime": 36000000,
"endTime": 72000000
},
{
"daysOfWeek": "[dwTuesday]",
"startTime": 36000000,
"endTime": 72000000
},
{
"daysOfWeek": "[dwWednesday]",
"startTime": 39600000,
"endTime": 75600000
},
{
"daysOfWeek": "[dwThursday]",
"startTime": 32400000,
"endTime": 54000000
},
{
"daysOfWeek": "[dwFriday]",
"startTime": 36000000,
"endTime": 72000000
},
{
"daysOfWeek": "[dwSaturday]",
"startTime": 60000,
"endTime": 86340000
}
],
"cashes": [
{
"cashGuid": "{7F2B98A5-B365-41EB-A5EC-265E52F05AF1}",
"cashNetName": "3252_KIOSK_PRN_1"
},
{
"cashGuid": "{4EAF23A6-2623-401B-A705-88644A2D4976}",
"cashNetName": "3252_TER1"
},
{
"cashGuid": "{3F6CE085-1048-47BE-844C-9A3C45EE3851}",
"cashNetName": "3252_TER2"
},
{
"cashGuid": "{50EA4090-15D0-4E43-B22E-2324C5E8193A}",
"cashNetName": "3252_TER3"
},
{
"cashGuid": "{CEB84F65-0A96-48B4-9EA3-B31A25FFC4DD}",
"cashNetName": "3252_PRN"
},
{
"cashGuid": "{A0E029D9-D6D3-414E-9B30-19329677F940}",
"cashNetName": "3252_KIOSK_PRN_2"
},
{
"cashGuid": "{E089FA8A-8610-473E-B1AB-0ECC624F5A36}",
"cashNetName": "CASH_ONE"
}
],
"champsID": "234234234234211",
"kioskName": {
"cashGuid": "{A0E029D9-D6D3-414E-9B30-19329677F940}",
"cashNetName": "3252_KIOSK_PRN_2"
},
"kioskAppVersion": {
"back": " v0.0.383.21",
"front": "0.0.330.21",
"theme": "KFCCee"
},
"objectCode": "199990207",
"tagAB": "AAA"
},
"cnt": 20461
}
}
restaurantSchedule — расписание работы ресторана:
- daysOfWeek — день недели
- startTime — время начала работы (время в миллисекундах от начала суток (00:00))
- endTime — время завершения работы (время в миллисекундах от начала суток (00:00)).
cashes — список активных касс ресторана, от которого работает киоск:
- cashGuid — GUID кассы (в интерфейсе менеджерской r_k поле GUID);
- cashNetName — сетевое имя кассы (в интерфейсе менеджерской r_k поле Network ID)
Тип метрики Time based event
Киоск отправляет название текущего экрана киоска раз в “Интервал отправки состояния (в секундах)”.
Пример
{
"typeData": "Time based event",
"data": {
"state": "Manager functions",
"champsID": "234234234234211",
"kioskName": {
"cashGuid": "{1E5C9B01-A065-48B0-882A-DDB46C22BC9C}",
"cashNetName": "RK7CASH004"
},
"kioskAppVersion": {
"back": " v0.0.383.21",
"front": "0.0.330.21",
"theme": "KFCCee"
},
"objectCode": "199990001",
"tagAB": "AAA"
},
"cnt": 20433
}
Варианты для поля state (описывает текущий экран на киоске):
- Waiting window — начальный приветственный экран: киоск работает, им не пользуются на момент отправки метрики
- Order — процесс работы с заказом. Начинается со входа в меню пользователем киоска
- Manager functions — персонал выполняет работу в менеджерской киоска
- Locked — киоск заблокирован
- Error — на экране киоска ошибка (например, если при оплате пошло что-то не так). Сообщение выводится, киоск сохраняет работоспособность
- Unknown — другой экран.
Тип метрики Event based event
Киоск отправляет информацию по оплате заказа или по отправке заказа для оплаты на кассе.
Пример
{
"typeData": "Event based event",
"data": {
"orderResult": "successfully",
"orderGuid": "{DCD36825-1EC0-44FC-8011-F568D18203B8}",
"error": {
"code": "0",
"msg": "unknown"
},
"champsID": "234234234234211",
"kioskName": {
"cashGuid": "{1E5C9B01-A065-48B0-882A-DDB46C22BC9C}",
"cashNetName": "RK7CASH004"
},
"kioskAppVersion": {
"back": " v0.0.383.21",
"front": "0.0.309.21",
"theme": "KFCMena"
},
"objectCode": "199990001",
"tagAB": "AAA"
},
"cnt": 20418
}
orderResult — результат работы с заказом.
Возможные варианты заполнения:
- Successfully — заказ успешно оплачен
- Failed — при оплате произошла ошибка
- Error_sending — ошибка при отправке заказа для оплаты на кассе
- Sended — заказ успешно отправлен на кассу для оплаты.
- orderGuid — GUID заказа. Заполнен только если оплата происходит на киоске
error — информация по ошибке (при оплате или при отправке заказа для оплаты на кассе):
- code — код ошибки. Если ошибки нет, то значение 0.
- msg — текст ошибки. Если ошибки нет, то значение unknown.
Примеры ошибок
"error": {
"code": "RK7_3813",
"msg": "Интерфейс СБП: Ошибка \"Операция отменена\"(18)."
}
"error": {
"code": "RK7_236",
"msg": "Ошибка отправки данных на SBP_FARCARDS2."
}
"error": {
"code": "RK7_2043",
"msg": "Компьютер принтера \"3252_KIOSK_PRN_2 Plaintex 1(2123)\" (3252_KIOSK_PRN_2:3252_KIOSK_PRN_2) не подключен."
}
"error": {
"code": "RK7_2703",
"msg": "Некорректный код карты ПДС \"{B4034D6A-C0D0-4DFB-B768-689D7D20DD15}\"."
}
"error": {
"code": "RK7_3813",
"msg": "Интерфейс СБП: Ошибка \"Неверные параметры.\"(18)."
}
Ошибки на Киоске могут быть как внешними (от r_keeper 7), так и внутренними.
Коды внутренних ошибок:
Коды внешних ошибок, возвращенных от rk7 (обозначаются с помощью префикса RK7_ и кода самой ошибки) перечислены в статье Коды ошибок.