Integration Service
最新
API 定義から - 最新 Automation Cloud
バナーの背景画像
ロゴ
Integration Service ユーザー ガイド
最終更新日 2024年2月14日

API 定義から構築

新しいコネクタを作成する

  1. [API 定義から開始] を選択した場合、API 定義を指定する必要があります。

    • ローカル ファイルから - Postman または Swagger コレクションをアップロードします。
    • URL から - ファイルの URL を入力します。例: https://petstore.swagger.io/v2/swagger.json


  2. [続行] をクリックします。

コネクタを構成する

  1. [インポートを確認] ウィンドウでは次の操作を行えます。

    • [プロバイダー名][アプリケーション名][コネクタ名] を変更できます。
    • カスタム コネクタで使用するリソースを変更できます。利用可能なすべてのリソースが自動的に選択されるので、除外するオプションの選択を解除します。

      • [検索] バーを使用して特定のリソースを検索します。



    • [作成] をクリックします。
  2. [設定] ウィンドウが表示されます。
  3. [情報] タブでは、次のフィールドを設定できます。

    • コネクタ プレフィックス – 例: documentation。この値は、コネクタ キーに反映されます (例: documentation-swaggerpetstore-swaggerpetstore)。
    • プロバイダー名 – プロバイダー名を入力します。
    • アプリケーション名 – アプリケーション名を入力します。
    • API の種類 – 現在サポートされている API は REST のみであるため、このフィールドは既定で無効化されています。
    • 表示名 – コネクタ カタログに表示される、コネクタの名前です。
    • 説明 – コネクタの説明を入力します。
    • アイコン[参照] をクリックして、コンピューターから画像をアップロードします。
  4. [カタログ プレビュー] では、カスタム コネクタが Integration Service のコネクタ カタログにどのように表示されるかが表示されます。
  5. [保存] をクリックします。



ベース API を設定する

[ベース API] タブで、アプリケーション API のベース URL とページネーションを設定します。

  • ベース URL – コネクタの作成時に宣言された値が自動的に入力されます。
  • ページネーションの種類 – ドロップダウンで使用できるオプションは、[1 からページ番号を開始]、[0 からページ番号を開始]、[オフセット]、[カスタム] です。ベンダーのドキュメントにページネーションの詳細の記載がない場合は、既定値のままにします。
  • ページネーションの最大値 – 既定値は 100 です。ベンダーのドキュメントにページネーションの詳細の記載がない場合は、既定値のままにします。
  • Content-Type ヘッダー – 現在は「application/json」のみがサポートされているため、このフィールドは既定で無効化されています。
  • Accept ヘッダー – 現在は「application/json」のみがサポートされているため、このフィールドは既定で無効化されています。


認証方法を設定する

[認証] タブで、コネクタの認証の種類を設定します。サポートされるオプションは次のとおりです。

  • ベーシック
  • OAuth 2.0

    • 認可コード
    • PKCE による認可コード
    • クライアント資格情報
  • API キー
  • 個人用アクセス トークン (PAT)
  • 認証なし

    注: 認証を設定する際は、作成したコネクタを使用する人がどのように認証するかを設定します。コネクタを使用する人とは、コネクタを構築中の自分自身を指しますが、同時に、作成したコネクタを使用する他のユーザーも含みます。

基本認証



  1. [アクション] 列の下の編集アイコンをクリックして、各プロパティを設定します。既定では、[ユーザー名][パスワード] が表示されています。
  2. 認証時に使用するフィールドを追加する場合は、[パラメーターを追加] をクリックします。

    • 表示名 - 接続時にユーザーに表示されます。
    • – コネクション ダイアログの入力フィールドを定義します。ドロップダウンからオプション (true/false、パスワード、テスト、はい/いいえ) を選択します。
    • ユーザーに確認 – ユーザー入力が必要な場合は、[はい] に設定します。
    • – 既定値を設定するには、このフィールドを使用します。
    • ヒント テキスト – 入力フィールドのユーザー ガイダンスです。
    • プロバイダー名 - API 呼び出しの技術キーです。
    • プロバイダーに次の種類として送信 – API が値をどのように受け取るか指定します。ドロップダウンからオプション (設定、ヘッダー、パス、本文、クエリ、フォーム) を選択します。既定値は header です。


  3. [保存] をクリックして、新しい認証パラメーターを保存します。
  4. 認証を基本認証の元の値にリセットする場合は、[既定値にリセット] オプションを使用します。この操作は取り消せません。

OAuth 2.0 の認可コード

OAuth 2.0 認可コードを使用するには、連携するアプリケーションに OAuth アプリを作成し、コネクタの構成に必要な資格情報をそこから取得する必要があります。

次のフィールドを設定します。

  • クライアント ID
  • クライアント シークレット
  • スコープ
  • 認可 URL
  • トークン URL
  • トークン更新 URL
  • 基本ヘッダー
  • トークン失効 URL
  • 更新間隔

    注: 認可 URL、トークン URL、更新トークン URL は、アプリの API ドキュメントに記載する必要があります。


PKCE を使用した OAuth 2.0 認可コード

PKCE を使用した OAuth 2.0 認可コードは OAuth 2.0 認可コードのメソッドと同一ですが、[OAuth2 PKCE のコード チャレンジ メソッド] フィールドも含まれます。



