A reusable integration deploys across multiple systems with minimal setup, eliminating the need for custom hacks or complex manual configuration.

Making your integration reusable reduces support overhead, simplifies deployment, and allows system administrators of any skill level to implement your solution.

Key principles of reusability

To build an effective, reusable integration for the VMS, design your solution around these principles:

• Automate basic setup: Use the Server API to handle system configuration and set up system rules automatically. This minimizes human error during deployment.

• Work out of the box: Provide sensible default settings to reduce the manual steps required to launch the integration.

• Provide a simple UI: Create a clear interface for connecting to the Media Server or third-party system.

• Design for operators: Use clear status messaging, support flexible configurations, and cover common user scenarios to ensure a user-friendly experience.

Choose an integration method

You can integrate a third-party solution with the Media Server using the Server API, the Rules Engine, or the Metadata SDK.

Server API

Use standard HTTP requests (GET, POST, PUT, etc.) to send data from third-party devices or systems to the VMS. When combined with the Rules Engine, you can automate system configuration or trigger API calls back to third-party devices.

Rules Engine

Use the built-in Rules Engine to automate actions in the VMS, based on specific triggers. You can also push data to external services by creating an event rule that sends an HTTP request when triggered.

For example, when a detects a specific license plate is detected, an event rule can automatically send an HTTP command to open a parking gate.

Metadata SDK

Use the Metadata SDK to build plugins that users can install directly into the VMS.

Metadata SDK plugins allow you to:

• Attach metadata, such as analytics bounding boxes, to video streams.

• Send custom events to the VMS.

• Embed configuration options directly into the native Desktop Client.

While developers primarily use the Metadata SDK for video analytics, you can apply it to other integration scenarios.

Related topics

• Metadata SDK: Learn how to create a video analytics plugin.

• Architecture: Understand plugin control flow.

• API examples: Explore API examples.