カタログAPIの基礎知識

アプリケーションメニューやREST APIからカタログを管理することができます。 headless-commerce-admin-catalog サービスを呼び出して、カタログを作成・管理します。

カタログを追加する

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q2.11。

メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。プロンプトが表示されたら、パスワードを learn に変更します。

Liferayが起動したら。

Catalog API Basics](./liferay-q2v8.zip)をダウンロードし、解凍する。

curl https://resources.learn.liferay.com/commerce/latest/en/product-management/developer-guide/liferay-q2v8.zip -O

unzip liferay-q2v8.zip

カタログはインスタンスにスコープされます。 cURLスクリプトを使用して、新しいカタログを追加します。コマンドラインで、 curl フォルダに移動します。 Catalog_POST_ToInstance.sh スクリプトを実行する。

./Catalog_POST_ToInstance.sh

JSONレスポンスには、新しいカタログが追加されたことが示されています。

{
   "actions" : {
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      }
   },
   "currencyCode" : "USD",
   "defaultLanguageId" : "en_US",
   "externalReferenceCode" : "246ad89e-8da1-546c-0d62-06ac7061e1da",
   "id" : 46110,
   "name" : "Able",
   "system" : false
}

カタログの追加を確認するには、 Global Menu() を開き、 Commerce → Catalogs に移動してください。新しいカタログが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 javaフォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
Catalog_POST_ToInstance クラスを実行します。
```
java -classpath .:* Catalog_POST_ToInstance
```

cURLコマンドの検証

Catalog_POST_ToInstance.sh スクリプトは、cURL コマンドで REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalogs" \
	--data-raw '
		{
			"currencyCode": "USD",
			"defaultLanguageId": "en_US",
			"name": "Able"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

コマンドの引数は次のとおりです。

引数	説明
`-H "Content-Type: application/json"`	リクエストボディの形式をJSONに設定します。
`-X POST`	指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
`"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalogs"`	RESTサービスのエンドポイントを指定します。
`-d "{\"currencyCode\": \"USD\", \"defaultLanguageId\": \"en_US\", \"name\": \"Able\"}"`	投稿するデータを入力します。
`-u "test@liferay.com:learn"`	基本認証の認証情報を入力します。

note

ここでは、デモのために基本的な認証を使用しています。本番環境では、 OAuth 2.0を使用する経由でユーザーを認証する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証をご覧ください。

他のcURLコマンドも同様のJSON引数を使用します。

Javaクラスを調べる

Catalog_POST_ToInstance.java クラスは、 CatalogResource サービスを呼び出してカタログを追加します。

public static void main(String[] args) throws Exception {
	CatalogResource.Builder builder = CatalogResource.builder();

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		catalogResource.postCatalog(
			new Catalog() {
				{
					currencyCode = "USD";
					defaultLanguageId = "en_US";
					name = "Able";
				}
			}));
}

このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。

行（省略形）	説明
`CatalogResource.Builder builder = ...`	`CatalogResource` サービスインスタンスを生成するための `Builder` を取得する。
`CatalogResource catalogResource = builder.authentication(...).build();`	基本認証を使用し、 `CatalogResource` サービスインスタンスを生成します。
`catalogResource.postCatalog(...);`	`catalogResource.postCatalog` メソッドを呼び出し、postにデータを渡します。

このプロジェクトには、依存関係として com.liferay.headless.commerce.admin.catalog.client.jar ファイルが含まれています。すべてのRESTアプリケーションのクライアントJARの依存情報は、/o/api (例: http://localhost:8080/o/api) にあるインストール先のAPIエクスプローラーで見つけることができます。

note

mainメソッドのコメントでは、クラスの実行を実演しています。

残りのサンプルJavaクラスは、異なる CatalogResource のメソッドを呼び出します。

important

サービスの詳細は CatalogResource を参照してください。

以下は、cURLとJavaを使用して、他の Catalog RESTサービスを呼び出す例です。

インスタンスからカタログを取得する

cURLまたはJavaコマンドで、Liferayインスタンスのすべてのカタログをリストアップします。

Catalogs_GET_FromInstance.sh

コマンド：

./Catalogs_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalogs" \
	--user "test@liferay.com:learn"

Catalogs_GET_FromInstance.java

コマンド：

java -classpath .:* Catalogs_GET_FromInstance

コード：

public static void main(String[] args) throws Exception {
	CatalogResource.Builder builder = CatalogResource.builder();

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Catalog> page = catalogResource.getCatalogsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの カタログ オブジェクトはJSONでフォーマットされています。

カタログのフィルタリング、ページ分割、検索、ソート

このAPIでは、カタログのフィルタリング、ページ分割、検索、ソートなどのパラメータも受け付けます。詳しくは、 getCatalogsPage メソッドをご覧ください。 名前 フィールドを使用して、結果をフィルタリング、検索、ソートすることができます。

フィルタークエリ	説明
`name eq 'Able'`	カタログ名はAbleと同じでなければならない。

ソートクエリ	説明
`name:desc`	名前の降順で並べます。

詳しくは、 APIクエリパラメータをご参照ください。

カタログを見る

cURL または Java get コマンドで特定のカタログを取得します。 1234 をカタログのIDに置き換えてください。

tip

Catalogs_GET_FromInstance.[java|sh]を使用して、すべてのカタログのリストを取得し、特に欲しいカタログのid` をメモします。

Catalog_GET_ById.sh

コマンド：

./Catalog_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/${1}" \
	--user "test@liferay.com:learn"

Catalog_GET_ById.java

コマンド：

java -classpath .:* -DcatalogId=1234 Catalog_GET_ById

コード：

public static void main(String[] args) throws Exception {
	CatalogResource.Builder builder = CatalogResource.builder();

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		catalogResource.getCatalog(
			Long.valueOf(System.getProperty("catalogId"))));
}

カタログ のフィールドをJSONで表示します。

カタログを貼る

cURLとJava patch コマンドで既存のカタログを更新します。 1234 をカタログのIDに置き換えてください。

Catalog_PATCH_ById.sh

コマンド：

./Catalog_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/${1}" \
	--data-raw '
		{
			"name": "Bar"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

Catalog_PATCH_ById.java

コマンド：

java -classpath .:* -DcatalogId=1234 Catalog_PATCH_ById

コード：

public static void main(String[] args) throws Exception {
	CatalogResource.Builder builder = CatalogResource.builder();

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	catalogResource.patchCatalog(
		Long.valueOf(System.getProperty("catalogId")),
		new Catalog() {
			{
				name = "Bar";
			}
		});
}

カタログを削除する

cURL と Java delete コマンドで既存のカタログを削除します。 1234 をカタログのIDに置き換えてください。

Catalog_DELETE_ById.sh

コマンド：

./Catalog_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

Catalog_DELETE_ById.java

コマンド：

java -classpath .:* -DcatalogId=1234 Catalog_DELETE_ById

コード：

public static void main(String[] args) throws Exception {
	CatalogResource.Builder builder = CatalogResource.builder();

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	catalogResource.deleteCatalog(
		Long.valueOf(System.getProperty("catalogId")));
}

RESTサービスの使用では、 Catalog のサービスやスキーマが表示され、各サービスをテストするためのインターフェイスが用意されています。

Capability: