外部 API を呼び出す

認証済みの Representational State Transfer (REST) API を呼び出し、応答を処理して、下流のワークフロー ノードのデータを抽出します。

構築する内容: 認証された Representational State Transfer (REST) API を呼び出し、応答を処理し、抽出されたデータを下流のノードで利用できるようにするワークフロー。これはフローで最も一般的なパターンの 1 つであり、HTTP エンドポイントを公開するすべてのシステムに適用されます。

必要なもの

• Maestro Flow へのアクセス権を持つ UiPath Automation Cloud アカウント。
• ターゲット API のベース URL、エンドポイント パス、および認証の詳細 (API キー、ベアラー トークン、または基本認証資格情報)。

使用されるノード

• 手動トリガー — ワークフローをオンデマンドで開始します
• HTTP 要求 — REST API を呼び出します
• データ変換 — 応答から必要なフィールドを抽出します
• スクリプト — HTTP 要求のエラー パスに失敗を記録します

手順

1. 新しいフローを作成し、トリガーを追加する

1. Open Maestro Flow and create a new workflow.
2. [ 手動トリガー ] をキャンバスにドラッグします。

2. HTTP 要求ノードを追加して構成します

1. [HTTP 要求] ノードをキャンバスにドラッグし、トリガーに接続します。
2. 設定パネルで、以下の手順を実行します。
   • [ メソッド] を適切な動詞 (GET、 POST、 PUT、 PATCH、または DELETEに設定します。
   • エンドポイントの完全な URL を入力します。
   • [ ヘッダー] に、authentication ヘッダーと content-type ヘッダーを追加します。

API キー認証の場合:

ヘッダーを追加し、キー Authorization と値 Bearer {{ secret.apiKey }}を指定します。secret. のプレフィックスは、セキュリティで保護された変数ストアから値を調べるようフローに指示します。キーをフィールドに直接貼り付けないでください。

基本認証の場合:

キー Authorization と値 Basic {{ secret.encodedCredentials }}のヘッダーを追加します。 encodedCredentials は Base64 でエンコードされた username:password 文字列です。

3. 必要なデータを抽出する

1. [ データ変換 ] ノードをキャンバスにドラッグし、[HTTP 要求] ノードに接続します。
2. [設定] パネルで、必要な応答フィールドを [ $vars.httpRequest1.output.body ] から指定した出力変数にマッピングします。

たとえば、 などの応答からユーザーの名前とメール アドレスを抽出するには、 { "user": { "name": "Alex", "email": "[e-mail]" } }をマッピングします。

• $vars.httpRequest1.output.body.user.name → userName
• $vars.httpRequest1.output.body.user.email → userEmail

4. エラー処理を追加する

1. [HTTP 要求] ノードを選択します。
2. エラー ハンドル (右下のコネクタ) から新しい スクリプト ノードにドラッグします。
3. スクリプト ノードで、 からのエラーをログに記録します$vars.httpRequest1.error

const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. テストとデバッグ

[ テスト] を選択します。実行トレースで、以下の手順を実行します。

• HTTP 要求ノードの statusCode 出力を確認します。200 は成功を意味します。 401 は、認証に誤りがあることを意味します。 404 は URL が間違っていることを意味します。
• データ変換ノードの出力を調べて、フィールドが正しく抽出されたことを確認します。
• エラー パスをテストするには、URL を一時的に無効な値に設定し、エラー パスが実行されることを確認します。

結果

ワークフローは REST API を呼び出し、応答から必要なフィールドを抽出して、エラー パスに失敗を記録します。実行トレースで HTTP ステータス コードと抽出値を調べ、成功パスとエラー パスの両方が期待どおりに機能することを確認できます。

このワークフローを拡張する

• ページネーションを処理する: API が複数のページにわたって結果を返す場合は、追加のページを取得するフォローアップ HTTP 要求ノードを追加し、応答に次のページのカーソルが含まれるかどうかの 判断 で分岐します。
• 結果を別のシステムに書き込みます。データ変換ノードの後に、別の HTTP 要求ノードまたは統合ノードを追加して、データを下流にプッシュします。
• スケジュールを設定する: [手動トリガー] を [ スケジュール設定されたトリガー ] に置き換えて、ワークフローを定期的に実行します。