Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Often our customers already have existing front and back-ends and they need to add video functionality (Cloud VMS) to an existing service. The article below describes how this can be done.

...

  1. Authentication service.

  2. Back-end service server with a database.

  3. Web front-end.

Once After being authenticated, the Web front-end communicates with the back-end service server for reading, writing, and processing information.

...

Adding Cloud VMS usually means implementing implementation of the following 3 steps:

  1. Adding VXG Web SDK to the front-end. The Web SDK is an HTML player for playing live and recorded video from VXG Cloud VMS. It includes all common UI controls that can be configured.

  2. Adding VXG non-admin REST API calls to the front-end for calling any functions of the VXG Cloud VMS, for example retrieving a list of images for motion events.

  3. Adding VXG admin REST API calls to the back-end. These calls usually go through a secure server-to-server channel and are used to create or delete channels (add or remove cameras). Once a camera is added, its access token is stored in the back-end database.

...

The Admin REST API calls should be authorized with a Cloud Key that can be found on the Integrator’s dashboard. We strongly recommend using Admin API only through a server-to-server secure channel.

The Non-admin REST API calls should be authorized with the Channel Access Token. The Channel Access Token is generated once the back-end creates a new channel (adds a new camera) and stored in the back-end’s database. The Channel Access Token can be invalidated and thus it’s safe to call Non-admin REST API from the front-end.

The Web SDK also uses the Channel Access Token to play video.

...

You can find a number of HTML and Python samples showing how to use VXG REST API on the GutHub.