Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

VXG provides a powerful API for integration with web and mobile applications. The API functions are divided into several sections. An interactive API reference (Swagger) can be found in the Docs & API section on VXG Dashboard in corresponding API sections.

Admin API

  • Add/edit/delete cameras

  • Manage storage and bandwidth limits

  • Retrieve usage statistics

  • Store/retrieve meta information

Channel API

  • Get live video URLs

  • Get the recorded video

  • Get stored images and clips

  • Store new images and clips

  • Get recorded video timeline

  • Communication channel (Websocket) for cloud cameras.

Camera Settings API

  • Video settings: bitrate, framerate, resolution, etc.

  • Audio settings

  • PTZ controls

  • Motion and audio detectors

  • System settings

Events and Notifications API

  • Put/Get metadata and events

  • Send notifications

Artificial Intelligence (AI) API

  • Generate images from recorded video

  • Generate images from live video

  • Create clips

  • Get the live video

  • Get the recorded video

Admin API authorization

To authorize your requests to Admin API you need to use your license key that you can find on VXG Dashboard.

The API Key should be injected to Authorization header of every request to Admin API like this:

Authorization: LKey %license_key%

For example, if the API key is "X9tKpuXq0btatj":

Authorization: LKey X9tKpuXq0btatj

Non-admin API authorization

All function calls require an authorization header:

'Authorization: Acc %channel_access_token%'

The %channel_access_token% can be retrieved in two ways:

  • Using Admin API during creating a channel or updating of a channel access token

  • Using Cloud/Server Admin UI page

Example of an authorization header:

'Authorization: Acc eyJhY2Nlc3MiOiAid2F0Y2giLCAidG9rZW4iOiAic2hhcmUuZXlKemFTSTZJRE14T0RoOS41YWEyMjA2N3QxMmNmZjc4MC5GVHpEeUZMYkVLQVNzM2ZJRFZaSDdFMEhhdGMiLCAiY2FtaWQiOiAxMzI0NDUsICJjbW5ncmlkIjogMTMyODUwLCAiYXBpIjogIndlYi5za3l2ci52aWRlb2V4cGVydHNncm91cC5jb20ifQ=='
  • No labels