Soracom

Users

ドキュメント
Home ドキュメント SORACOM Flux アクションリファレンス

SORACOM API アクション

SORACOM API アクションは、指定した SORACOM API を SAM ユーザーの権限で実行します。

チャネルにアクションを追加する手順については、チャネルにアクションを追加する (処理を分岐する) を参照してください。

SORACOM API アクションの設定

ここでは、SORACOM API アクションの CONFIG について説明します。そのほかの項目については、アクションリファレンスの 新しいアクションを作成画面 を参照してください。

CONFIG

SORACOM API アクションを設定します。

項目説明
[API]

実行する API を選択します。API について詳しくは、SORACOM API リファレンス を参照してください。

API によっては選択しても利用できない場合があります

以下の API は選択できますが、選択しても利用できません。

API によっては選択肢に表示されない場合があります

以下の API は選択できません。

  • 認証に関する API (Auth:* API)
  • SIM、SORACOM Inventory デバイス、Sigfox デバイスの検索 (Query) に関する API (Query:* API)
[URL]

[API] で選択した API の HTTP メソッドとパスが表示されます。パスは編集できます。たとえば、パスに {sim_id} などのプレースホルダーが含まれている場合は更新してください。また、クエリパラメーターを設定できる API の場合は、?limit=1?tag_name=name&tag_value=test のように入力できます。指定できる内容は、API によって異なります。詳しくは、SORACOM API リファレンス を参照してください。

パスに {sim_id} などのプレースホルダーが含まれている場合は更新してください

たとえば、/sims/{sim_id} など、API のパスにプレースホルダーが含まれている場合は、実際の SIM ID に置き換えてください。

  • この入力欄では、Flux アプリが起動するトリガーに関するデータを表す式 (例: ${event.payload.temp}) や、アクションを追加したチャネルに関するデータを表す式 (例: ${payload.temp}) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。
[HTTP ボディ]

HTTP ボディを指定します。指定できる内容は、API によって異なります。詳しくは、SORACOM API リファレンス を参照してください。

Flux アプリが起動するトリガーに関するデータを表す式 (例: ${event.payload.temp}) や、アクションを追加したチャネルに関するデータを表す式 (例: ${payload.temp}) を入力できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。

HTTP ボディは content-type: application/json で送信されます

FileEntry:putFile API は、任意のデータをリクエストボディとして送信できますが、SORACOM API アクションで実行する場合は、リクエストボディは content-type: application/json で送信されます。

[注意点を理解して利用する]

注意点をよく読み、理解できたらチェックを入れます。

API の実行に伴い課金が発生することがあります

SORACOM API アクションの利用、および API の実行は無料ですが、API を実行した結果、課金が発生することがあります。API の仕様やその結果発生する料金についてよく理解したうえで利用してください。

[API を実行する SAM ユーザー]

API を実行する (API の実行権限がある) SAM ユーザーを作成、または選択します。

  • 新しく SAM ユーザーを作成する場合は、[新しく SAM User を作成する] をクリックして、[SAM User 名] に SAM ユーザーの名前を入力します。

    なお、新しく SAM ユーザーを作成する場合は、[API] で選択した SORACOM API が実行できるように、SAM ユーザーの [権限設定][信頼ポリシー] が自動的に設定されます。

    • SAM ユーザーの [権限設定] で、[API] で選択した SORACOM API の実行が許可されます。

    • SAM ユーザーの [信頼ポリシー] で、Flux アプリが SAM ユーザーの権限で SORACOM API を実行することが許可されます。

  • 既存の SAM ユーザーから選択する場合は、あらかじめ SAM ユーザーの [権限設定][信頼ポリシー] を以下のように設定してから、SORACOM API アクションの [既存の SAM User から選択する] をクリックして、[SAM User] で既存の SAM ユーザーを選択します。

    1. SAM ユーザーの [権限設定] で、SORACOM API アクションの [API] で選択した API の実行を許可します。

      Group:listGroups の実行を許可する例:

      {
        "statements": [
          {
            "effect": "allow",
            "api": [
              "Group:listGroups"
            ]
          }
        ]
      }
      
    2. SAM ユーザーの [信頼ポリシー] で、Flux を信頼するように設定します。

      例:

      {
        "statements": [
          {
            "effect": "allow",
            "principal": {
              "service": [
                "Flux"
              ]
            }
          }
        ]
      }
      
既存の SAM ユーザーから選択する場合は、[権限設定]、[信頼ポリシー] は更新されません
  • [信頼ポリシー] を上記のように設定するまでは、[既存の SAM User から選択する][SAM User] で選択できません。
  • [権限設定] を上記のように設定するまでは、ソラカメ画像取得アクションは実行されません。
SORACOM API アクションを編集しても SAM ユーザーの設定は更新されません

SORACOM API アクションで実行する API を変更する場合は、すでに設定された SAM ユーザーの設定もあわせて編集するか、SORACOM API アクションを再作成してください。

SAM ユーザーの [SORACOM リソース認証] に SORACOM API アクションの SRN が自動的に追加されます

SORACOM API アクションを保存したり更新したりすると、SAM ユーザーの [認証設定][SORACOM リソース認証] に、SORACOM API アクションの SRN (Soracom Resource Name) が自動的に追加されます。

[SORACOM リソース認証] に追加された SORACOM API アクションの SRN は、自動的に削除されない場合があります。文字数の制限で保存できなくなった場合は、不要な SRN の割り当てを解除してください。

SORACOM API アクションの出力データ

SORACOM API アクションの出力データは、実行した SORACOM API のレスポンスボディです。レスポンスボディは API ごとに異なります。詳しくは、SORACOM API リファレンス を参照してください。

SORACOM API アクションで処理できるレスポンスボディの最大サイズは 32,768 バイトです

レスポンスボディが 32,768 バイトを超えると、Failed to send a http request. Response too large. Max size: 32,768 bytes というエラーが発生します。limit パラメータに対応する API など、API のパラメータでレスポンスの内容を設定できる場合は、レスポンスボディが短くなるように設定してください。レスポンスボディを短くできない API の場合は、SORACOM API アクションでは利用できません。