API docs by Redocly

API конфигурации (1.0)

Download OpenAPI specification:

Конфигурация оборудования

Услуги

Возвращает список услуг зарегистрированных на сервере

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Услуги, в том числе удалённые из конфигурации 

Доступно в СУО версии 1.5.12.1 и выше

Возвращает список всех услуг сервера, в том числе тех, которые ранее были удалены из конфигурации

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Краткая информация об услугах

Возвращает краткий список услуг зарегистрированных на сервере

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Краткая информация об услугах, в том числе об удалённых 

Доступно в СУО версии 1.5.12.1 и выше

Возвращает краткий список услуг зарегистрированных на сервере, в том числе ранее удалённых из конфигурации

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Список меню Deprecated 

Объявлено устаревшим в СУО версии 4.5.3.0 и выше. Рекомендуем использовать метод menus/tree.

Возвращает список меню, зарегистрированных на сервере

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Состав меню Deprecated 

Объявлено устаревшим в СУО версии 4.5.3.0 и выше. Рекомендуем использовать метод menus/tree/{menuId}

Возвращает список пуенктов заданного меню. Если указан несуществующий идентификатор меню, то будет возвращён null.

path Parameters
menuId
required
string <GUID>
Example: be675d0e-f939-c6c1-4835-146d54dc4322

Идентификатор меню

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
Example
[ ]

Дерево меню 

Доступно в СУО версии 4.5.3.0 и выше

Возвращает дерево меню, зарегистрированных на сервере

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Состав меню 

Доступно в СУО версии 4.5.3.0 и выше

Возвращает список пунктов заданного меню. Если указан несуществующий идентификатор меню, то будет возвращён null.

Тип пункта меню может принимать следующие значение:

1 - Услуга
2 - Категория (папка)
3 - Сайт
4 - Маршрут
5 - Приложение
path Parameters
menuId
required
string <GUID>
Example: be675d0e-f939-c6c1-4835-146d54dc4322

Идентификатор меню

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
{
  • "Id": "7ed4b631-fa04-4ec7-80c1-7eb4281226d1",
  • "Name": "Основная группа меню",
  • "GroupId": "48bcc9c6-ea6c-456f-8704-ead12a56c7b5",
  • "ServerId": "38631f99-2dda-4300-a8ae-88cfb22da579"
}

Статусы услуг в талоне

Возвращает список статусов услуг в талоне

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

События пользовательских сессий

Возвращает список типов событий пользовательских сессий

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Краткая информация о сервере

Возвращает краткую информацию о текущем сервере

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
{
  • "Name": "Тестовый филиал 1",
  • "Key": null,
  • "OrganizationName": "ООО Крафт АйТи",
  • "OrganizationFullName": "Общество с ограниченной ответственностью Крафт АйТи",
  • "OrganizationAddress": "625007, Тюменская обл., г. Тюмень, ул. 30 лет Победы, д. 25, стр. 10",
  • "TimeZone": {
    }
}

Список пультов операторов сервера Deprecated 

Доступно в СУО версии 1.5.8.0 и выше

Метод будет удалён в версиях СУО выпущенных после 31.12.2025. Рекомендуем использовать метод workPlaces/tree.

Возвращает список пультов операторов сервера

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Дерево пультов операторов сервера 

Доступно в СУО версии 3.5.1.0 и выше

Возвращает дерево пультов операторов сервера

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получение информации

Информация о состоянии пультов операторов 

Доступно в СУО версии 4.4.5.0 и выше

Возвращает данные о состоянии пультов оператора филиала

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Метрики системы в формате prometheus

Возвращает метрики состояния системы в соответствии с форматом prometheus.

Все метрики начинаются с перфикса "enter". Метки начинающиеся с префикса "dep_" несут информацию о филиале.

  • dep_id - Локальный идентификатор филиала (не соответствует идентификатору этого же филиала на центральном сервере)
  • dep_name - Название филиала

Информационные сообщения могут быть следующих уровней:

  • error - текстовое сообщение о проблеме, ошибки
  • warning - текстовое сообщение, которое может информировать о грядущей проблемеn
  • info - текстовое сообщение, для информирования

Метрики и их метки (label):

  • enter_state - состояние системы.
    • dep_* - опциональные, еcли они есть, значит сообщение показывает состояния в контексте филиала
  • enter_license_state - состояние лицензии
    • dep_* - опциональные, еcли они есть, значит сообщение о лицензии филиала
  • enter_clients - информация о клиентах
    • dep_* - обязательные. Информируют, о клиентах какого филиала идёт речь
    • client_type - опционально. Текстовое сообщение, указывающее тип клиентов. Возможные значения:
      • 0 - пульт оператора
      • 1 - система оповещения
      • 2 - терминал
      • 3 - пульт администратора
      • 4 - пульт оценки качества
    • client_id - опционально. Идентификатор клиента, к которому относится сообщение
header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
text/plain
Внешняя система с токеном b1ab7d73-9226-0eb8-4745-a49a526af8ac не найдена.

Получение информации

Уведомления об обслуживаемых талонах

Возвращает уведомления о приглашённых или обслуживаемых талонах (в зависимости от настроек) для указанного устройства оповещения

path Parameters
clientId
required
string
Example: tv1

Идентификатор устройства оповещения (главное табло, персональное табло, led-контроллер)

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
Example
[ ]

Получение данных

Сводные данные о работе очереди

Возвращает сводные данные по показателям текущей работы очереди

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
{
  • "ActiveWorkPlacesCount": 7,
  • "AverageAwaitingTime": 184.576,
  • "CompletedTickets": [
    ],
  • "CompletedTicketsCount": 15,
  • "Errors": [
    ],
  • "PendingTicketsCount": 7
}

Время ожидания до приглашения на обслуживание

Возвращает прогнозируемое время ожидания перед обслуживанием. Если указан идентификатор услуг, то метод вернёт прогнозируемое значение для данной конкретной услуги. Если услуга не указана, то будет возвращено текущее среднее значение. Если посетитель не может быть обслужен сегодня, то будет возвращено значение -1.

query Parameters
productId
string <GUID>
Example: productId=a64adadc-0727-8829-3d58-cdcb361108c4

Идентификатор услуги

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
text/plain
Внешняя система с токеном b1ab7d73-9226-0eb8-4745-a49a526af8ac не найдена.

Показатели обслуживания за период

Возвращает основные показатели обслуживания за указанный период.

query Parameters
startDate
required
string <date> (API_статистики_и_экспорта_талонов_Date)
Example: startDate=23.05.2025

Дата начала периода

endDate
required
string <date> (API_статистики_и_экспорта_талонов_Date)
Example: endDate=23.05.2025

Дата окончания периода

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
{
  • "Tickets": [
    ],
  • "Awaiting": [
    ],
  • "Operating": [
    ],
  • "PeriodType": 2,
  • "Popularity": [
    ]
}

Список услуг за период

Возвращает список услуг за указанный период.

query Parameters
startDate
required
string <date> (API_статистики_и_экспорта_талонов_Date)
Example: startDate=23.05.2025

Дата начала периода

endDate
required
string <date> (API_статистики_и_экспорта_талонов_Date)
Example: endDate=23.05.2025

Дата окончания периода

header Parameters
Token
required
string <GUID>

Token внешней системы

Responses

Response samples

Content type
application/json
[
  • {
    }
]