ONVIF API 1.7.0

Методы API для работы с разделом «ONVIF».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела

Метод	Путь
`GET`	`/onvif`
`PUT`	`/onvif`

`GET /onvif`

Раздел: ONVIF.

Возвращает текущую конфигурацию ONVIF

Источник в Teamly

Назначение	URL запроса
Возвращает текущую конфигурацию ONVIF	https://{IP_контроллера}/api/v1/onvif

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Successfully got ONVIF configuration) - удачное выполнение запроса

Название, * - обязательный

Тип

Формат

Назначение

DISCOVERY_MODE*

string

[ Discoverable, NonDiscoverable ]

Режим функции сетевого обнаружения устройств ONVIF

Discoverable: устройство отвечает на широковещательные запросы в локальной сети (по протоколу WS-Discovery, порт UDP 3702)

NonDiscoverable: устройство игнорирует широковещательные запросы обнаружения

string

minLength: 3

Логин

Пример:

{
  "DISCOVERY_MODE": "Discoverable",
  "login": "string"
}

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Get current ONVIF configuration",
  "responses": {
    "200": {
      "description": "Successfully got ONVIF configuration",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "DISCOVERY_MODE",
              "login"
            ],
            "properties": {
              "DISCOVERY_MODE": {
                "type": "string",
                "enum": [
                  "Discoverable",
                  "NonDiscoverable"
                ]
              },
              "login": {
                "type": "string",
                "minLength": 3
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/onvif" \
  -H "Authorization: Bearer <token>"

Пример ответа

{
  "DISCOVERY_MODE": "Discoverable",
  "login": "string"
}

`PUT /onvif`

Раздел: ONVIF.

Настраивает конфигурацию ONVIF

Источник в Teamly

Назначение	URL запроса
Настраивает конфигурацию ONVIF	https://{IP_контроллера}/api/v1/onvif

Параметры запроса:

Название	Тип	Описание
onvif*	object(body)	Тело запроса
BODY
Название * - обязательный	Тип	Формат	Назначение
DISCOVERY_MODE*	string	[ Discoverable, NonDiscoverable ]	Режим функции сетевого обнаружения устройств ONVIF Discoverable: устройство отвечает на широковещательные запросы в локальной сети (по протоколу WS-Discovery, порт UDP 3702) NonDiscoverable: устройство игнорирует широковещательные запросы обнаружения
login	string	minLength: 3
password	string	minLength: 8

Пример:

URL запроса: PUT

https://{IP_контроллера}/api/v1/onvif

Body

{
  "DISCOVERY_MODE": "Discoverable",
  "login": "werty234",
  "password": "Qop34yy@"
}

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

Пример с исправленным синтаксисом JSON

Добавлена закрывающая фигурная скобка.

{
  "success": false,
  "message": "string",
  "data": {}
}

Исходный пример Teamly

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
  "success": false,
  "message": "string",
  "data": {}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI

{
  "description": "Set ONVIF configuration",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "DISCOVERY_MODE"
          ],
          "properties": {
            "DISCOVERY_MODE": {
              "type": "string",
              "enum": [
                "Discoverable",
                "NonDiscoverable"
              ]
            },
            "login": {
              "type": "string",
              "minLength": 3
            },
            "password": {
              "type": "string",
              "minLength": 8
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successfully set new ONVIF configuration",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/onvif" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "DISCOVERY_MODE": "Discoverable",
  "login": "string",
  "password": "stringxx"
}'

Пример тела запроса

{
  "DISCOVERY_MODE": "Discoverable",
  "login": "string",
  "password": "stringxx"
}

Пример ответа

{
  "success": false,
  "message": "string",
  "data": {}
}

Методы раздела​

GET /onvif​

Примеры по OpenAPI​

Пример запроса​

Пример ответа​

PUT /onvif​

Примеры по OpenAPI​

Пример запроса​

Пример тела запроса​

Пример ответа​

Методы раздела

`GET /onvif`

Примеры по OpenAPI

Пример запроса

Пример ответа

`PUT /onvif`

Примеры по OpenAPI

Пример запроса

Пример тела запроса

Пример ответа