Skip to main content
Skip table of contents

Создание камеры. VMS Billing API

Для указания где в дереве создать камеру, можно присылать как id из нашей БД, так и ключ, который указывается при создании элемента дереве, см. Создание элемента дерева

Если камеру нужно поместить в приватную папку, можно присылать как id из нашей БД, так и ключ, который указывался при создании папки.

Данная папка должна быть создана в том же элементе дереве, в котором создаётся камера, см. Создание приватной папки

POST/api/v1/billing/cameras

Headers

Accept

application/json

Body

json

JSON
{
    "name": "Camera 1",
    "mac": "11:11:11:11:11:11",
    "serial_number": "12345678",
    "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,
    "archive_storage_days": 5,
    "service": "8MP",
    "external_id": "unique_id",
    "onvif_credentials": {
        "login": "login",
        "password": "password"
    }
}

namerequired

string

Название камеры

macrequired

string

Mac адрес камеры

serial_numberrequired

string

Серийный номер камеры

group_typerequired

string

Тип группы камеры

group_idrequired

int

Id элемента дерева, в котором нужно создать камеру

group_external_idrequired

string|int

Ключ элемента дерева, в котором нужно создать камеру

folder_idrequired

int

Id приватной папки, в которую нужно поместит камеру

folder_keyrequired

string|int

Ключ приватной папки, в которую нужно поместит камеру

is_user_ownerrequired

bool

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

latituderequired

double

Широта на которой расположена камера

longituderequired

double

Долгота на которой расположена камера

archive_storage_daysrequired

int

Количество дней хранения архива на камере

servicerequired

string

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

external_idrequired

string

Уникальный идентификатор камеры, который можно будет использовать для дальнейшего обращения к этой камере

onvif_credentialsrequired

array

Credentials для доступа в камера по onvif

Response

201

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

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

Возвращает JSON объект с ошибкой, см. Валидация

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

Пример

JSON
curl -k --location --request POST 'https://vms.local/api/v1/billing/cameras' \
--header 'Accept:application/json' \
--header 'Content-Type: application/json \
--data-raw '{
    "name": "Camera 1",
    "mac": "11:11:11:11:11:11",
    "serial_number": "12345678",
    "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,
    "archive_storage_days": 5,
    "service": "8MP",
    "external_id": "unique_id",
    "onvif_credentials": {
        "login": "login",
        "password": "password"
    }
}'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.