Integration API

An open API is available to facilitate the effective integration of the Video Management System (VMS) platform with external systems. This includes billing platforms, CRM, and telecom provisioning systems.

This section of the technical documentation defines the API methods enabling communication between the VMS and external systems. It provides comprehensive information regarding request structures, data formats, and expected responses.

This section details the API methods across several subsections, each focusing on different integration aspects:

• General information provides an overview of working with the API for integration.

• The Cameras section specifies the API for interacting with cameras controlled by an external system (adding, deleting, retrieving information, etc.).

• The Devices section encompasses the API methods for the administration and control of external system hardware, such as intercoms, Bridge devices, and cameras running Agent software.

• The Tree section provides a robust solution for managing the hierarchical organization of your addresses and associated cameras. It enables you to construct a logical, tree-like system, allowing for intuitive navigation and access control. Within this structure, tree elements (e.g., specific buildings at a given address) contain other objects, such as individual cameras. Additionally, you can incorporate folders to create further subdivisions, facilitating granular access management to these cameras.

• The User section provides a comprehensive set of methods for external customer systems to manage video surveillance user accounts. This includes functionalities such as creating, editing, and deleting user accounts, and other related user management actions.

• Video streams describes the API method for creating video streams.