チャンネル・フィード データ転送

• 概要

Channel Feeds Data Forwardingサービスは、任意のUbiBotデバイスから指定されたURLエンドポイントにオリジナルのフィードデータのコピーを転送します。これは、UbiBotデバイスをサードパーティ プラットフォームのビジネス ロジックやサードパーティ アプリケーションにシームレスに接続するのに便利です。このサービスを利用するには、UbiBotプラットフォームのアクティベーションと、受信データフィードを正しく処理するためのデータエンドポイントの開発が必要です。

• アクティベーション方法

1. https://console.ubibot.com にログインしてください。
2. 左側のメニューから「設定」→「データ転送」をクリックします。
3. 「転送設定の追加」の指示に従ってください。

• データ転送メッセージフォーマット

データ転送は、指定されたエンドポイントURLにPOSTリクエストを送信することで実現されます。Content-Type ヘッダは 「application/json」 に設定される。元のフィードデータは、リクエスト本文に次のように格納されます：

• フィードデータは、指定した URL に JSON 形式で転送さ れます。
• The unique device channel_id:(string)は、異なるデバイスからのデータを区別するために使用できます。
• product_id: (string) 機器のモデル
• serial: (string) デバイスのシリアル番号
• フィードは以下の配列で構成されます：
• created_at: データフィードがサンプリングされた時刻（ISO 8601 形式）。
• field1..field10: センサーの読み取り値
• status: SSID や ICCID などのステータス情報

各メッセージに対して15秒以内にUbiBotプラットフォームへ応答を送信する必要があることに注意してください。

転送データ例：

{
"channel_id": "123456", "product_id": "ubibot-ws1p", "serial": "123456XXXXX", "feeds": [{ "created_at": "2022-04-24T09:06:56Z", "field1": 24.495308 }, { "created_at": "2022-04-24T09:06:56Z", "field2": 82 }, { "created_at": "2022-04-24T09:07:00Z", "field5": -34 }], "status": "mac=98:7b:f3:10:a1:e2,usb=1", "ssid_base64": "VFBHUw==" }

• エンドポイント・レスポンスの要件

①エンドポイントからのレスポンスが15秒以内に行われるようにしてください。

②エンドポイントが 「SUCCESS 」という文字列のレスポンスを送信した場合、プラットフォームはこのフォワードリクエストを成功としてマークします。エンドポイントが 「ERROR 」という文字列を送信した場合は、リクエストが失敗したことを意味します。UbiBotプラットフォームは統計のためにすべてのレスポンス結果を記録しています。

•  シンプルな PHP エンドポイントの例：

<?php
try{ $data = file_get_contents('php://input'); //get POST payload forwarded from the UbiBot platform $json = json_decode($data, true); //parse input data into json. You can handle the $json object from here. //------Please make sure the response is made within 15 seconds, otherwise connection will be disconnected and marked unsuccessful.----------// $myfile = file_put_contents('log.txt', $data.PHP_EOL , FILE_APPEND | LOCK_EX); //Write to a local log file for the demo. echo "SUCCESS"; // if the request has been handled successfully. } catch (Exception $ex) { echo "ERROR";// if there is some error encountered }

• シンプルな NodeJS エンドポイントの例：

const http = require('http');
const server = http.createServer(function (req, res) { let type = req.headers["content-type"]; if (req.method.toLowerCase() === 'post' && type === "application/json") { try{ ////get POST payload var jsonData = ""; req.on("data", function(chunk) { jsonData += chunk; }); req.on("end", function() { //parse input data into json var reqObj = JSON.parse(jsonData); //-----------Make sure response is sent within 15 seconds------------// var fs = require('fs'); fs.writeFile("log.txt", JSON.stringify(reqObj), function(err) { if(err) { res.end('ERROR');//mark request as error } }); res.end('SUCCESS');//mark request as successful }); }catch{ res.end('ERROR');//mark request as error } }else{ res.end('ERROR');//mark request as error } }); //Setup listening IP and port server.listen(8080, "127.0.0.1", function () { console.log("server is started listen port 8080"); });

•  シンプルな Python エンドポイントの例：

from http.server import BaseHTTPRequestHandler, HTTPServer
import cgi import json class testHTTPServer_RequestHandler(BaseHTTPRequestHandler): def do_POST(self): try: ctype, pdict = cgi.parse_header(self.headers.get('content-type')) if ctype == 'application/json': #get POST payload, parse input data into json length = int(self.headers['content-length']) jsonArray = json.loads(self.rfile.read(length)) #-----------Make sure response is made within 15 seconds------------# myfile = open("log.txt",'a') myfile.write(json.dumps(jsonArray)) myfile.write("\n") myfile.close() #request handled successfully self.protocal_version = 'HTTP/1.1' self.send_response(200) self.send_header("Welcome", "Contect") self.end_headers() self.wfile.write(bytes("SUCCESS", "utf-8")) return else: #request handled with error self.protocal_version = 'HTTP/1.1' self.send_response(300) self.send_header("Welcome", "Contect") self.end_headers() self.wfile.write(bytes("ERROR", "utf-8")) return except: #request handled with error self.protocal_version = 'HTTP/1.1' self.send_response(300) self.send_header("Welcome", "Contect") self.end_headers() self.wfile.write(bytes("ERROR", "utf-8")) return def run(): port = 8080 print('starting server, port', port) # Server settings server_address = ('', port) httpd = HTTPServer(server_address, testHTTPServer_RequestHandler) print('running server...') httpd.serve_forever() if __name__ == '__main__': run()

• シンプルな C# ASP.NET エンドポイントの例：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace demo1.Controllers { public class FeedData { public DateTime created_at { get; set; } public object field1 { get; set; } public object field2 { get; set; } public object field3 { get; set; } public object field4 { get; set; } public object field5 { get; set; } public object field6 { get; set; } public object field7 { get; set; } public object field8 { get; set; } public object field9 { get; set; } public object field10 { get; set; } } public class DeviceData { public string channel_id { get; set; } public string status { get; set; } public List feeds { get; set; } public string ssid_base64 { get; set; } } [Route("api/[controller]")] [ApiController] public class RestApiController : ControllerBase { [HttpPost] [Route("recv")] public string ReceiveData([FromBody] DeviceData data) { try { //Data is used for processing return "SUCCESS";//Successfully processed a request } catch (Exception) { return "ERROR";//An error occurred while processing your request } } } }