Domorela's Blog: Introducing Domorela's REST API
In order to deploy an IoT service is a must to publish a web service. One of the best ways to publish that kind of services is by means of REST. This is an stateless HTTP service that usually implements part of the core functions of the Internet of Things in any platform which pretends to be part of an IoT deployment. Domorela not only implements a WUI based on HTTP, but also an HTTP REST API to achieve M2M (Machine to Machine) communication with other devices, systems and applications capable to do so in an IoT environment.
As expossed in previously articles, Domorela is an Intranet of Things platform that deploys an IoT service in a private network. This means no need to be connected to any public cloud to provide any of its capabilities and no data sending to any third party if the final user doesn't want to do so. This results in the fact that the final users obtain the benefits of the IoT thechnology with the maximum level of privacy they want to achieve.
To accomplish with the above, Domorela publishes an HTTP REST API that brings IoT capabilities in a secure way and, remember, without the need to be connected to any cloud. This is, by publishing the service through secure web protocol, avoiding deletion methods and implementing token authentication and authorisation to queries from certain known IP addresses. This way, any device, system or application deployed in the Intranet of Things with a proper authorized IP address can issue HTTP REST queries to Domorela in order to interoperate or exchange information with it.
On the other hand, all those that want to deploy Domorela within a cloud infrastructure handling IoT services, they can freely do it as Domorela can be queried from the Internet if the final users agree. So, if any reseller says at any time to any final user that Internet connection and an external cloud are a must, this is because they will be selling Domorela jointly with a value added service consisting in an integration between its private, hybrid or public cloud services and the Domorela unit of their customers acting as an Edge Gateway, being this one of the use cases of Domorela.
Focusing on the subject of the article, Domorela's REST API publishes several services allowing to send management commands, obtain historical data, query active alarms and acknowledge them, and more. By means of Domorela's REST API, integrators can extend the capabilities of the device to achieve, for instance, long term historical data and others more complex they want to offer to their customers.
At present time Domorela's REST API publishes next five services:
- a KNX service processing queries related to communicate and manage the KNX installation
- an admin service to process queries related to the management of Domorela
- a service to query histories to obtain relevant statistical data
- a service to interact with the alarm service of Domorela
- and finally a service to obtain authentication token to be able to access to the API services
In the next articles we will briefly introduce each of the different REST API services of Domorela.