tencent cloud

All product documents
IoT Hub
DocumentationIoT HubConsole GuideRule EngineData Forwarding to Third-Party Service
Data Forwarding to Third-Party Service
Download PDF
Last updated: 2024-12-27 10:29:42
Data Forwarding to Third-Party Service
Last updated: 2024-12-27 10:29:42
Download PDF

Overview

When forwarding a message field extracted through a rule to a third-party service, you can customize how to process the data. This is the most flexible way for you to process the message.
Note:
The third-party service must be HTTP- or HTTPS-based. To configure forwarding to a third-party service, you need to provide a URL and port number supporting HTTP or HTTPS. After successful forwarding by the rule engine, the third-party service will receive packets from 42.193.134.62.
The figure below shows the entire process of forwarding data to a third-party service:


For more information on the content and format of the data to be forwarded, please see Data Processing.

Entering Server Configuration

1. Log in to the IoT Hub console and select Rule Engine on the left sidebar.
2. Click the rule to be configured to enter the rule details page and click Add Action.
3. In the pop-up Add Action window, enter relevant information and click Save.
Select "forward" as the action type.
Enter your HTTP or HTTPS service address. IoT Hub will forward data reported by devices to this address.
Please select Authentication Token and enter the corresponding token of your service. You can enter any token for signature generation (this token will be compared with the token contained in the URL of the API for authentication).




Verifying Message Source as IoT Hub

Note:
To ensure the stable use of your backend, please select Authentication Token.

Request ID

If Authentication Token is selected for forwarding to the third-party service (i.e., HTTP forwarding), IoT Hub will add the following fields to the header of the HTTP or HTTPS request:
Parameter
Description
Signature
`Signature` combines the `Token` parameter entered in **Add Action** and the `Timestamp` and `Nonce` parameters in the request
Timestamp
Timestamp
Nonce
Random number

1. The Token, Timestamp, and Nonce parameters are sorted in lexicographical order.
2. The three parameter strings are concatenated into one string for SHA1 encryption.
3. After getting the encrypted string, you can compare it with Signature and verify whether the request comes from IoT Hub.
The sample code used to verify Signature in PHP is as follows:
private function checkSignature()
{
    $signature = $_GET["signature"];
    $timestamp = $_GET["timestamp"];
    $nonce = $_GET["nonce"];

    $token = TOKEN;
    $tmpArr = array($token, $timestamp, $nonce);
    sort($tmpArr, SORT_STRING);
    $tmpStr = implode( $tmpArr );
    $tmpStr = sha1( $tmpStr );

    if( $tmpStr == $signature ){
        return true;
    }else{
        return false;
    }
}

For example, the relevant parameters of a request are as follows, and Token is set to aaa.
Nonce: IkOaKMDalrAzUTxC
Signature: c259ed29ec13ba7c649fe0893007401a36e70453
Timestamp: 1604458421

The string after sorting is 1604458421IkOaKMDalrAzUTxCaaa, and the final SHA1 result is calculated as c259ed29ec13ba7c649fe0893007401a36e70453.
Service address verification
1. When the rule engine is enabled, IoT Hub will send a GET request to the entered server URL, and the following fields will be added to the header of the GET request:
Parameter
Description
Signature
`Signature` combines the `Token` parameter entered in **Add Action** and the `Timestamp` and `Nonce` parameters in the request
Timestamp
Timestamp
Nonce
Random number
Echostr
Random string
Sample message sent by IoT Hub to the third-party service:
GET / HTTP/1.1
Host: **.**.**.**:4443
User-Agent: Go-http-client/1.1
Content-Type: application/json
Echostr: UPWIAFASvDUFcTEE
Nonce: testrance
Signature: abb6c316a8134596d825c5a1295bfa6f7657664d
Timestamp: 1623149590
Accept-Encoding: gzip

2. If the third-party service confirms that the GET request comes from IoT Hub, it needs to return the content of the Echostr parameter as-is in the body. Sample message replied by the third-party service to IoT Hub:
HTTP/1.1 200 OK
Date: Tue, 08 Jun 2021 10:53:10 GMT
Content-Length: 16
Content-Type: text/plain; charset=utf-8

UPWIAFASvDUFcTEE

3. IoT Hub verifies the content of the returned Echostr parameter to check whether the server URL is valid.

Resending Mechanism

The resending mechanism is used to send the message again in case of a failure in the message forwarding process, which makes sure that the message is received. The details are as follows:
If message forwarding fails, the system will retry forwarding at intervals of 1s, 3s, and 10s in sequence. If all three retries fail, the message will be discarded.
If you have configured the forward error action, then after three unsuccessful retries, the message will be forwarded again according to the configured action. If forwarding still fails, the message will be discarded.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon