Applies to:  WAVE Server API

Summary

Wisenet WAVE VMS Server offers a mostly HTTP-based API that can be used by both WAVE Client applications and third-party software for integration. The API allows you to read and save entities in the system database, control server behavior, and retrieve video streams.

This article explains how to use the built-in API tool to test Wisenet WAVE Server API requests.

Testing the API Documentation

API documentation is included in the WAVE Server software. 

To test the API:

1. If you have WAVE Server installed on your computer, navigate to http://localhost:7001/#/api-tool. 
   
   If the WAVE Server is running on another host, replace <localhost> in the link above with the IP address of the server you are connecting to. Ex: http://<IP address>:7001/#/api-tool
   
   
2. Select the REST to use.
    
3. Click the Try it out button.
   
   A list of Parameters available for that REST is displayed.
   
   
    
4. Change the defaults, as needed. 
    
5. Click Execute.