/site : Данные о кадре🔗
GET /site : Получение кадра🔗
Доступно во всех типах лицензий.
Важно
Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.
Примечание
Доступно получение ответа в формате JSON.
Для получения от сервера кадров для определённой камеры используется запрос к ресурсу site.
Формат запроса🔗
Такие запросы в общем виде имеют следующий формат:
{Протокол}://{Сервер}:{Порт}/site?login={Логин}&password={Пароль}&channelid={Канал}&{Параметр}={Значение параметра}
Где:
Параметр |
Значение по умолчанию |
Описание |
|---|---|---|
Протокол |
http |
Сетевой протокол, выбранный для взаимодействия с сервером Macroscop. По умолчанию используется http, доступность https определяется настройками сервера |
Сервер |
— |
Доменное имя или IP адрес сервера Macroscop |
Порт |
8080 |
Сетевой порт, соответствующий выбранному Протоколу. Порты по умолчанию: 8080 для http; 18080 для https |
Логин |
— |
Имя пользователя Macroscop, от имени которого будет выполняться запрос. Пользователь должен обладать правами доступа к каналам, функциям и возможностям системы, к которым обращается в рамках запроса |
Пароль |
— |
md5-хэш пароля пользователя Macroscop. Если пароль для пользователя не задан, параметр можно оставить пустым или не указывать в запросе |
Канал |
— |
Уникальный идентификатор канала. Может быть получен при выполнении запроса Получение конфигурации системы |
Параметр |
— |
Дополнительный параметр, уточняющий сам запрос или ответ на него. В зависимости от запроса может быть допустимо применение нескольких дополнительных параметров одновременно |
Значение параметра |
— |
Значение применённого дополнительного параметра |
Предупреждение
В случае неправильного логина или пароля будет возвращена ошибка 401 (Unauthorized).
Дополнительные параметры запроса🔗
Параметр |
Значение по умолчанию |
Описание |
|---|---|---|
withcontenttype |
false |
Параметр, определяющий необходимость указать в ответе от сервера заголовок с типом передаваемых данных. Допустимые значения: true, false. Опциональный параметр |
mode |
realtime |
Параметр, определяющий режим потока для передачи кадров. Допустимые значения: realtime — кадр из потока реального времени, archive — кадр из архива. При применении параметра mode=archive необходимо также задать параметр starttime. Опциональный параметр |
starttime |
— |
Параметр, указывающий время в архиве, для которого необходимо передать кадры. Данный параметр состоит из комбинации даты и UTC-времени в формате dd.MM.yyyy HH:mm:ss или dd.MM.yyyy HH:mm:ss.fff. Обязательный параметр, если mode=archive |
resolutionx |
64 |
Желаемая ширина запрашиваемого кадра. Указывается в пикселях. Не может превышать действительную ширину кадра. Опциональный параметр |
resolutiony |
36 |
Желаемая высота запрашиваемого кадра. Указывается в пикселях. Не может превышать действительную высоту кадра. Опциональный параметр |
streamtype |
Последнее доступное значение списка |
Параметр, указывающий поток для получения кадров. Допустимые значения: Main — поток Основной; Alternative — поток Дополнительный 1; SecondAlternative — поток Дополнительный 2; ThirdAlternative — поток Дополнительный 3. Доступность указанных значений зависит от настроек канала |
Примеры запросов🔗
Пример запроса без дополнительных параметров:
GET http://localhost:8080/site?login=root&password=&channelid=706c4691-3d90-41e3-8789-76eb9810648f
В ответ на указанный запрос сервер вернёт кадр из потока реального времени для выбранной камеры.
Примечание
По умолчанию кадр берётся из последнего по очерёдности потока. Например, при получении сервером от камеры четырёх потоков, кадр будет браться из потока Дополнительный 3, что соответствует четвёртому потоку камеры.
Разделение даты и времени осуществляется кодом («%20»).
Пример 1 запроса с дополнительными параметрами:
GET http://localhost:8080/site?login=root&password=&channelid=706c4691-3d90-41e3-8789-76eb9810648f&streamtype=SecondAlternative
В ответ на этот запрос сервер вернёт кадр из потока Дополнительный 2, если это возможно.
Пример 2 запроса с дополнительными параметрами:
GET http://localhost:8080/site?login=root&password=&channelid=706c4691-3d90-41e3-8789-76eb9810648f&withcontenttype=true&mode=archive&starttime=01.01.2023%2000:00:01&resolutionx=640&resolutiony=480
В ответ на указанный запрос сервер вернёт кадр из архива, снятого 01 января 2023 года в 00:00:01 по часовому поясу UTC, добавив к ответу заголовок с типом данных и изменив разрешение на 640x480, если это возможно.