1. Introduction
2. Example Options File
   1. Property Details
   2. Authorization Options
   3. Custom Api Options
   4. Authorization Types
3. Configuration of the HTTPS data source node

Introduction

The HTTPS Client data source is designed to send an HTTPS request to the specified URL each time the device is executed. Subsequently, the payload data will be extracted and loaded from the response content.

Example Options File

{
  "Devices": {
    "Device1": {
      "DeviceType": "Generic",
      ...
      "DataSource": {
        "DataSourceType": "HttpsClient",
        "Url": "https//myserver.com/api/telemetry",
        "MethodType": "Get",
        "Headers": {
          "SomeKey": "SomeValue"
        },
        "Authorization": {
           "Authorization": "DigestAuth",
           "UserName": "MyUser",
           "Password": "MyPassword"
        }
      },
      ...
    }
  }  
}

Property Details

Here is an overview of the parameters for configuring the HTTPS Client data source:

Authorization Options

Here is an overview of the HTTPS Client Authorization Options:

Custom Api Options

Here is an overview of the HTTPS Client Custom Api Options:

Authorization Types

Here is an overview of the HTTPS Client Authorization Types:

Configuration of the HTTPS data source node

Every device should include the Device Information, Data Source, and Filter nodes. To initiate the creation of a device, click the + icon positioned on the top-left side of the ‘Create Device’ screen as illustrated Figure 1. This action prompts a window to open, facilitating the device configuration. Within the same screen, users can select and add the necessary nodes. The ‘Add Node’ window is accessible and displayed as shown in Figure 2.

Figure 1 - Create Device

The window below enables users to add and configure a data source node.

Figure 2 - Add Node

The HTTPS client node consists of features to:

1. Configure the node: Allows users to customize and adjust the settings of the selected node according to their requirements.
2. Show nodes compatible with the selected node: Displays nodes that are compatible with the selected node, providing a streamlined view of related options.
3. Bring up the help centre for the node: Directs users to the help centre for the selected node, offering detailed guidance and documentation.
4. Copy icon: Permits users to duplicate the selected node, facilitating efficient replication of configurations.
5. Delete the node: Enables users to remove the selected node from the configuration, allowing for adjustments and refining the setup.

Figure 3 - Node Features

Upon selecting the Configure the node button in Figure 3, the HTTPS client data source node screen is presented as illustrated in Figure 4. Within this interface, users can input and edit relevant information.

Figure 4 - HTTPS Client data source node

1. Data Source Options: This feature enables users to establish the origin and method type of the data source.
   • Data source type
   • URL
   • Method type
   • Headers: Header key and header value
2. Authorization Options: This feature enables users to authenticate with various clients.
   • Authorization
   • API Key
   • Username
   • Password
   • Bearer Token
3. Disable Server Certificate Validation: This checkbox is a user interface element that, when selected, instructs the system or application to bypass the validation of server certificates during an HTTPS connection. When the Disable Server Certificate Validation checkbox is checked, it means that the usual validation process, which includes checking the certificate against a trusted authority, verifying its expiration, and ensuring its integrity, is skipped.