*Introduction

*Introduction

 

TKH Security Solution | Video Surveillance

VDG Sense | API | Introduction

Versions - VDG Sense 2.6.x and 2.7.x

 

VDG Sense supports an API based on HTTP(S) commands icw XML-formatted messages. This API can be used by 3rd party integrators to include VDG Sense functionality in their application. The API is using a TCP-socket based HTTP(S) command interface using XML-formatted message protocol.

The API describes “get” or “read” functions to retrieve status info and configuration settings like device list, layout settings or server information. But also “write” or “control” functions are possible to perform VMS actions like layout switching or event activation.

Next to that it’s possible to retrieve live and recorded video streams.

Below is a brief overview of functions that can be performed via API:

  • VDG Sense settings

  • Connected devices/cameras

  • Device/camera settings

  • Connected VDG Sense subsystems

  • Layout settings

  • Event definitions

  • Historical record data, with various filter

  • Historical event data, with various filters

A full list of functions is available under Functions.

IMPORTANT: From Sense version 2.7.6 and higher the use of HTTP has been deprecated. This means that the API must be accessed via “https://”. The use of “http://” may lead to incorrect results.