What is Nx Server API?
The Nx Server API provides a standard set of API calls for 3rd party systems. Using the Server API developers have the ability to access nearly every feature available in the system's thick client, including - but not limited to - the ability to query/manage system resources (servers, cameras, users), manage users and permissions, pull live or recorded video out of the system, generate events, create rules, control PTZ cameras, and more.
How to use Nx Server API?
In general, the developers should develop some program, and write pieces of code to complete some function they want to have. Nx Wintess provides the documents to help the developers correctly using these API to interact with Nx Media Server. Also, all the parameters and expected return are listed.
The APIs are all under RESTFUL standard, so the developers are able to simply interacted with Nx Media Server via HTTP by POST or GET request. No matter which programming languages you are using, you can always retrieve the data and integrate your system with Nx Witness.
Do you have a simple way to test the API?
SURE, we do. Everyone who installed our software can use and test our API.
To help our users to get involving Nx Witness, we provide a simple tool for you to try the API and make the return data readable.
You just need to open your web browser, and access our web interface, and enter the API trial page. The URL is http://<Nx Server IP Address>:<Port>/static/index.html#/debug. For example : http://127.0.0.1:7001/static/index.html#/debug
In the web page, you will need to enter the API path, Request Type, and your parameters. Then Click the button:"Test Method". You will see the result and test it in only one mouse click.