Обнoвление камеры внешней системoй (v2)

Метод и параметры

PATCH /api/v2/billing/cameras

В связи с выпуском версии (v2) данного запроса, версия v2 является наиболее актуальной. Поддержка версии v1 будет осуществляться в течение шести месяцев после релиза v2. По истечении этого срока работа версии v1 будет прекращена.

Указание камеры осуществляется по mac или по external_id.

Если в запросе указано поле streams с типом видеопотока, который ещё не создан, то указанные настройки будут автоматически применены при создании этого потока.

JSON

{
    "external_id": "bd0a951f-40a2-4edf-b213-bcd90ff5273d",
    "mac": "12:12:12:12:12:11",
    "new_mac": "12:12:12:12:12:12",
    "serial_number": "111111111111",
    "service": "8MP",
    "profile": "[1,0]",
    "name": "Camera 1",
    "group_type": "private",
    "group_id": 16,
    "group_external_id": 16,
    "folder_key": 123,
    "folder_id": 3,
    "is_user_owner": false,
    "latitude": -28.776933731993793,
    "longitude": 76.65771489519997,
    "onvif_credentials": {
        "login": "login",
        "password": "password",
        "port": 80
    },
    "is_can_manage_archive_storage_days": false,
    "is_enabled": true,
    "log_extra": {
        "some": "information"
    },
    "streams": [
        {
            "type": "high",
            "is_archive_enabled": false
        },
        {
            "type": "low",
            "is_archive_enabled": true,
            "archive_storage_days": 14
        }
    ]
}

string external_id – текущий external_id камеры

string mac – текущий МАС-адрес камеры (альтернатива - external_id)

string new_mac – новый МАС-адрес камеры

string serial_number – новый серийный номер камеры

string service – профиль камеры, используется для применения шаблонов

array profile – дополнительные данные камеры

string name – название камеры

string group_type – тип группы камеры

int group_id – ID элемента дерева, в котором нужно создать камеру

string|int group_external_id – ключ элемента дерева, в котором нужно создать камеру

int folder_id – ID приватной папки, в которую нужно поместить камеру

string|int folder_key – ключ приватной папки, в которую нужно поместить камеру

bool is_user_owner – флаг, который отвечает за принадлежность камеры пользователю

double latitude – обозначает широту местоположения камеры

double longitude – обозначает долготу местоположения камеры

array onvif_credentials – учетные данные для доступа к камере по протоколу ONVIF

bool is_enabled – флаг, который отключает/включает захват видео потока камеры. При отключенном захвате архивные записи остаются доступными.

string|array log_extra – дополнительная информация, получаемая из внешней системы.

array streams – настройки архива потоков

object array

int streams.archive_storage_days – глубина архива (1‑90 дней)

bool streams.is_archive_enabled – флаг включения/выключения архива (true | false)

string streams.type – Тип потока (high | low)

200 OK

Успешный ответ

JSON

{
    "id": 26,
    "status": "empty",
    "name": "Camera 1",
    "is_archive_recording": true,
    "archive_storage_days": 5,
    "group_type": "private",
    "is_user_owner": false,
    "is_need_replace": false,
    "latitude": -28.776933731993793,
    "longitude": 76.65771489519997,
    "network_device": {
        "mac": "11:11:11:11:11:11",
        "serial_number": "12345678"
    },
    "folder": {
        "id": 3,
        "key": "123"
    }
}

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. Детально в разделе Общая информация→Валидация.

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

Bash

curl -k --request PATCH\
	--url 'https://your-domain/api/v2/billing/cameras' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "external_id": "string",
    "mac": "string",
    "new_mac": "string",
    "serial_number": "string",
    "service": "string",
    "profile": [],
    "name": "string",
    "group_type": "string",
    "group_id": 0,
    "group_external_id": "string|int",
    "folder_id": 0,
    "folder_key": "string|int",
    "is_user_owner": true,
    "latitude": 0,
    "longitude": 0,
    "onvif_credentials": [],
    "is_enabled": true,
    "log_extra": "string|array",
    "streams": {
        "type": "string",
        "is_archive_enabled": true,
        "archive_storage_days": 0
    },
    "streams.type": "void",
    "streams.is_archive_enabled": "void",
    "streams.archive_storage_days": "void"
}'

PHP

$data = array (
  'external_id' => 'string',
  'mac' => 'string',
  'new_mac' => 'string',
  'serial_number' => 'string',
  'service' => 'string',
  'profile' => 
  array (
  ),
  'name' => 'string',
  'group_type' => 'string',
  'group_id' => 0,
  'group_external_id' => 'string|int',
  'folder_id' => 0,
  'folder_key' => 'string|int',
  'is_user_owner' => true,
  'latitude' => 0.0,
  'longitude' => 0.0,
  'onvif_credentials' => 
  array (
  ),
  'is_enabled' => true,
  'log_extra' => 'string|array',
  'streams' => 
  array (
    'type' => 'string',
    'is_archive_enabled' => true,
    'archive_storage_days' => 0,
  ),
  'streams.type' => 'void',
  'streams.is_archive_enabled' => 'void',
  'streams.archive_storage_days' => 'void',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'PATCH',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v2/billing/cameras', false, $context);