Камеры

Пример curl-запроса на получение списка камер с тэгом «Детская площадка»:

curl --location --requestGET 'http://cloud.dvor24.com/api/v2/cameras?tags[]=1' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'

Получение списка камер

GET/api/v2/cameras

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
limit	integer	ограничивает количество выходных данных
offset	integer	указывает число строк, которое необходимо пропустить в общем массиве данных
search	string	поиск
serverIds	array	фильтрация по идентификатору сервера
cityIds	array	фильтрация по идентификатору города
repeaterIds	array	фильтрация по идентификатору ретранслятора
off	boolean	показать только отключенные
favorite	boolean	показать избранные камеры
grouping	string	тип группировки камер, возможные значения - address, server, address_entrance, address_tag
tags	array	фильтрация по тэгу
entrance	integer	фильтрация по номеру подъезда

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
cameras	array	массив камер
name	string	наименование камеры в системе
realTime	time	текущее время в формате Unix
title	string	название камеры
number	integer	номер камеры
entrance	integer	номер подъезда
stream_status	boolean	состояние камеры на сервере (включена/выключена)
playback_config	object	конфигурация воспроизведения
server	object	данные о сервере
hostname	string	имя хоста
http_port	integer	http порт
https_port	integer	https порт
rtsp_port	integer	rtsp порт
ssl	boolean	тип подключения (ssl/no ssl)
user_attributes	objects	определяет находится ли камера в избранном
coordinates	array	координаты камеры
objectData	object	данные об объекте
count	integer	общее количество камер на сервере
success	boolean	информация о статусе запроса

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

GET/api/v2/cameras/{name}

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
name	string	наименование камеры

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
name	string	системное название камеры
dvr_depth	integer	глубина хранения архива
actual_beginning_archive	integer	дата фактического начала архива
title	string	название камеры
stream_status	array	статус камеры на сервере (выключена/включена)
playback_config	object	конфигурация воспроизведения
server	object	содержит в себе информацию о сервере
hostname	string	имя хоста
http_port	integer	http порт
https_port	integer	https порт
rtsp_port	integer	rtsp порт
ssl	boolean	тип подключения (ssl/no ssl)
number	integer	номер камеры в системе
tag_name	string	наименование тэга
coordinates	integer	координаты камеры
object_id	integer	идентификатор объекта, к которому прикреплена камера
malfunction_camera_id	integer	идентификатор неисправности камеры
realTime	time	текущее время в формате Unix
repeater_id	integer	идентификатор ретранслятора, если он прикреплен
video_codec	string	видеокодек камеры
objectData	object	информация об объекте
object_number	string	номер объекта
address	string	адрес объекта
cost_additional_day_storage	integer	стоимость дополнительного дня архива
time_zone	object	информация о часовом поясе
time_zone	string	часовой пояс
offset_minutes	integer	смещение в минутах от нулевого часового пояса
checkSecondarySource	boolean	отображает наличие вторичного потока
primary_source	string	первичный поток
secondary_source	string	вторичный поток
access	string	уровень доступа (public/private)
enabled	boolean	состояние камеры (включена/отключена)
tag_id	string	идентификатор тэга
streamer_id	integer	идентификатор сервера
entrance	integer	номер подъезда
short_shutdown_time	integer	последнее время камеры в офлайн
count_shutdown	integer	количество времени камеры в офлайн
max_unavailability_time	integer	максимальное время недоступности камеры
success	boolean	информация о статусе запроса

