API 定義からのコネクタの構築

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

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

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

     

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

コネクタを構成する

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

   • [プロバイダー名]、[アプリケーション名]、[コネクタ名] を変更できます。

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

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

   • [作成] をクリックします。
     
     

     

     
     
2. [設定] ウィンドウが表示されます。

3. [情報] タブでは、次のフィールドを設定できます。

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

   
   

   

   
   

ベース API を設定する

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

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

  

  
  

認証方法を設定する

[認証] タブで、コネクタの認証の種類を設定します。サポートされるオプションについて詳しくは、「認証の種類」をご覧ください。

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

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

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

リソース

コネクタ ビルダーは、指定された 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) に対応しています。

ページネーション

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

検索

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

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