ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

MuleSoftコネクターの設定

Liferayの MuleSoft コネクタは、Liferayの API を記述する OpenAPI 3.0 ドキュメントを使用します。各OpenAPIドキュメントは、以下のスキーマでLiferayインスタンスに動的にデプロイされます。

http://[host]:[port]/o/[headless-api-app-name]/[version]/openapi.json

これらのドキュメントは、デプロイされたRESTful Webサービスに基づいているため、APIを最も正確に記述することができます。 Liferay API の詳細については、こちらをご覧ください。

OpenAPIドキュメントのエンドポイントを指定すると、コネクターがOpenAPIドキュメントで定義されたパス、パス/クエリパラメーター、およびエンティティメタデータを自動的に設定します。このコネクターは、Liferayの標準に従ったOpenAPI 3.0のドキュメントで動作し、すべてのLiferay APIをサポートします。

Muleプロジェクトにコネクターを追加する

コネクターを設定する前に、Muleプロジェクトにコネクターを追加する必要があります。

Mule Paletteの［Search in Exchange］をクリックします。
Liferayを検索します。
コネクターを選択し、 ［Add］をクリックします。
[完了]をクリックします。

これで、Muleプロジェクトにコネクターが表示されるようになりました。

OAuth2の設定で、クライアントのプロフィールをヘッドレスサーバーとして設定します。

コネクターの設定

認証方式を選択し、必要なパラメータを入力します。
OpenAPIドキュメントエンドポイントを指定します。

認証

基本と OAuth2 認証方法から選択します。

基本認証: ユーザー名とパスワードを入力します。

OAuth2: クライアントキーとクライアントシークレットを入力します。

本番環境では、 OAuth2経由でユーザーを認証する必要があります。基本認証は、基本的なテストとデモンストレーションのためにのみ提供されます。

LiferayでOAuth2を設定する際、クライアントのプロフィールでヘッドレスサーバーを選択します。 Liferayは、コネクターで使用するためのクライアントID（コンシューマーキー）とクライアントシークレット（コンシューマーシークレット）を生成します。

OAuth2の設定で、クライアントのプロフィールをヘッドレスサーバーとして設定します。

OAuth2 認証でエンドポイントを使用するには、必要な認証オプション (例: everything、 everything.write、または everything.read) を使用してスコープも定義する必要があります。

詳細な設定手順については、 OAuth2 アプリケーションの作成を参照してください。また、OAuth2 を使用したサンプル React アプリケーションについては、 OAuth2 を使用したユーザーの承認を参照してください。

OpenAPIドキュメントエンドポイントの指定

認証されたら、OpenAPIドキュメントのエンドポイントを設定し、使用するLiferay APIを指定します。例えば、本書はCommerce Admin Catalog APIを対象としています。

http://[host]:[port]/o/headless-commerce-admin-catalog/v1.0/openapi.json

この値を設定するには、Liferay_Configグローバル要素を編集し、OpenAPI Spec URLフィールドにドキュメントエンドポイントを入力します。

Open API Spec URL 欄にOpenAPIドキュメントエンドポイントを入力します。

また、XML構成を使用して行うこともできます。 Liferay_Configグローバル要素を右クリックし、［Go to XML］を選択します。次に、認証方法に応じた適切なフォーマットで認証情報を入力します。

基本認証の例：

<liferay:config name="Liferay_Config_Catalog">
<liferay:basic-connection username=${username} password=${password} openApiSpecPath="http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/openapi.json" />
</liferay:config>

OAuth 2.0の例：

<liferay:config name="Liferay_Config_Catalog">
<liferay:oauth2-connection consumerKey="${consumerKey}" consumerSecret=${consumerSecret} openApiSpecPath="http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/openapi.json" />
</liferay:config>

テスト接続をクリックします。成功すると、コネクターを使用したフローの構築を開始できます。そうでない場合は、設定を見直してください。

Capability: