Protocol integration samples
In the following table, a selection of samples are defined, which you can use as inspiration for your specific solution.
| Sample | Description |
|---|---|
| Alarm List | How to retrieve a short list of already generated alarms from the event server. |
| Bookmark Creator | How bookmarks can be created, maintained and deleted via SOAP protocol. |
| Login .Net SOAP | The most simple C# code for performing a login. |
| OAuth Login Flow | How to log in as a user managed by an external identity provider, for example Okta. |
| RESTful Communication - Python | How to log in and use the RESTful API gateway from a Python application. |
| RESTful Alarms API - Python | How to trigger and retrieve alarms from a Python application. |
| RESTful Events API - Python | How to trigger and retrieve events from a Python application |
| Event and State WebSocket API - Python | How to access the Events and State WebSocket API through the API Gateway from a Python application. |
| TCP Video Viewer | How to utilize the ImageServer protocol to retrieve a sequence of images. |
| Analytics Event Trigger via XML | How analytics events can be submitted to the Event Server via HTTP formatted as XML. |
| Trigger Generic Event | This sample can send a character string to the XProtect Generic Event interpreter. |
| Trigger Generic Event Stream | This sample can send a character string to the XProtect Generic Event interpreter. This sample work continuously on the same TCP/IP session. |
| WebRTC JavaScript Client | How to establish a WebRTC connection with an XProtect VMS through the API Gateway. |
| Chat with WebSocket Messages | How to publish and subscribe to messages from a JavaScript browser application. |
| Event and State WebSocket API - Python | How to access the Events and State WebSocket API through the API Gateway from a Python application. |