NEQTO Flow

概要

NEQTO AppsのFlowを利用しているお客様は、NEQTOデバイスからNEQTO Consoleに送信したデータをお客様の指定するエンドポイントへ転送することができます。

グループでこの機能を有効にするには、グループ設定でFlowを有効にしてください。

オプションサービスタブのグループ編集画面には、NEQTO が提供するさまざまなオプトインサービスが表示されます。

フィールド説明
URL(必須)データを転送するエンドポイントを指定します。必ず https から始まるエンドポイントを設定してください。
Status Code上記のエンドポイントに正しくデータが送信された際に返るステータスコードを指定できます。設定した場合、このステータスコード以外は転送失敗と判断されます。
Custom Headerカスタムヘッダーを入力してください。

保存時にURLへHEADリクエストを送信し、URLの存在確認を行います。5秒以内に任意のステータスコードを受け取れない場合は失敗となりますので、エンドポイントの入力や、エンドポイントのセキュリティ設定などに誤りがないかをご確認の上、再度お試しください。

データを転送する

Flowは設定したエンドポイントに対し、お客様が任意で設定したカスタムヘッダーを含んだPOSTリクエストを行います。ペイロードにはノードIDなどの送信元の情報が自動的に付与され、以下のJSONフォーマットでデータが送信されます。

{
  "company_id": "string", // 会社IDが自動的に付与されます。
  "group_id": "string", // グループID
  "node_id": "string", // ノードID
  "timestamp": "number", // サーバーが処理した時間 (unixtime[ms])
  "data": "JSON" // デバイスが送信したJSONデータ
}

リクエストのヘッダは Content-Type: application/json となります。

5秒以内に転送が完了しない場合は失敗となり、一度のみリトライを行います。またデバイスからの送信データがJSON形式でない場合は送信ができません。

転送の失敗を確認する

Flowはデータ転送が失敗した場合のみ、ノードのダッシュボードの最近のイベントに表示を行います。

Flowが有効なノードのイベントログ

Flowのイベントは、通知を介してアクションをトリガーすることができます。

新しい通知を追加する際には、以下の表に従って、通知の種類とレベルを「Flow」から選択してください。正常に転送が行われている状態を通知に設定することはできません。

種類レベルメッセージ説明
FlowWarnAn unexpected error has occurred. Status Code {{ Status Code }}お客様が設定したStatus Codeとは異なるコードが返っている状態
FlowErrorURL not found, Request timed out, etc.転送が失敗している状態

転送に失敗したデータは動的数値の {value} に入り、アクションで設定したメールやSlack等で確認が可能です。

Updated: 2023-01-13
← 前次 →