第5章 API クライアントへの接続

インテグレーションで REST または SOAP API に接続するには、その API のコネクターが作成済みである必要があります。『Fuse Online でのアプリケーションの統合』の「API クライアントコネクターの追加および管理」を参照してください。

接続する API のコネクターが Fuse Online で利用可能である場合、API に接続するステップは次のとおりです。

5.1. Fuse Online を REST API クライアントとして登録

Fuse Online が REST API クライアントコネクターを作成する前に、API のセキュリティー要件を示すよう要求されます。OAuth プロトコルを使用する API では、Fuse Online がコネクターを作成すると、API のエントリーも Fuse Online の Settings ページに追加します。ここに Fuse Online の API へのアクセスを承認する API クライアント ID と API クライアントシークレットを提供します。

接続する API が OAuth を使用しない場合、このセクションを飛ばして「REST API クライアントコネクションの作成」を参照してください。

前提条件

接続する REST API の OAuth カスタムアプリケーション設定ページの URL を知っている必要があります。

手順

  1. Fuse Online で以下を行います。

    1. Settings ページで、上部付近にあるコールバック URL の右側で Copy Callback URL をクリックし、Fuse Online 環境のコールバック URL をクリップボードにコピーします。この手順の後半でこの URL が必要になります。
    2. 接続する API の名前を探し、その名前をクリックしてクライアント ID およびクライアントシークレットフィールドを表示します。
  2. 別のブラウザーウインドウで、Fuse Online を接続する API の OAuth クライアントとして登録する必要があります。これを行う正確な手順は、API サービスごとに異なります。通常、API サービスは OAuth カスタムアプリケーション設定ページを提供します。そのページに移動し、以下を行います。

    1. この手順の最初にコピーした Fuse Online のコールバック URL を提供します。
    2. 入力が必要なその他のプロンプトに対応します。
    3. API サービスが Fuse Online 環境に割り当てるクライアント ID およびクライアントシークレットを取得します。
  3. 登録している API サービスの Fuse Online Settings ページエントリーに戻り、以下を行います。

    1. 割り当てられたクライアント ID を貼り付けます。
    2. 割り当てられたクライアントシークレットを貼り付けます。
    3. Save をクリックします。

5.2. REST API クライアントコネクションの作成

インテグレーションで REST API に接続するには、任意の数のインテグレーションを追加できる REST API へのコネクションを作成します。

前提条件

  • 接続する REST API のコネクターが作成されている必要があります。
  • REST API が OAuth プロトコルを使用する場合、その REST API にアクセスできるクライアントアプリケーションとして Fuse Online 環境が登録されています。

手順

  1. Fuse Online の左パネルで Connections をクリックし、利用可能なコネクションを表示します。
  2. Create Connection をクリックし、利用できるコネクターを表示します。
  3. コネクションを作成する API のコネクターをクリックします。
  4. 設定ページで、要求された情報を提供します。Fuse Online が要求する内容は API の定義によって決まります。

    通常、API サービスにはセキュリティー要件があり、Fuse Online は OpenAPI ドキュメントが定義する特定のセキュリティータイプに応じたセキュリティーの入力を要求します。セキュリティータイプは以下の 1 つになります。

    セキュリティータイプ

    Fuse Online の表示

    HTTP Basic 認証

    ユーザー名およびパスワードの入力フィールド。

    OAuth 2.0

    API 接続の登録クレデンシャルを Fuse Online が検証するためにクリックするボタン。これらのクレデンシャルはコネクターの作成時に提供されます。

    API キー

    API サービスから取得する必要がある API キーの入力フィールド。

  5. Validate をクリックします。Fuse Online はコネクションパラメーターを検証します。たとえば、有効なホスト/アドレスの URL を確認します。
  6. Next をクリックします。
  7. Name connection ページで以下を行います。

    1. Name フィールドに、このコネクションを別のコネクションと区別するために使用する名前を入力します。
    2. Description は任意のフィールドで、このコネクションに関する便利な情報を入力します。
    3. Save をクリックします。作成したコネクションを選択し、インテグレーションに追加できるようになります。

5.3. SOAP API クライアントコネクションの作成

インテグレーションで SOAP API に接続するには、任意の数のインテグレーションを追加できる SOAP API へのコネクションを作成します。

重要

SOAP API クライアントコネクションはテクノロジープレビュー機能です。テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあります。Red Hat は、実稼働環境での使用を推奨しません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能をテストし、フィードバックを提出できるようにすることを目的としています。Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、https://access.redhat.com/ja/support/offerings/techpreview を参照してください。

前提条件

  • 接続する SOAP API のコネクターが作成されている必要があります。

手順

  1. Fuse Online の左パネルで Connections をクリックし、利用可能なコネクションを表示します。
  2. Create Connection をクリックし、利用できるコネクターを表示します。
  3. コネクションを作成する API のコネクターをクリックします。
  4. 設定ページで、要求された情報を提供します。Fuse Online が要求する内容は API の定義によって決まります。
  5. コネクション設定ページで以下を行います。

    1. SOAP Endpoint アドレスを許可または編集します。
    2. WSDL エンドポイントを呼び出す際に使用する認証タイプ (None、Basic、または WS-Security Username Token) を選択します。通常、API サービスにはセキュリティー要件があり、Fuse Online は WSDL ファイルが定義する特定のセキュリティータイプに応じたセキュリティーの入力を要求します。
    3. WS-Security Password Type (NoneText、または Digest) を選択します。
    4. ユーザー名 および パスワード を指定します。
    5. Fuse Online でタイムスタンプを WS-Security ヘッダーに追加する場合は Timestamp を選択します。
    6. Fuse Online で Nonce 要素を WS-Security Username Token ヘッダーに追加する場合は、Username Token Nonce を選択します。

      Web Services Security (WSS) で UsernameToken を使用する方法に関する詳細は、この OASIS ドキュメント を参照してください。

    7. Fuse Online でタイムスタンプ要素を WS-Security Username Token ヘッダーに追加する場合は、Username Token Created を選択します。

      注記: SOAP エンドポイントへのコネクションを検証する OASIS/W3C 標準がないため、SOAP コネクターは検証をサポートしません。

  6. Next をクリックします。
  7. Name connection ページで以下を行います。

    1. Name フィールドに、このコネクションを別のコネクションと区別するために使用する名前を入力します。
    2. Description は任意のフィールドで、このコネクションに関する便利な情報を入力します。
    3. Save をクリックします。作成したコネクションを選択し、インテグレーションに追加できるようになります。

5.4. API クライアントのインテグレーションへの追加

インテグレーションで REST または SOAP API に接続するには、その API に接続するステップを追加します。

本リリースでは、REST または SOAP API へのコネクションをフローの途中のステップするか、シンプルなインテグレーションの最後のコネクションとすることができます。よって、REST または SOAP API へのコネクションを最初のコネクションとすることはできません。

前提条件

  • REST または SOAP API へのコネクションが作成されている必要があります。
  • フローを作成または編集することになります。
  • フローに最初のコネクションがある必要があります。
  • Fuse Online は最後のコネクションの選択またはインテグレーションの追加を要求します。

手順

  1. Add to Integration ページで、コネクションの追加先のプラス記号をクリックします。Fuse Online が最後のコネクションを選択するよう要求する場合は、このステップをスキップします。
  2. 使用できるステップを表示するページで、フローに追加する API コネクションをクリックします。
  3. コネクションが実行するアクションを選択します。使用できるアクションは、Fuse Online にアップロードされ、接続先の API を説明する OpenAPI ドキュメントまたは WSDL ファイルに指定されたリソース操作を基にします。
  4. 選択したアクションに応じて、Fuse Online が要求するパラメーターを入力します。
  5. Next をクリックします。

結果

インテグレーションビジュアライゼーションで追加した場所にコネクションが表示されます。