REST API Online Documentation

If you are a software developer who has been assigned the task of using the Sensor Management REST API to develop a client application that accesses Sensor Management functionality, you should read the online documentation for the API.

The API documentation includes:

• Overview of the API and advice on how to program with it
• A reference section that describes the classes, methods and objects of the REST API

The online documentation is in HTML format. It is available at two different URLs depending on which REST API functionality you want to use:

• URL for API documentation related to performance sessions:

 https://<smIPaddress>/nbapi/doc/application.html

• URL for API documentation related to other functions (devices, inventory, configuration jobs, SAT tests and so on):

https://<smIPaddress>/nbapiemswsweb/doc

To access the Sensor Management web interface and API documentation

We suggest that you open the Sensor Management web interface and familiarize yourself with Sensor Management functionality as you consult the API documentation. Opening the web interface is also a way of checking that the Sensor Management application is running, which is required to use the API.

1. Access the Sensor Management web interface by entering this URL in a browser:

https://<smIPaddress>/businessweb 

2. When prompted for a user name and password, enter the credentials of a valid user.
   The Sensor Management web interface opens. Leave it open so you can refer to it as you read the API documentation.

3. To access API documentation related to performance sessions, open a browser tab and enter this URL:

https://<smIPaddress>/nbapi/doc/application.html

4. To access API documentation related to other functions, enter this URL:

https://<smIPaddress>/nbapiemswsweb/doc