Термины и определения. Общие положения

Owned by Inna Kabanova (Unlicensed)
Last updated: Apr 15, 2017
1 min read

Комплекс — программно-аппаратный комплекс EDGE.
Сервер — в настоящем документе означает подсистему, реализующую описываемый программный интерфейс комплекса.
Клиент — в настоящем документе означает подсистему, использующую описываемый программный интерфейс.
Архив событий — долговременное хранилище событий от множества комплексов.
Пост архива событий — долговременное хранилище событий от одного комплекса.
Канал поста архива событий — долговременное хранилище событий от одного комплекса, полученных в одной зоне контроля.
Событие — запись о происшествии в зоне контроля, которая относится к определенному каналу поста архива событий.
Событие Fact — факт фиксации проезда транспортного средства через зону контроля.

Доступ к функциям API осуществляется с помощью протокола HTTP. В качестве ответа на запросы клиента могут возвращаться:

  1. данные о структурных компонентах EDGE в формате JSON (в кодировке UTF-8);

  2. метаданные о событиях в формате JSON (в кодировке UTF-8);

  3. медиаданные в формате JPEG.

Конкретные адрес и порт для доступа к устройству зависят от настроек EDGE и сети, в которой происходит развертывание.


В запросах все компоненты чувствительны к регистру; порядок параметров (после символа “?”) значения не имеет.

Все запросы должны содержать параметры аутентификации пользователя методом HTTP Basic Authentication.

Обработка запроса не выполняется в случае:

  1. отсутствия параметров аутентификации в запросе: сервер возвращает ответ с HTTP-кодом 404 (NOT FOUND);

  2. несовпадения параметров аутентификации пользователя: сервер возвращает ответ с HTTP-кодом 401 (UNAUTHORIZED);

  3. наличия некорректных параметров в запросе: сервер возвращает ответ с HTTP-кодом 404 (NOT FOUND);

  4. внутренней ошибки сервера при обработке запроса: сервер возвращает ответ с HTTP-кодом 500 (INTERNAL); рекомендуется сообщить о такой ошибке разработчику.


Ответы сервера могут содержать дополнительные поля, не описанные в настоящем документе. При обработке ответов сервера клиент должен игнорировать такие недокументированные поля.