BlueCamroo Release Notes 3.1.5
What's New in BlueCamroo?
December wraps up the year with unwrapping the BlueCamroo API. The BlueCamroo API is a way for your own programs to talk to BlueCamroo. It provides simple XML or JSON methods for getting data in and out of BlueCamroo.
What is an API?
API is a simple way for a third party program to get data in and out of BlueCamroo. It's a collection of commands or "API calls" a third party program can issue to BlueCamroo to get data in and out. An API also defines how the data will look coming out of BlueCamroo and how you need to format data to get it into BlueCamroo. It's basically that simple.
BlueCamroo's API provides:
A list of commands and parameters that can be sent to BlueCamroo to perform get (return data), add (add data into BlueCamroo), and delete (remove data from BlueCamroo) functions
The format the data must take to get information into BlueCamroo
The format of the information returned from BlueCamroo
Writing an Application
If you write an application to talk to the BlueCamroo API, your application is responsible for:
Authenticate the connection before issuing commands
Issue commands to BlueCamroo that conform to the API format
Expect data returned in either XML or JSON format
Manipulate the data and put it into a format for end user use or into a format for us by another application
React to error codes
The BlueCamroo API documentation lists the commands your third party application can issue to BlueCamroo. This documentation will explain how to authenticate, the command and parameters you can issue, the format the data is returned, and what error codes you need to trap.