BOX 5.0
BOX 5.0: данные API и интеграция сценариев
BOX 5.0: данные API и интеграция сценариев: подробная инструкция, назначение полей, порядок действий и иллюстрации интерфейса.
На этой странице
Общие правила API
Набор методов API и форматы данных зависят от установленной версии. Открывайте Справка → API и используйте её текущую схему. Примеры полей BOX 3.2 помогают понять назначение, но не заменяют описание API BOX 5.0.
| Понятие | Как работать |
|---|---|
required |
Ключ должен присутствовать; допустимость пустой строки определяется отдельной проверкой |
| ID / UUID / название | Разные поля. Получайте ID из каталога, не из номера строки таблицы |
null / пустой массив / отсутствие ключа |
Не взаимозаменяемы; особенно при частичном обновлении |
| Время | Уточните часовой пояс, формат и единицы; отделяйте время кадра от времени регистрации |
| Координаты | Уточните пиксели или доли, размер изображения и порядок точек |
| Пагинация | Обрабатывайте все страницы, сверяйте количество и уникальные ID |
| Запись | Сначала читайте текущую сущность; сохраняйте поля и связи, которые не меняете |
Камера и назначение аналитики
Для интеграции нужны имя, тип источника, адрес/идентификатор, объект, состояния камеры/аналитики/записи и параметры подключения. В схемах семейства BOX встречаются name, media_uri, camera_type, object_id, is_enabled, is_record, is_disable_inference. Последний — обратный флаг: отключение аналитики нельзя путать с её включением.
В BOX 5.0 дополнительно учитывайте назначения сценариев: ID сценария, ID/номер версии, индивидуальные параметры, признаки уникальности и наследования. Точные названия JSON-полей и операций назначения берите из схемы своей сборки. Они не восстанавливаются из названия вкладки и не выводятся автоматически из categories_presets BOX 3.2.
Зоны, пресеты и графы
У зоны есть ID, тип/код, название, цвет и геометрия. У пресета — набор категорий и параметров. У сценария — карточка, версия и логика. Эти сущности не нужно сериализовать как один объект только потому, что они используются одной камерой.
Для графа сохраняйте зависимости моделей и версии. При переносе между установками сопоставляйте ID ресурсов, справочники типов зон и категорий. Копия JSON со старыми ID может быть синтаксически корректной и семантически неверной.
События и решения
Событие связано с камерой, временем, категорией, сценарием/версией при сценарной обработке и медиаданными. Решение оператора и изменение классификации — отдельные действия с историей. Для отчёта сохраняйте исходную категорию, текущую категорию, статус решения и ID.
Отказ обработки, отклонённое событие, непроверенное событие и отсутствие событий — разные состояния. HTTP-успех получения списка не подтверждает полноту выборки без проверки фильтров и пагинации.
Ассеты, модели и запуски
Автоматизация должна фиксировать ресурс и его версию, а не одно изменяемое название. Дождитесь конечного статуса асинхронной операции. Ошибка загрузки пакета, валидации, конвертации и выполнения на данных требует разного исправления.
Для повторяемого теста храните: сценарий/модель и версию, ассет и версию, параметры запуска, статус, результаты и время. Не считайте отправку запроса запуска завершением проверки.
Интервалы присутствия и отчётность
Чтобы считать занятость рабочего места, требуются границы интервалов, график и данные о достоверности наблюдения. Агрегат количества людей, последнее событие и список нарушений не дают полного времени присутствия сами по себе.
Сценарный вариант §4.17 должен передавать интервалы или пары событий начала и конца в согласованном формате. Укажите правила незавершённых интервалов, обрыва потока, повторов и границ смены. Подключение к штатному отчёту КТД проверяется отдельно.
LLM и MCP
Для LLM различайте конфигурацию сервиса, промпт, версию/содержание задания, расписание и результат отдельного вызова. Формат категорий и рамок должен соответствовать потребителю. Ответ HTTP 200 с текстом не гарантирует, что ответ принят обработчиком BOX.
MCP предоставляет предметные операции поверх разрешённых данных. Каталог инструментов запрашивайте у подключённого сервера; не предполагайте одинаковый набор у разных выпусков. Содержательная методика отчёта и ограничения полноты описаны в §14.5.