API Gateway - RESTful APIs
The API Gateway is a front-end that serves as a common entry point to services implemented by the other VMS server services.
MIP VMS API overview
For an overview of APIs exposed through the API Gateway, please refer to MIP VMS API overview.
API entry point
At least one API Gateway server must be installed on the same host as the management server or on a separate host, and more than one can be installed (each on their own host).
The API Gateway exposes a list of relevant server and API Gateway URIs at this URI:
/api/.well-known/uris
RESTful APIs are exposed at this entry point:
/api/rest/v1
WebSocket APIs are exposed at these entry points:
/api/ws/events/v1/api/ws/messages/v1
Samples
Plug-in integration
Component integration
Protocol integration