Macroscop API, SDK и REST API

Macroscop предоставляет открытые API, SDK и REST API, позволяющие сторонним разработчикам расширять функциональность Macroscop, а также обеспечивать одно- или двустороннее взаимодействие между Macroscop и сторонними приложениями.

Macroscop API

Macroscop API — набор веб-интерфейсов прикладного программирования, предоставляемый приложениями Macroscop, позволяющий обеспечивать одно- или двустороннее взаимодействие между приложениями Macroscop и сторонними приложениями. В Macroscop API используются различные типы запросов и возвращаемых данных: HTTP, RTSP, XML, JSON. Macroscop API позволяет обращаться к серверу Macroscop для выполнения следующих задач:

  • получение видеопотоков реального времени и из архива;

  • получение различной информации с сервера Macroscop, в том числе конфигурации системы и журнала событий;

  • отправка ряда команда на выполнение различных действий сервером Macroscop.

Macroscop SDK

Macroscop SDK — комплект средств разработки, позволяющий создавать программное обеспечение, именуемое плагинами (внешними модулями), расширяющее существующие функциональные возможности приложений Macroscop. Данный инструментарий предназначен для .NET разработчиков и содержит набор базовых классов и интерфейсов, а также ряд примеров, демонстрирующих реализацию плагинов. Все исходные файлы SDK написаны на языке C#. В качестве среды разработки рекомендуется использовать Microsoft Visual Studio.

Macroscop REST API

Примечание

Ресурс api/ доступен для всех пользователей и в любом продукте Macroscop.

Macroscop REST API позволяет:

  • Конфигурировать камеры, пользователей, группы, профили экрана, некоторые сценарии автоматизации, модуль подсчета посетителей.

  • Просматривать информацию о состоянии серверов, камер, о поддерживаемых моделях камер.

  • Работать с базами лиц: получать, добавлять, изменять записи о лицах и группах.

Ресурс configure/ функции доступен только для Macroscop с лицензиями Enterprise и ULTRA, конфигурирование с помощью Macroscop REST API может выполняться только пользователем с максимальными правами, т.е. входящим в группу «Старшие администраторы».

Macroscop REST API может применяться для конфигурирования системы без использования приложений Macroscop Конфигуратор и Macroscop Клиент.

Примечание

Описания Macroscop API, SDK и REST API размещены на сайте macroscop.com, на странице Поддержка / Руководства и инструкции.

Описание Macroscop REST API также доступно для просмотра в браузере с помощью Swagger при наличии соответствующей настройки.

Примечание

Комплект средств разработки Macroscop SDK (исходные файлы на C#) предоставляются по запросу. Для использования Macroscop API комплект Macroscop SDK не требуется.