Introduction
NetBotz Web Services is all about integration. The NetBotz Web Services are intended to provide a set of common, programmer-friendly APIs to 3rd party product and solution developers, as well as end customer developers. These APIs allow 3rd party developers and customers to interact with NetBotz appliances running BotzWare version 2.2.2 or higher on a programmatic level. This will enable developers and customers to integrate their NetBotz appliances easily into their custom solutions and existing software infrastructure.
Obtaining the NetBotz Web Services Toolkit
The NetBotz Web Services Toolkit can be downloaded from the NetBotz Web Services Toolkit forum which is located at http://forums.netbotz.com. You must first register and create an account on the forum to gain access to the Web Services Toolkit forum in order to download the Web Services Toolkit.
NetBotz Web Services Toolkit Capabilities
The APIs implemented with the Web Services Toolkit cover the following features and capabilities:
Discovery and interrogation of any of the sensors and pods in a NetBotz appliance, including all data needed to present the status and readings from these devices.
Query and monitor the alert status and details on the appliance, including access to captured pictures and graphs.
Query the features of any cameras on the NetBotz appliance, and request images from those devices.
Query and manage the user account information on the NetBotz appliances, including creating and updating accounts and updating passwords and privileges.
Query and manage the thresholds used to monitor sensors and generate alerts, including the ability to create new thresholds and update existing ones.
Query and manage the alert profiles and alert actions that control the appliance's response to alerts, including the ability to create new profiles and actions, and update existing ones.
Access the recorded history of the values of the sensors, so that sensor data can be more efficiently captured and recorded.
Query and interact with output control devices, such as power control and relay output hardware.
Manually resolve alerts that are configured to require such action.
Allow the NetBotz appliances to deliver alerts by calling 3rd party Web Services that implement a provided interface standard.
The BotzWare Web Service APIs are available on all NetBotz Model 320, 420 and 500 appliances running BotzWare V2.2.2 or later.
The BotzWare Web Services Toolkit includes the following:
Full documentation of the NetBotz Web Service APIs
WSDL (Web Services Description Language) for each of the defined interfaces
Example code (currently for Visual C#, Visual C++.NET and Visual Basic.NET)
Web Services Toolkit Examples
The following are some examples of how developers and customers can utilize NetBotz Web Services to integrate NetBotz appliances into their IT environment:
Querying NetBotz sensor readings for temperature, humidity and airflow from multiple NetBotz appliances and posting all this information on a simple easy to view web page.
Registering to receive NetBotz sensor alarms and then automatically creating alerts in a problem or ticket management system.
Programmatically adding or deleting the userids on NetBotz appliances for new employees or departing employees
Querying the current camera picture from various appliances and inserting these images into a custom database or web pages.
Support and Assistance with for the NetBotz Web Services Toolkit
All questions and requests relative to the support of the Web Services Toolkit must be directed to Web Services Toolkit forum located at http://forums.netbotz.com. If a private exchange is preferred, questions may be sent by e-mail to wssdk@netbotz.com.
Web Services Frequently Asked Questions
Q1. Is there a charge for the Web Services Toolkit?
A1. No. The Web Services Toolkit is provided free of charge.
Q2. Does the Web Services Toolkit provide programming examples?
A2. Yes. The toolkit provides examples in Visual C#, Visual C++.NET, and Visual Basic.NET.
Q3. Are the Web Services capabilities available for NetBotz Appliances running version 1.x of BotzWare?
A3. No. Web Services is only supported on NetBotz appliances running BotzWare 2.2.2 or higher. NetBotz does not intend to support Web Services on the BotzWare 1.x series appliances.
Q4. How do I obtain a copy of the Web Services Toolkit?
A4. You must access the NetBotz forums site (http://forums.netbotz.com) and register. Once you have registered and logged in, access the "NetBotz Web Services Toolkit" and the first post this forum provides a link to downloading the toolkit.
Q5. What functionality is accessible via Web Services?
A5. Web Services provides the ability to query sensor readings, camera pictures, manage alert actions, alert profiles, as well as controlling output control devices just to name a few.
Q6. Can I programmatically retrieve all of the sensor readings with Web Services and utilize this data inside of one of my existing applications?
A6. Yes. This is precisely why the Web Services interfaces were developed.
More Information
For more information on generic web services please refer to the following URLs:
