9.2. API クライアントコネクターの追加および管理

手順

1. Fuse Online のナビゲーションパネルで、Customizations > API Client Connectors をクリックします。すでに利用可能な API クライアントコネクターが表示されます。
2. Create API Connector をクリックします。

3. Create API Connector ページで、以下のいずれかを行います。

   • 点線のボックスをクリックし、アップロードする OpenAPI ファイルを選択します。
   • Use a URL を選択し、入力フィールドに OpenAPI ドキュメントの URL を貼り付けます。

4. Next をクリックします。無効なコンテンツや不足しているコンテンツがある場合、必要な修正に関する情報が Fuse Online に表示されます。アップロードする別の OpenAPI ファイルを選択するか、Cancel をクリックします。OpenAPI ファイルを訂正し、更新されたファイルをアップロードします。

   スキーマが有効な場合、Fuse Online はコネクターが提供する操作の概要を表示します。これには、操作の定義に関するエラーおよび警告が含まれる可能性があります。

5. 概要が適切であれば Next をクリックします。

   OpenAPI ドキュメントを訂正する場合は、Review/Edit をクリックして API Designer エディターを開きます。必要に応じてスキーマを更新します。API エディターの使用に関する詳細は、API Designer を使用した API 定義の設計および開発 を参照してください。終了したら、変更を 保存 し、更新を新しい API クライアントコネクターに反映します。Next をクリックして API クライアントコネクターの作成を続行します。

   OpenAPI ドキュメントの URL を提供する場合、Fuse Online はドキュメントをアップロードできても、開いて編集できないことがあります。通常、これはファイルのホストの設定が原因です。スキーマを開いて編集するには、ファイルのホストに以下が必要です。

   • https の URL。(http の URL は動作しません)
   • 有効な CORS。

6. API のセキュリティー要件を示します。Fuse Online は OpenAPI 定義を読み取り、API のセキュリティー要件を満たすためにコネクターの設定に必要な情報を判断します。Fuse Online は以下のいずれかを表示できます。

   1. No Security (セキュリティーなし)
   2. HTTP Basic Authorization (HTTP Basic 認証) - API サービスが HTTP Basic 認証を使用する場合は、このチェックボックスを選択します。後で、このコネクターを使用してコネクションを作成するときに、Fuse Online はユーザー名とパスワードの入力を要求します。

   3. OAuth 2.0 — Fuse Online は以下を入力するよう要求します。

      1. Authorization URL は、Fuse Online を API のクライアントとして登録する場所です。登録によって Fuse Online の API へのアクセスが承認されます。Fuse Online のアプリケーションおよびサービスへの接続の Fuse Online を REST API クライアントとして登録 を参照してください。OpenAPI ドキュメントまたは API の他のドキュメントはこの URL を指定する必要があります。指定しない場合、サービスプロバイダーに連絡してこの URL を取得する必要があります。
      2. OAuth 承認には、アクセストークン URL が必要です。この場合も、OpenAPI ドキュメントまたは API の他のドキュメントがこの URL を提供する必要があります。提供しない場合、サービスプロバイダーに連絡する必要があります。
   4. API Key - API サービスに API キーが必要な場合、Fuse Online はコネクターの作成に必要な情報を要求します。プロンプトは OpenAPI 定義に基づきます。たとえば、API キーがメッセージヘッダーまたはクエリーパラメーターにあるかを示す必要がある可能性があります。OpenAPI 定義が API キーのセキュリティーと他のセキュリティータイプを指定する場合、チェックボックスを選択し、このコネクターを基にしてコネクションに API キーセキュリティーを使用することを示します。後で、このコネクターを使用してコネクションを作成するときに、Fuse Online は API キーの値を入力するよう要求します。

7. Next をクリックします。Fuse Online は OpenAPI ドキュメントによって示されるコネクターの名前、説明、ホスト、およびベース URL を表示します。このコネクターから作成するコネクションの場合は以下を行います。

   • Fuse Online は、コネクションのエンドポイントを定義するため、ホストおよびベース URL 値を連結します。たとえば、ホストが https://example.com で、ベース URL が /api/v1 の場合、コネクションエンドポイントは https://example.com/api/v1 になります。
   • Fuse Online は OpenAPI ドキュメントをデータマッピングステップに適用します。OpenAPI ドキュメントが複数のスキーマをサポートする場合、Fuse Online は TLS (HTTPS) スキーマを使用します。
8. コネクターの詳細を確認し、必要に応じてコネクターのアイコンをアップロードします。アイコンをアップロードしない場合、Fuse Online はアイコンを生成します。後でアイコンをアップロードできます。Fuse Online でインテグレーションのフローが表示されるときに、コネクターから作成されたコネクションを表すコネクターのアイコンが表示されます。

9. OpenAPI ファイルから取得した値を上書きするには、変更するフィールド値を編集します。

   重要

   Fuse Online がコネクターを作成した後、これを変更することはできません。変更を反映にするには、Fuse Online が新しいコネクターを作成できるよう、更新された OpenAPI ドキュメントをアップロードしたり、同じスキーマをアップロードして API エディターで変更する必要があります。その後、新しい API クライアントコネクターを作成するプロセスを続行します。

10. コネクターの詳細が適切であれば、Save をクリックします。Fuse Online API Client Connectors のリストに新しいコネクターが表示されます。

手順

1. Fuse Online のナビゲーションパネルで、Customizations > API Client Connectors をクリックします。すでに利用可能な API クライアントコネクターが表示されます。
2. Create API Connector をクリックします。

3. Create API Connector ページで、以下のいずれかを行います。

   • 点線のボックスをクリックし、アップロードする WSDL (.wsdl) ファイルを選択します。

     (ファイルのアップロード フォームを使用して) コネクターに直接インポートする WSDL ファイルで参照されるディスクベースの外部スキーマはサポートされていないことに注意してください。アップロードされた WSDL ファイルは、インラインスキーマを使用する 必要があります。

   • Use a URL を選択し、入力フィールドに WSDL (.wsdl) ファイルの URL を貼り付けます。

     URL ベースの WSDL は、WSDL でホストされる外部スキーマをサポートすることに注意してください。また、URL ベースの WSDL のみが、WSDL のベースパスからの相対 URL に基づく外部スキーマをサポートします。WSDL URL は、実行時に解析と検証のために SOAP コネクターで使用できる 必要 があります。したがって、WSDL とスキーマが永続的な URL でホストされていることを確認してください。

4. Next をクリックします。
5. Specify service and port ページで、サービスおよびポートを確認します。
6. Next をクリックします。無効なコンテンツや不足しているコンテンツがある場合、必要な修正に関する情報が Fuse Online に表示されます。アップロードする別の WSDL ファイルを選択するか、Cancel をクリックします。WSDL ファイルを修正し、更新したファイルをアップロードします。スキーマが有効な場合、Fuse Online には API 定義 (名前および説明) の概要と、インポートされた要素のリスト (操作の数など) が表示されます。
7. Next をクリックします。

8. WSDL エンドポイントを呼び出すときに使用するセキュリティー要件を示します。Fuse Online は API 定義を読み取り、API のセキュリティー要件を満たすためにコネクターの設定に必要な情報を判断します。Fuse Online は以下のいずれかを表示できます。

   • なし (セキュリティーなし)
   • HTTP Basic Authorization (HTTP Basic 認証) - API サービスが HTTP Basic 認証を使用する場合は、このチェックボックスを選択します。後で、このコネクターを使用してコネクションを作成するときに、Fuse Online はユーザー名とパスワードの入力を要求します。

   • WS-Security Username Token — Fuse Online は以下の情報の入力を求めます。

     1. Timestamp - Fuse Online でタイムスタンプを WS-Security ヘッダーに追加する場合は、このオプションを選択します。

     2. Password Type - Digest、Text、または None を選択します。

        Text または Digest を選択した場合:

        • username と password を指定します。
        • Fuse Online で Nonce 要素を WS-Security Username Token ヘッダーに追加する場合は、Username Token Nonce を選択します。
        • Fuse Online で "Created" タイムスタンプ要素を WS-Security Username Token ヘッダーに追加する場合は、Username Token Created を選択します。

9. Next をクリックします。コネクターの名前、説明、および WSDL エンドポイントアドレスが Fuse Online に表示されます。

   1. 必要に応じて、コネクターのアイコンをアップロードします。後でアイコンをアップロードすることもできます。

      注記: 本リリースでは、アイコンをアップロードしないと、Fuse Online でアイコンが生成されません。

      Fuse Online でインテグレーションのフローが表示されるときに、コネクターから作成されたコネクションを表すコネクターのアイコンが表示されます。

   2. Name には、このコネクションを別のコネクションと区別するために使用する名前を入力します。
   3. 必要に応じて、Description にこのコネクションに関する便利な情報を入力します。

10. コネクターの詳細を確認し、WSDL ファイルから取得した値をオーバーライドします。フィールド値を変更します。

    重要

    Fuse Online がコネクターを作成した後、これを変更することはできません。変更を反映にするには、Fuse Online が新しいコネクターを作成できるよう、更新された OpenAPI ドキュメントをアップロードしたり、同じスキーマをアップロードして API エディターで変更する必要があります。その後、新しい API クライアントコネクターを作成するプロセスを続行します。

11. コネクターの詳細が適切であれば、Save をクリックします。Fuse Online API Client Connectors のリストに新しいコネクターが表示されます。

手順

1. 更新された OpenAPI ドキュメントまたは WSDL ファイルを基にして新しい API クライアントコネクターを作成します。古いコネクターと新しいコネクターを区別しやすくするため、コネクター名またはコネクターの説明にバージョン番号を指定することもできます。

   REST API クライアントコネクターの開発 を参照してください。

2. 新しいコネクターから新しいコネクションを作成します。ここでも、古いコネクターから作成されたコネクションと、新しいコネクターから作成されたコネクションを簡単に区別できるようにすることができます。コネクション名またはコネクションの説明のバージョン番号を使用すると便利です。
3. 古いコネクションを削除し、新しいコネクションを追加して、古いコネクターから作成されたコネクションを使用する各インテグレーションを編集します。
4. 更新された各インテグレーションをパブリッシュします。
5. 必須ではありませんが、古いコネクターおよびコネクションを削除することが推奨されます。

手順

1. 左側のパネルで Customizations > API Client Connectors をクリックします。
2. 削除するコネクター名の右側にある Delete をクリックします。
3. コネクターを削除する場合は、確認ポップアップの Delete をクリックします。