HTTP インタラクション

概要

HTTP インタラクションサービス(UbiHTTP とも呼ばれます)は、デバイス、ウェブサイト、および Web サービス間の通信を、デバイスレベルでプロトコルを実装することなく可能にするサービスです。

UbiHTTP で操作を指定し、それを他の UbiBot 機能(例:アラート機能)でトリガーすることができます。

 

UbiHTTP リクエストの作成

1. 新しい UbiHTTP リクエストの作成

「Data Factory」→「HTTP Interaction」をクリックし、New UbiHTTP を選択します。

2. 設定の指定(Specify Settings)

すべての設定がすべてのリクエストタイプで必要というわけではありません。

すべての UbiHTTP リクエストには、以下のパラメータが必須です。

必須パラメータ 説明
Name UbiHTTP リクエストの一意の名前を入力します。
API Key UbiHTTP リクエスト用に自動生成される API キーです。
Url データを取得または送信する Web サイトのアドレスを入力します。
 http:// または https:// で始める必要があります。
Method Web サイト URL にアクセスする HTTP リクエスト方法を選択します。
GET、POST、PUT、DELETE のいずれかを選択します。

リクエストの内容に応じて、追加のパラメータを指定することができます。
例えば、認証が必要なサーバーへの UbiHTTP リクエストでは、ユーザー名とパスワードの入力が必要です。

オプションパラメータ 説明
HTTP authorized user name URL に認証が必要な場合、プライベートチャンネルやウェブサイトにアクセスするためのユーザー名を入力します。
HTTP authentication password URL に認証が必要な場合、プライベートチャンネルやウェブサイトにアクセスするためのパスワードを入力します。 
Content type リクエストするコンテンツの MIME タイプまたはフォームタイプを入力します。
例:application/x-www-form-ubibot
Host ThingHTTP リクエストでホストアドレスが必要な場合、ドメイン名を入力します。
例:webapi.ubibot.cn
Content

リクエストに含めたいメッセージを入力します。
メッセージ内容に変数を含める場合、以下の置換文字が使用可能です:

%%trigger_subject%%:アラートメッセージの件名

例:Alert Reminder – The channel id XXXX (C-xxxx) is out of alert range

%%trigger_body%%:アラートメッセージの全文

 例:Alert Reminder – The channel id XXXX (C-xxxx) is out of alert range. Sensor: field1 (temperature),
trigger value:1 (rule name:high temperature warning). The trigger ID is 2692595. You can log in the console to check it.

%%trigger_field%%:トリガーフィールドの値

例:field1 (temperature)

%%channel_id%%:チャンネル ID

%%name%%:チャンネル名

%%trigger_type%%:トリガータイプ

%%sampled_at%%:データ取得時刻(タイムスタンプを返す)

例:1603263103

%%rule_type%%:アラートモード

numeric:センサーアラート

no_data_check:オフラインアラート

status_field:USB ダウンアラート

例:numeric

%%rule_name%%:ルール名

%%rule_condition%%:ルールの閾値

%%action_frequency%%:アラートの頻度

change_only:一度きりアラート

change_only_delayed:遅延一度きりアラート

always:継続アラート

always_delayed:遅延継続アラート

 %%frequency%%:遅延アラート設定時の遅延時間(単位:秒)

例:120

%%criteria%%:アラート条件

例:>

%%trigger_id%%:トリガー ID
 
例:2692622

%%trigger%%:トリガー値

例:1

 

UbiHTTP のトリガー

UbiHTTP は、GET または POST リクエストを使用してアラートルールを設定することでトリガーされます。

1.「Data Warehouse」→「Data Warehouse」 をクリック

2.HTTP インタラクションを設定したいデバイスを選択 → 「Rules」 → 「Create Offline/Sensor/USB Down Alert」

3.アプリケーション状況に応じて早期アラート情報を設定

4.アラートモードで 「HTTP interaction」 を選択 → 先ほど作成した UbiHTTP リクエスト名を選択

5.アラートを保存

デバイスのセンサー検出値がユーザー設定の閾値に達すると、UbiHTTP リクエストがトリガーされます。

 

サポートされる置換文字

例:

Body: The temperature now is %%trigger%% ℃.

表示: The temperature now is 27℃.

Body: The trigger field is %%trigger_field%%.

表示: The trigger field is field1 (Temperature).

ブログに戻る