Red Hat Training
A Red Hat training course is available for Red Hat Fuse
第15章 REST API への接続
インテグレーションで REST API に接続するには、API を説明する OpenAPI ドキュメントをアップロードして、API のコネクターを作成しておく必要があります。『Integrating Applications with Fuse Online』の「Adding and managing REST API client connectors」を参照してください。
接続する REST API のコネクターが Fuse Online で利用可能である場合、REST API に接続するステップは次のとおりです。
15.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 を知っている必要があります。
手順
Fuse Online で以下を行います。
-
Settings ページで、上部付近にあるコールバック URL の右側で
をクリックし、Fuse Online 環境のコールバック URL をクリップボードにコピーします。この手順の後半でこの URL が必要になります。
- 接続する API の名前を見つけ、その Register ボタンをクリックしてクライアント ID およびクライアントシークレットフィールドを表示します。
-
Settings ページで、上部付近にあるコールバック URL の右側で
別のブラウザーウインドウで、Fuse Online を接続する API の OAuth クライアントとして登録する必要があります。これを行う正確な手順は、API サービスごとに異なります。通常、API サービスは OAuth カスタムアプリケーション設定ページを提供します。そのページに移動し、以下を行います。
- この手順の最初にコピーした Fuse Online のコールバック URL を提供します。
- 入力が必要なその他のプロンプトに対応します。
- API サービスが Fuse Online 環境に割り当てるクライアント ID およびクライアントシークレットを取得します。
登録している API サービスの Fuse Online Settings ページエントリーに戻り、以下を行います。
- 割り当てられたクライアント ID を貼り付けます。
- 割り当てられたクライアントシークレットを貼り付けます。
- Save をクリックします。
15.2. REST API クライアントコネクションの作成
インテグレーションで REST API に接続するには、任意の数のインテグレーションを追加できる REST API へのコネクションを作成します。
前提条件
- 接続する REST API のコネクターが作成されている必要があります。
- REST API が OAuth プロトコルを使用する場合、その REST API にアクセスできるクライアントアプリケーションとして Fuse Online 環境が登録されています。
手順
- Fuse Online の左パネルで Connections をクリックし、利用可能なコネクションを表示します。
- 右上にある Create Connection をクリックし、利用できるコネクターを表示します。
- コネクションを作成する API のコネクターをクリックします。
- プロンプトに応答し、追加情報を提供します。API の定義は、Fuse Online が要求する内容を決定します。たとえば、HTTP Basic 認証を使用する API の場合、Fuse Online は API にアクセスするために使用するユーザー名およびパスワードを要求します。OAuth を使用する API の場合、Fuse Online が API に接続するための登録クレデンシャルを検証できるようにするため、ユーザーがクリックするボタンを表示します。
- Connection Name フィールドに、このコネクションを別のコネクションと区別するために使用する名前を入力します。
- Description は任意のフィールドで、このコネクションに関する便利な情報を入力します。
- 右上の Create をクリックし、作成したコネクションを選択でき、インテグレーションに追加できることを確認します。
15.3. API クライアントのインテグレーションへの追加
インテグレーションで REST API に接続するには、その REST API へのコネクションをフローに追加します。
本リリースでは、REST API へのコネクションはフローの途中とするか、シンプルなインテグレーションの最後のコネクションとすることができます。よって、REST API へのコネクションを最初のコネクションとすることはできません。
前提条件
- REST API へのコネクションが作成されている必要があります。
- フローを作成または編集することになります。
- フローに最初のコネクションがある必要があります。
- Fuse Online は最後のコネクションの選択またはステップの選択を要求します。
手順
- 使用できるステップを表示するページで、フローに追加する REST API コネクションをクリックします。
- コネクションが実行するアクションをクリックします。使用できるアクションは、Fuse Online にアップロードされ、接続先の API を説明する OpenAPI ドキュメントに指定されたリソース操作を基にします。
- 選択したアクションに応じて、Fuse Online が要求するパラメーターを入力します。
- Done をクリックします。
結果
フローで追加した場所にコネクションが表示されます。