Overview

The Admin API fulfills the functionality that your application can administer devices in the database. Through this Admin API you are able to create, update or delete devices. New status elements have been introduced to the Admin API, that your application gets notified in real time, without polling the status.

No additional HTTP-endpoints are used in comparison to Streaming API. With other words it comes along with all endpoints you have used so far, but now empowers to use HTTP-Verbs like DELETE, POST, PUT apart from GET in case of device options. You only need to use different credentials that you have used previously. So Admin API shares the same base functionality in receiving telegrams and last states, but introduces configuration data from devices as well as some gateway attributes. Please see section Admin API credentials for more information.

The Admin API (http://IP-Address/devices/stream) provides a flow of information that happened in a stream of JSON data.

A message received through Admin API always follows this structure:

{

"header" : {

"content" : "<Content-Type>"

"<Content-Type>" : <Array of objects> | <single object>

}

These content-types you will encounter, depending on what kind of change has been made:

Content-Type	Short description
devices	The first data you receive when connect to HTTP-Endpoint of Admin API. Any device attributes are given that have been made earlier in time.
device	Most likely when a device configuration has been added, updated or deleted.
telegram	A device has sent a status update (direction FROM) or an IP-client has sent a update-request of a device (direction TO).
states	Are no longer given as content type, they are now being enveloped by a device. You will only see this content-type when you connect without admin privileges.

Understanding the admin API

Understanding the admin API

Overview