HTTP

[HTTP 要求] アクティビティを使用すると、ワークフロー内で JSON ベースの API 要求を実行できます。認証には、汎用 HTTP コネクタ、またはサポートされている任意の Integration Service コネクタを使用できますが、コネクションなしでアクティビティを使用し、要求で認証の詳細を直接指定することもできます。

このアクティビティでは、要求の設定を完全に制御できるので、メソッド、URL、ヘッダー、本文の内容を動的に定義できます。実行後、応答データは後続のワークフロー ステップで参照できるようになるため、外部 API を操作する上で重要なコンポーネントになります。

注: Autopilot を利用すると、目的の cURL をチャットに貼り付けて HTTP 要求を追加できます。

[HTTP アクティビティ] を使用する

[HTTP 要求] アクティビティをワークフローに追加するには、以下の手順を実行します。

1. API ワークフロー デザイナー キャンバスで、プラス (+) アイコンを選択します。[ アクティビティを追加 ] メニューが表示されます。
2. [HTTP] を選択します。
3. [ プロパティ ] パネルで、次のフィールドを設定します。
   • [認証(Authentication)]:使用する認証のタイプ( 手動認証 または コネクタ ベースの認証)です。
   • [コネクタ] - [コネクタ ベースの認証] を選択した場合は、使用するコネクタを選択します。
   • コネクション - Integration Service で確立されたコネクションです。既存のコネクションを選択し、[ + コネクション ] をクリックして新しいコネクションを追加するか、[ コネクションを開く ] をクリックしてコネクションを管理します。
   • メソッド - 要求の HTTP メソッド、GET、POST、PATCH、DELETE、PUT、OPTIONS、または HEAD。
   • 要求 URL — 要求の API エンドポイントです。式エディターを使用して URL を動的に構築できます。たとえば、前のワークフロー ステップから取得した ID を追加できます。ベース URL が設定されている場合は、相対パスを入力します。上書きするには、同じベース ドメインの絶対 URL を使用します。
   • ヘッダー — キー/値としての要求ヘッダー ペア。ヘッダーは JSON オブジェクト形式を使用し、 式エディター例えば：

     {
       "Content-Type": "application/json",
       "Accept": "application/json",
       "Authorization": "Bearer jfio**********"
     }

   • クエリ パラメーター - クエリ パラメーターです。[ディクショナリ エディター] を使用して新しいパラメーターを追加します。
     • 例: query value "select * from Vendor" (QuickBooks Online の場合)。
   • [Body]:GET、OPTIONS、および HEAD を除くすべての HTTP メソッドで使用できます。JSON ベースのペイロードがサポートされており、式エディターを使用して前の手順の出力からのデータを参照できます。
4. ワークフローをデバッグしてアクティビティを実行し、後で使用する出力フィールドを生成します。

HTTP アクティビティの例

次の例では、検証用の要求データを返す HTTPBin に POST 要求を送信します。要求には、動的パス変数、ヘッダー、および構造化された要求本文が含まれます。

[ Debug configuration ] ウィンドウを開き、[ Project Arguments ] セクションに次の JSON 構文を貼り付けて保存します。

{
  "id": 12345,
  "name": "John Doe",
  "isActive": true,
  "balance": 2500.75,
  "createdAt": "2025-03-25T12:00:00Z",
  "tags": [
    "premium",
    "verified",
    "active"
  ],
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "coordinates": {
      "latitude": 40.7128,
      "longitude": -74.006
    }
  },
  "transactions": [
    {
      "transactionId": "txn_001",
      "amount": 150.5,
      "currency": "USD",
      "timestamp": "2025-03-24T10:30:00Z",
    },
    {
      "transactionId": "txn_002",
      "amount": -75.25,
      "currency": "USD",
      "timestamp": "2025-03-23T08:15:00Z"
    }
  ]
}

1. API ワークフロー デザイナー キャンバスに スクリプト アクティビティを追加して、ベアラー トークン値を出力します。
   1. 式エディターを開き、 bearer_token という名前のプロパティを持つ JSON を返します。

      return {
          "bearer_token": "123321123321"
      }

   2. 保存します。
2. デザイナー キャンバスに [HTTP ] アクティビティを追加します。
3. [HTTP] アクティビティを以下のように設定します。
   • メソッド - POST
   • 要求 URL - 式エディターを使用して、 ID パス変数で URL 文字列を作成します。

     "https://www.httpbin.org/anything/" + ($workflow.input.id)

   • ヘッダー — 単純なキーと値の JSON を指定してヘッダーを追加します。また、ベアラー トークンを認可として追加するプロセスもシミュレートします ヘッダ：

     {
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Authorization": ("Bearer " + $context.outputs.Javascript_3.bearer_token)
     }

   • 要求本文 — [式エディター] を使用し、実行構成 JSON を参照して要求本文を動的に構築します。目標は、 オブジェクト内にラップされたトランザクションの配列を要求ペイロードとして渡します。

     {
         "transactions": $workflow.input.transactions
     }

   [ 式の出力 ] パネルには、 アクティビティ テストの入力 データに基づいて最終的な JSON がどのように表示されるかが表示されます。

   
4. ワークフローをデバッグしてアクティビティを実行します。
5. [出力] パネルを確認して HTTP 応答を確認します。