Web API定義を作成する

Web API定義には、Blue PrismにWeb APIへのHTTPリクエストを送信する方法を指示するために必要なすべてのデータが含まれています。API定義内のデータは、リクエストの作成に必要なURL、HTTPメソッド、ヘッダー、認証を指定して各リクエストの構成方法を決定します。API定義では、データをリクエストに渡すために使用できるパラメーターを定義することもできます。

各API定義は次の要素で構成されています。

• 基本設定 - API定義で構成されたすべてのAPIリクエストに使用される名前、ベースURL、タイムアウト設定。
• アクション - Blue Prismで利用できるようになるWeb APIによって提供される機能。アクションは、定義内の各APIリクエストのリクエスト本文と応答処理を詳述します。
• HTTPヘッダー - このAPI定義のリクエストで使用されるヘッダー。すべてのリクエストで共通ヘッダーが使用され、それらが定義されているアクションには、共通ヘッダーに加えてアクション固有のヘッダーが使用されます。
• パラメーター - ベースURL、URLパス、ヘッダー、リクエスト本文にデータを渡すために使用される動的に展開される参照。パラメーターは、［OAuth 2.0（JWTベアラートークン）］構成の［件名］フィールドでも使用できます。共通パラメーターは任意のアクションで使用でき、アクション固有のパラメーターはそれらが定義されているアクションでのみ使用できます。
• 共通認証 - APIへの各リクエストの認証方法。
• 共通コード - 複雑なAPIリクエストと応答の作成に使用されるコード。

Web API定義は、Blue Prismインタラクティブクライアントのシステム設定で構成します。

1. ［システム］タブを選択します。
2. ナビゲーションツリーで［オブジェクト］>［Web APIサービス］を選択します。

3. オプションメニューで［サービスを追加］をクリックします。

   ［新しいWeb APIサービス］ダイアログが表示されます。