demo Web Services API
The interface of the demo Web Services API is based on the REST (REpresentational State Transfer) design model. This model allows clients to communicate with demo's cloud servers through a simple, well-defined, and secure interface that utilizes the familiar and prevalent HTTP protocol. All requests to the API are made through a URI, which includes a main path plus optional query string parameters. In most cases, clients may use HTTP request headers instead of query string parameters to configure API requests
In order to access information about your specific machines, you will need to obtain an API Key from your sales team.
General API Information
Each of the methods listed below provides access to information about your production environment, ranging from high level lists of machines or locations, down to detailed minute-by-minute data values. Each method has the following characteristics:
Clients who wish to use the demo Web Services API must use a valid API Key with every request. The API Key may be included in the URI as a query string parameter (e.g., ?apiKey=<clientKey>), or as a request header (e.g., X-Ei3-ApiKey: <clientKey>).
The API Key is associated with your demo User Account, and determines which machines you will be able to access.
With some exceptions, all API methods can return data in either JSON or XML format. Exceptions to this are methods which return images, which return JPEG data. Use the format parameter or X-Ei3-Format request header to select the desired format.
All well-constructed API methods will return the HTTP 200 return code, indicating "success". This code does not necessarily indicate that the actual request for data that the client made was successful, however. Clients should examine the X-Ei3-Error response header for more specific error reporting.
Developers may test the demo Web Services API using a special demo API Key. This key will provide access to some demo machines which have a full set of data.
The demo API key is: A763487B-A40E-42ED-A73F-66194FA3ABFB. Include this key in your API requests either as a query string parameter, or a request header.