OAuth 2.0 クライアント資格情報

OAuth 2.0 クライアント資格情報の場合は、次のフィールドを設定する必要があります。

  • クライアント ID
  • クライアント シークレット
  • スコープ
  • トークン URL
  • 基本ヘッダー
  • 更新間隔



API キー

このオプションは、API 呼び出しを実行するのに API キーが必要なアプリとの連携に使用します。

[API キー] フィールドに目的の値を設定します。



個人用アクセス トークン

このオプションは、API 呼び出しを実行するのにベアラー トークンが必要なアプリとの連携に使用します。

[個人用アクセス トークン] フィールドにベアラー トークンを設定します。



認証なし

コネクタの使用にユーザーの認証が不要な場合は、このオプションを使用します。

コネクションをテストする

認証設定が完了したら、ドロップダウン メニューから [コネクションを追加] を選択します。

接続に成功すると、ステータスは [接続済み] に更新されます。

リソース

コネクタ ビルダーは、指定された API 定義に基づいてリソースのリストを生成します。

左側のメニューには、グループ別に整理された、利用可能なリソースのリストが表示されます。



  1. 省略記号をクリックして、各メソッドの詳細な設定を行います。以下を実行できます。

    • メソッドを追加[新しいリソースを作成] ウィンドウが開きます。
    • メソッドの削除を許可 – グループの各リソースに対して削除アイコンを有効化します。
    • 編集パス – リソースのパスを編集します。たとえば、[BASE URL]/pet = https://petstore.swagger.io/v2/pet と指定します。
    • 削除 – リソース グループを削除します。この操作は元に戻せないことを示すメッセージが表示されます。
    • 複製[リソースを複製] ウィンドウが開きます。このウィンドウでは [パス] の編集、[表示名] の入力、[メソッドを選択] からのメソッドの選択ができます。



  2. 次の 2 つの方法で新しいリソース グループを作成することもできます。

    • [空] から
    • [cURL] から
  3. [空] から新しいリソースを設定する場合は、次のフィールドを設定します。

    • パス - [Base URL]/[path]
    • 表示名
    • メソッドを選択 - GET、GETBYID、POST、PUT、PATCH、DELETE



  4. cURL から新しいリソースを設定する場合は、cURL コマンドを入力します。

リソースの設定

リソースを選択すると、次のウィンドウが表示されます。



選択したリソース メソッドに応じて、設定タブ ([パラメーター][応答フィールド][要求フィールド][ページネーション][検索]) が表示されます。

パラメーター

たとえば、GET メソッドの場合は 4 つのタブすべてが利用可能です。POST メソッドでは、[パラメーター]、[要求フィールド]、および [応答フィールド] タブのみ表示されます。

[パラメーター] タブでは、選択したリソースで利用可能なパラメーターのリストを確認したり、新しいパラメーターを追加したり、既存のリソースからパラメーターをインポートしたりできます。

この表に一覧表示されているパラメーターは、カスタム コネクタを使用してオートメーションを構築するときに Studio で使用するパラメーターです。

例として、コネクタ ビルダー アクティビティ パッケージの [レコードを取得] アクティビティを示します。



Pet オブジェクトは Pet リソース グループに対応しており、利用可能なフィールドは GETBYID リソース用に設定されたフィールドです。



[応答フィールド] と [要求フィールド]

各リソースの [応答フィールド] および [要求フィールド] は、要求を送信する際に自動的に生成されます。

各タブでは、任意のフィールドを編集または削除できます。[編集] アイコンをクリックすると、次の設定ウィンドウが表示されます。



[応答フィールド][要求フィールド] タブでは、次のオプションも利用可能です。



  • 要求送信時に上書きチェックボックス - オンの場合、要求の送信の実行時にフィールド リストが再生成されます。リソースに新しいフィールドを追加した場合は、このオプションは選択しないでください
  • その他のオプション ボタン

    オプション

    機能

    応答のルート キーを更新

    応答内の入れ子になった配列を処理する場合の応答キーを定義します。

    メソッドのフィールドをすべて削除

    選択したメソッドのフィールドをすべて削除します。

    ペイロードから生成

    サービス ドキュメントからのサンプル ペイロードまたは API 呼び出しを使用して、リソース フィールドを生成します。

  • 行を追加 ボタン - リソースに新しいフィールドを追加します。

[表示する列] アイコンをクリックして、フィールド表内の列を追加または削除します。



[メソッド] 列の各色は、特定のメソッド (GET、GETBYID、POST、PUT、PATCH、DELETE) に対応しています。



ページネーション

要求が一覧で帰ってくることが予想されるリソースの場合は、[ページネーション] を有効化します。また、入れ子になったリストの場合、ページネーションを有効化する時は、[設定] タブで 応答のルート キーを定義する必要があります。

検索

リソースの検索設定を許可するには、[検索を有効化] チェックボックスをオンにします。

必要な構成がすべて完了したら、「コネクタをパブリッシュする」セクションを参照してパブリッシュを行えます。

[サポートとサービス] アイコン
サポートを受ける
UiPath アカデミーのアイコン
RPA について学ぶ - オートメーション コース
UiPath フォーラムのアイコン
UiPath コミュニティ フォーラム
UiPath ロゴ (白)
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.