Articles in this section

Nx Server HTTP REST API

Avatar
Nx Support
  • Updated
Follow

What is Nx Server API?

The Server API provides a standard set of HTTP 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:

  • 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

Nx Witness provides documentation to help developers work with the Nx Server. All parameters and expected returns are listed. 

The APIs are all under the RESTFUL standard, so developers are able to simply interact with Nx Server via HTTP by POST or GET request. No matter which programming language you use, you can always retrieve the data and integrate your system with Nx Witness.

How to access API Documentation

  1. Access API documentation in our public demo system:
    address: http://demo.networkoptix.com:7001/static/index.html#/developers/api
    username:     demo@networkoptix.com
    password:     NxDemoUser

  2. Find the API documentation when you install Nx Server:
    Visit http://localhost:7001/static/index.html#/developers/api if you have Nx Server installed on your computer, otherwise replace the localhost with an IP address if the server is installed in the local network.

Testing the API

To help our users get started with Nx Witness, we provide a simple tool for you to test the API and view readable return data. 

  1. Open your web browser and access the Web Admin interface.
  2. Visit the API trial page: 
    http://<server_ip>:<server_port>/static/index.html#/developers
    Example: http://127.0.0.1:7001/static/index.html#/developers

  3. On the page, you will be able to find the “API Testing Tool(new)” under the Server API section.
    Visual Example
     06AB69EF-67D7-42A6-8AD2-33BB5FF536_26.png
  4. Click the link of “API Testing Tool(new)”. You will then see the list of all server APIs, and you could click any of them to test and try the API.
    Visual Example snaopsjf.png

    193BD301-70F4-4F14-86B3-0A7121F2ACdAB.jpeg

Questions

If you have any questions related to this topic or you want to share your experience with other community members or our team, please visit and engage in our support community or reach out to your local reseller. 

 

Related articles

Comments

2 comments

Sort by Date Votes
  • Avatar
    Asadang Tanatipuknon

    Hi there, 

    I'm a new developer, trying to access and use the Nx API. After I've tried, I have many questions.

    For example, in the topic "How to access API documents" section 2.Find the API documentation when you install Nx Server. I couldn't access any functions on the web. It's told me to fill ID, pass. I did it but I could not use any Navigation bar functions. It shows only a white page. 

    Next, it is I couldn't config my laptop camera via its Web Page "http://...." It shows "This page can not be reached "

    This is my email: tritle129@hotmail.com

    thankyou so much,

    T

    0
    Comment actions Permalink
  • Avatar
    Norman Graafsma

    Hi Asadang,

    My apologies for the delay in my response. 

    You wrote: ".... It shows only a white page...."

    I assume you were using Chrome as a browser. In version 80 of Chrome a bug appeared which we resolved in 4.0.0.30434+. So please update your system to this version or newer or use another browser. 

    For developer related questions, please also check out our support community where you can engage with other users, developers, our support team and our developers directly. 

     

     

    0
    Comment actions Permalink

Article is closed for comments.