Пример curl-запроса на получение списка серверов:
curl --location --requestGET 'http://cloud.dvor24.com/api/v2/streamers' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'
GET/api/v2/streamers
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| search (string) – поиск. |
| limit (int) – ограничивает количество выходных данных |
| offset (int) – указывает число строк, которое необходимо пропустить в общем массиве данныx. |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| streamers | array | массив серверов |
| address | string | адрес сервера |
| api_key | string | API ключ сервера |
| date_added | integer | дата добавления |
| enabled | boolean | состояние сервера (включен/отключен) |
| hostname | string | хост сервера |
| http_port | integer | http порт |
| https_port | integer | https порт |
| id | integer | идентификатор сервера |
| internet_provider_id | integer | идентификатор интернет провайдера |
| monitoring | boolean | состояние мониторинга (включен/отключен) |
| proc | string | нагрузка на процессов |
| ram | string | использование оперативной памяти |
| rtsp_port | integer | rtsp порт |
| secret_key | string | секретный ключ |
| ssl | boolean | состояние ssl-сертификата (включен/выключен) |
| title | string | название сервера |
| total_archive | integer | общее количество записанного архива |
| total_cameras | integer | общее количество камер |
| total_offline | integer | общее количество камер оффлайн |
| version | string | версия mainStreamer |
| count | integer | общее количество записей |
| success | boolean | информация о статусе запроса |
GET/api/v2/streamers/{id}
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| id | integer | идентификатор сервера |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| server | object | объект, содержащий данные о сервере |
| address | string | адрес сервера |
| api_key | string | API ключ сервера |
| date_added | integer | дата добавления |
| enabled | boolean | состояние сервера (включен/отключен) |
| hostname | string | хост сервера |
| http_port | integer | http порт |
| https_port | integer | https порт |
| id | integer | идентификатор сервера |
| internet_provider_id | integer | идентификатор интернет провайдера |
| monitoring | boolean | состояние мониторинга (включен/отключен) |
| proc | string | нагрузка на процессов |
| ram | string | использование оперативной памяти |
| rtsp_port | integer | rtsp порт |
| secret_key | string | секретный ключ |
| ssl | boolean | состояние ssl-сертификата (включен/выключен) |
| title | string | название сервера |
| total_archive | integer | общее количество записанного архива |
| total_cameras | integer | общее количество камер |
| total_offline | integer | общее количество камер оффлайн |
| version | string | версия mainStreamer |
| cameras | array | данные по камерам на сервере |
| success | boolean | информация о статусе запроса |
POST/api/v2/streamers
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| title | string | название сервера |
| hostname | string | имя хоста |
| apiKey | string | API ключ |
| providerId | string | идентификатор интернет провайдера |
| rtspPort | integer | rtmp порт |
| httpPort | integer | http порт |
| httpsPort | integer | https порт |
| address | string | адрес сервера |
| ssl | boolean | указывает установлен ли на сервере ssl сертификат |
| enabled | boolean | состояние сервера (включен/отключен) |
| monitoring | boolean | состояние мониторинга сервера (включен/отключен) |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
POST/api/v2/streamers/{id}/manage
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| id | integer | идентификатор сервера |
| title | string | название сервера |
| hostname | string | имя хоста |
| providerId | string | идентификатор интернет провайдера |
| rtspPort | integer | rtmp порт |
| httpPort | integer) | http порт |
| httpsPort | integer | https порт |
| address | string | адрес сервера |
| ssl | boolean | указывает установлен ли на сервере ssl сертификат |
| enabled | boolean | состояние сервера (включен/отключен) |
| monitoring | boolean | состояние мониторинга сервера (включен/отключен) |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |
POST/api/v2/streamers/delete
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| streamerIds (integer) – идентификаторы серверов для удаления |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |