API enables direct, programmatic interaction between Rayven.io and other software systems. APIs are used to send data securely and efficiently, allowing for real-time data integration, triggering actions in other systems.
What is an API?
The API node serves as a bridge for sharing data between systems by storing selected JSON fields or entire JSON packets. This stored data can then be accessed by external systems via GET requests, enabling seamless integration and interoperability. The primary purpose of the API node is to facilitate data exchange and enable communication between different software applications or services. By utilizing this node, users can leverage the rich data captured within the platform and make it available for analysis, processing, or visualization in other systems. This capability enhances the versatility and utility of the IoT ecosystem, enabling users to extract maximum value from their data assets.
How to Use
Implementation
In the Rayven Workflow Builder:
- Select Outputs.
- Drag the API node to the canvas.
- Double click on the API node to open the configuration window.
Configuration
|
Section: General |
||
|
This section contains basic configuration elements required for any API output node implementation |
||
|
Field |
Requirement |
Comments |
|
Node Name |
Mandatory |
Enter a name for this node. This provides a handle to which you and others can refer, so it should be simple but meaningful and explain the node’s purpose. |
|
Password |
Optional |
Enables users to configure a password for the API. |
|
URL |
Auto filled |
Platform generated URL where users will require Device ID configured in device management in order to utilize the API setup. |
|
Pass Data as Received |
Optional |
If this is checked, the node will store the whole JSON packet against the payload timestamp. |
|
Outbound Payload Format |
Mandatory |
Select format of the API output:
|
|
Section: Columns |
||
|
This section enables users to select the JSON fields that would be made available via the API URL. |
||
|
Field |
Requirement |
Comments |
|
Column |
Mandatory |
Every column represents a new field that the users will receive when utilizing the API GET request. New fields can be added with the “+ Add Value” button below the column list, and columns can be removed with the “X” next to each column. |
|
Data Field Name |
Mandatory |
The auto-populated fields of “Device” and “Event Time” will add the device name and UTC timestamp of the payload that had been stored against the node. Additional columns should be populated by JSON key from the incoming payload. |
|
Display Name |
Mandatory |
Specify the key that will hold the value from the data fields, as this will be included in the API GET response. |
|
Field Selection |
Mandatory |
A dropdown list with the following options:
|