HTTP Server
The HTTP Server resource offers access to data points through a HTTP/REST interface.
This server will accept JSON data via POST or PUT and forwarding that data to corresponding MQTT topic.
User access and authentication can be configured using the existing connectware functionalities for HTTP permissions.
The listening port is the same port 443 which is also used for HTTPS access to the other REST interfaces of the Connectware, where each request with the path
/data
refers to the internal HTTP server for data access.
The HTTP server can be configured using the Cybus::Server::Http
resource. The server resource defines an optional base path prefix in addition to the standard /data
prefix.
Each HTTP route is described by a Cybus::Node::Http
resource that defines the path and http method as parameters to specify the route.
Permissions
User access and authentication can be configured using the existing connectware functionalities for HTTP permissions, see Roles and Permissions. For the example below where the user should PUT or POST to the route data/cybustest/postRoute, the user must be granted matching write permissions, e.g. data/cybustest/#
or data/+/postRoute
.
Commissioning File Specifics
Sending data to the HTTP Server
JSON
If the server receives a messages with the header Content-type=application/json
, it will parse the HTTP message body in JSON format, then transform the content into the internal message convention where the message body is in the value
property. Example:
If the request sent to the server is not parseable as JSON, it will be dropped and not forwarded to the MQTT broker.
Other Formats
Other supported mime-types in the Content-type header are:
application/octet-stream
text/plain
text/xml
text/csv
In all of these cases, the HTTP message body is forwarded to the specified topic without any further modification (no timestamp, no value property).
Receiving data from the HTTP Server
JSON
Each Node with method = GET
has an internal cache, which will store any date written to it using the */write
topic. The cache has a depth of 1, so only the latest data is being stored.
Data will always be in the format of a JSON object containing value and timestamp. If no timestamp is provided, one will be generated.
If no data is available, the server will respond with status of 204.
Sample Commissioning File
The endpoints from the commissioning file can be accessed using the following curl commands. It is assumed that the Connectware is configured so that the data route is accessible by basic auth authentication, and that the user has sufficient HTTP permission to write to the path data/cybustest/postRoute.
The POST based demo endpoint:
The PUT based demo endpoint:
The GET based demo endpoint:
Download:
Last updated