API Gateway (explained)

The MIP VMS API provides a unified RESTful API, based on industry standard protocols such as OpenAPI, for accessing XProtect VMS functionality, simplifying integration projects and serving as a basis for cloud connected communication.

The XProtect VMS API Gateway supports these integration options through the Milestone Integration Platform VMS API (MIP VMS API).

The API Gateway is installed on-premise and is intended to serve as a front-end and common entry point for RESTful API and WebSocket Messaging API services on all the current VMS server components (management server, event server, recording servers, log server, etc). An API Gateway service can be installed on the same host as the management server or separately, and more than one can be installed (each on their own host).

The RESTful API is implemented in part by each specific VMS server component, and the API Gateway can simply pass-through these requests and responses, while for other requests, the API Gateway will convert requests and responses as appropriate.

Currently, the configuration API, hosted by the management server, is available as a RESTful API. The RESTful Events API, Websockets messaging API, and the RESTful Alarms API, hosted by the event server, are also available.

For more information, see the API Gateway administrator manual and the Milestone Integration Platform VMS API reference documentation.