The JavaScript API lets you integrate web applications into the Desktop Client through the built-in Integrations resource. By building a web application as an Integration, you can trigger actions in the VMS directly from your web interface to create a unified user experience.

Capabilities

The API provides two main capabilities:

• Resource management: Add, remove, or manage the VMS resources such as cameras and devices on a layout. You can also control device playback settings, including playback speed and timeline position.

• Error and event handling: Log messages or display notifications directly to users in the Desktop Client.

Common use cases

Use the JavaScript API when your integration aggregates data from external systems and requires a web-based search interface.

For example, integrations with license plate recognition or traffic monitoring systems often collect external metadata and events. By using the API, users can search for past events in your web interface and click a result to jump directly to the associated camera feed or layout in the Desktop Client.

Add an Integration

To connect your web application to the Desktop Client:

1. Open the Main Menu.

2. Select Add > Integration.

3. Enter the URL of your web page.

After you add an Integration, users can open it inside the VMS and interact with its features to trigger actions in the Desktop Client.