Home ドキュメント SORACOM Flux (Public beta) イベントソースリファレンス

API/マニュアル実行イベントソース

「新しいチャネルを作成」画面でイベントソースとして「API/マニュアル実行」を選択してチャネルを作成すると、チャネルを表すエンドポイントにリクエストを送信したときに Flux アプリを起動できます。

チャネルにデータを送信する

API/マニュアル実行イベントソースでは、Flux アプリの ID とチャネル ID を指定して、SORACOM API を実行します。なお、SORACOM API の実行については、SORACOM API 利用ガイドを参照してください。

POST https://api.soracom.io/v1/flux/apps/{app_id}/channels/{channel_id}/messages

項目	説明
ドメイン	`https://api.soracom.io` は日本カバレッジに対するドメインです。グローバルカバレッジの Flux アプリにリクエストを送信する場合は、`https://g.api.soracom.io` です。詳しくは、SORACOM API 利用ガイドを参照してください。
`{app_id}`	Flux アプリの ID。(*1)
`{channel_id}`	チャネルの ID。(*1)

(*1) API エンドポイント (ドメイン、app_id、channel_id を含めた URL) は、チャネルの詳細画面の [イベントソース] タブで確認できます。

チャネルに {"temperature": 25} を送信する例:

$ curl -X POST "https://api.soracom.io/v1/flux/apps/01ABCDEFGHIJKLMNOPQRSTU/channels/01VWXYZABCDEFGHIJKLM/messages" \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '{"temperature": 25}'

チャネルに送信されるデータ

API/マニュアル実行イベントソースを設定したチャネルに送信されるデータは、MESSAGE と CONTEXT です。

実際に Flux アプリに送信されたデータは、SORACOM Flux Studio の [実行履歴] タブで確認できます。詳しくは、実行履歴 (ログ) を参照してください。

MESSAGE

API で送信されたデータです。

CONTEXT

{
  "eventType": "api"
}

項目	説明
`eventType`	イベントの種類。API で送信されたデータが、Flux アプリが起動するトリガーになった場合は、`api` です。