API Gateway (объяснение)

MIP VMS API представляет собой унифицированный RESTful API на базе стандартных отраслевых протоколов, таких как OpenAPI, и предназначен для обеспечения доступа к функциям VMS XProtect, упрощения процесса интеграции проектов и использования в качестве основы для облачных коммуникаций.

XProtect VMS API Gateway обеспечивает возможности интеграции через Milestone Integration Platform VMS API (MIP VMS API).

API Gateway устанавливается локально и выполняет функции внешнего интерфейса и общей точки входа для служб RESTful API и WebSocket Messaging API для всех текущих компонентов сервера VMS (сервер управления, сервер событий, серверы записи, сервер регистрации и т.д.). Службу API Gateway можно установить на тот же хост, где находится сервер управления, или отдельно. Кроме того, можно установить несколько экземпляров (каждый на отдельном хосте).

RESTful API частично реализуется каждым отдельным компонентом сервера VMS, и API Gateway может просто передавать эти запросы и ответы. Что касается других запросов, API Gateway будет преобразовывать запросы и ответы соответствующим образом.

На данный момент API конфигурации, размещаемый на сервере управления, доступен как RESTful API. Также доступны RESTful API событий, API сообщений WebSockets и RESTful API сигналов тревоги, размещенные на сервере событий.

Дополнительные сведения приведены в API Gatewayруководстве администратора и в справочной документации Milestone Integration Platform VMS API.