Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

REST API Call Plugin

Overview

Rest API plugin is responsible for sending HTTP requests to specific endpoints triggered by specific rules

Configuration

You can specify following configuration parameters:

Server-side API

This plugin does not provide any server-side API.

Example

In this example we are going to demonstrate how you can configure Rest API Call extension to be able to send POST or PUT request to particular REST endpoint every time new telemetry message for the device arrives.

Prerequisites before continue REST API Call extension configuration:

REST API Call Plugin Configuration

Let’s configure REST API Call plugin first. Go to Plugins menu, click on a ‘+’ button and create new plugin:

image

image

Please set correctly URL, port, path and authentication method for the REST endpoint where request is going to be transferred.

Save plugin and click on ‘Activate’ plugin button:

image

REST API Call Rule Configuration

Now it’s time to create appropriate Rule.

image

Add filter for POST_TELEMETRY message type:

image

Click ‘Add’ button to add filter.

Then select ‘REST API Call Plugin’ in the drop-down box for the Plugin field:

image

Add action that will send temperature telemetry of device to particular REST action-path. In the action you can provide request type and result code that you expected from the REST endpoint in case of successful call.

image

image

Click ‘Add’ button and then activate Rule.

Sending Temperature Telemetry

Now for any of your devices send Telemetry message that contains ‘temp’ telemetry:

{"temp":73.4}

You should see ‘73.4’ as a body request in appropriate rest endpoint once you’ll post this message.

Here is an example of a command that publish single telemetry message to locally installed Thingsboard:

mosquitto_pub -d -h "localhost" -p 1883 -t "v1/devices/me/telemetry" -u "$ACCESS_TOKEN" -m '{"temp":73.4}'