Skip to main content
Skip table of contents

Генерация архива. VMS Client API

Данный метод используется только толстым клиентом

Логика для толстого клиента и всех остальных клиентов отличается.

Толстый клиент напрямую скачивает архив с медиасервера.

Этот запрос ему возвращает ссылку для скачивания архива с медиасервера и создаёт запись в истории, которую можно посмотреть, см. Список скачиваний архива.

Для всех остальных клиентов логика другая. Запись в историю не создаётся и никакая ссылка не скачивается. Всё происходит асинхронно.

VMS скачивает архив к себе на сервер и через вебсокет отправляет пуш с cсылкой на скачивание архива

Архив удаляется с диска, если лежит там больше 3 часов. Cron по удалению запускается каждые 10 минут

GET/api/v1/cameras/{camera}/archive/link

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

cameraoptional

int

Идентификатор камеры, c которой нужно сгенерировать архив

fromrequired

date

Дата, с которой нужен архив

torequired

date

Дата, до которой нужен архив

Response

200

Ответ для толстого клиента

JSON
{"link": "https://host-name-1.domain.com/archive/download"}
401

Токен авторизации не передан или не валидный

422

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

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

Пример

JSON
curl -k --location --request GET 'https://vms.local/api/v1/cameras/{camera}/archive/link?from=date&to=date' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

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

If this problem persists, please contact our support.