Комплекс — программно-аппаратный комплекс EdgeServer.
Сервер — в настоящем документе означает подсистему, реализующую описываемый программный интерфейс комплекса.
Клиент — в настоящем документе означает подсистему, использующую описываемый программный интерфейс.
Архив событий — долговременное хранилище событий от множества комплексов.
Пост архива событий — долговременное хранилище событий от одного комплекса.
Канал поста архива событий — долговременное хранилище событий от одного комплекса, полученных в одной зоне контроля.
Событие — запись о происшествии в зоне контроля, которая относится к определенному каналу поста архива событий.
Событие Fact — факт фиксации проезда транспортного средства через зону контроля.
Доступ к функциям API осуществляется с помощью протокола HTTP. В качестве ответа на запросы клиента могут возвращаться:
данные о структурных компонентах EdgeServer в формате JSON (в кодировке UTF8);
метаданные о событиях в формате JSON (в кодировке UTF8);
медиаданные в формате JPEG.
Конкретные адрес и порт для доступа к устройству зависят от настроек EdgeServer и сети, в которой происходит развертывание.
В запросах все компоненты чувствительны к регистру; порядок параметров (после символа “?”) значения не имеет.
Все запросы должны содержать параметры аутентификации пользователя методом HTTP Basic Authentication.
Обработка запроса не выполняется в случае:
Отсутствия параметров аутентификации в запросе. Сервер возвращает ответ с http-кодом 404 (NOT FOUND).
Несовпадения параметров аутентификации пользователя. Сервер возвращает ответ с http-кодом 401 (UNAUTHORIZED).
Наличия некорректных параметров в запросе. Сервер возвращает ответ с http-кодом 404 (NOT FOUND).
Внутренней ошибки сервера при обработке запроса. Сервер возвращает ответ с http-кодом 500 (INTERNAL). Рекомендуется сообщить об ошибке разработчику.
Ответы сервера могут содержать дополнительные поля, не описанные в настоящем документе. При обработке ответов сервера клиент должен игнорировать такие недокументированные поля.