GET/api/v2/cameras/info/{number}

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
number	string	номер камеры

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
name	string	системное название камеры
dvr_depth	integer	глубина хранения архива
actual_beginning_archive	integer	дата фактического начала архива
title	string	название камеры
stream_status	array	статус камеры на сервере (выключена/включена)
playback_config	object	конфигурация воспроизведения
server	object	содержит в себе информацию о сервере
hostname	string	имя хоста
http_port	integer	http порт
https_port	integer	https порт
rtsp_port	integer	rtsp порт
ssl	boolean	тип подключения (ssl/no ssl)
number	integer	номер камеры в системе
tag_name	string	наименование тэга
coordinates	integer	координаты камеры
object_id	integer	идентификатор объекта, к которому прикреплена камера
malfunction_camera_id	integer	идентификатор неисправности камеры
realTime	time	текущее время в формате Unix
repeater_id	integer	идентификатор ретранслятора, если он прикреплен
video_codec	string	видеокодек камеры
objectData	object	информация об объекте
object_number	string	номер объекта
address	string	адрес объекта
cost_additional_day_storage	integer	стоимость дополнительного дня архива
time_zone	object	информация о часовом поясе
time_zone	string	часовой пояс
offset_minutes	integer	смещение в минутах от нулевого часового пояса
checkSecondarySource	boolean	отображает наличие вторичного потока
primary_source	string	первичный поток
secondary_source	string	вторичный поток
access	string	уровень доступа (public/private)
enabled	boolean	состояние камеры (включена/отключена)
tag_id	string	идентификатор тэга
streamer_id	integer	идентификатор сервера
entrance	integer	номер подъезда
short_shutdown_time	integer	последнее время камеры в офлайн
count_shutdown	integer	количество времени камеры в офлайн
max_unavailability_time	integer	максимальное время недоступности камеры
success	boolean	информация о статусе запроса

Добавление камеры

POST/api/v2/cameras

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
title	string	название камеры
streamUrl	string	первичный поток
substreamUrl	string	вторичный поток
coordinates	string	координаты сервера (43.421 33.959)
radius	integer	радиус обзора камеры
startAngle	integer	начала угла обзора
stopAngle	integer	конец угла обзора
access	string	уровень доступа (private/public)
server	integer	идентификатор сервера
dvrDepth	integer	глубина хранения архива
objectId	integer	идентификатор объекта
location	string	местоположение
tag	integer	идентификатор тэга
entrance	integer	номер подъезда
enabled	boolean	состояние камеры(включена/выключена)
repeaterId	integer	идентификатор ретранслятора
uuid	string	идентификатор камеры с ПО MS-AGENT
maxUnavailabilityTime	integer	максимальное время недоступности камеры
countShutdown	integer	максимальное количество коротких отключений камеры
shortShutdownTime	integer	время короткого отключения камеры

Ответ:
Ключ	Тип	Описание
success	boolean	состояние запроса

Редактирование камеры

POST/api/v2/cameras/{name}/manage

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
name	string	наименование камеры
title	string	название камеры
streamUrl	string	первичный поток
substreamUrl	string	вторичный поток
coordinates	string	координаты сервера (43.421 33.959)
radius	integer	радиус обзора камеры
startAngle	integer	начала угла обзора
stopAngle	integer	конец угла обзора
access	string	уровень доступа (private/public)
server	integer	идентификатор сервера
dvrDepth	integer	глубина хранения архива
objectId	integer	идентификатор объекта
location	string	местоположение
tag	integer	идентификатор тэга
entrance	integer	номер подъезда
enabled	boolean	состояние камеры(включена/выключена)
repeaterId	integer	идентификатор ретранслятора
uuid	string	идентификатор камеры с ПО MS-AGENT
maxUnavailabilityTime	integer	максимальное время недоступности камеры
countShutdown	integer	максимальное количество коротких отключений камеры
shortShutdownTime	integer	время короткого отключения камеры
useRepeater	boolean	состояние подключения ретранслятора

Ответ:
Ключ	Тип	Описание
success	boolean	состояние запроса

Импорт камер

POST/api/v2/cameras/{objectNumber}/import

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
objectNumber	string	номер объекта
camsData	array	массив добавляемых камер
title	string	название камеры
primary_source	string	первичный поток
secondary_source	string	вторичный поток
streamer_id	integer	идентификатор сервера
tag	integer	идентификатор тэга
dvr_depth	integer	глубина хранения архива
enabled	boolean	состояние камеры
alive	boolean	статус камеры
coordinates	string	координаты сервера (43.421 33.959)
access	string	уровень доступа (private/public)
entrance	integer	номер подъезда
repeater_id	integer	идентификатор ретранслятора

Ответ:
Ключ	Тип	Описание
success	boolean	состояние запроса

Удаление камер

POST/api/v2/cameras/manage/delete

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
camNames	array	системные имена камер

Ответ:
Ключ	Тип	Описание
success	boolean	состояние запроса

Api

Авторизация

Api

Поддержка

Содержание

Получение списка камер
Получение данных о камере
Добавление камеры
Редактирование камеры
Импорт камер
Удаление камер