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

仕様APIの基本

アプリケーションメニューやREST APIで商品仕様を管理することができます。 headless-commerce-admin-catalogサービスを呼び出し、仕様を作成・管理します。

仕様の追加

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2026.q1.9-lts

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

Liferayが起動したら、

仕様 API の基本をダウンロードして解凍します。

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

unzip liferay-u9x9.zip

仕様はインスタンスにスコープされ、各仕様は一意の キー と タイトル を指定する必要があります。

cURLスクリプトを使用して、新しい仕様を追加します。コマンドラインで、 curl フォルダーに移動します。 Specifications_POST_ToInstance.sh スクリプトを実行します。
```
./Specifications_POST_ToInstance.sh
```
JSONレスポンスには、新しい仕様が追加されたことが示されています。
```
{
   "説明" : { },
   "ファセットテーブル" : false,
   "ID" : 45936,
   "キー" : "foo"、
   "title" : {
      "en_US" : "Foo"
   }
}
```
仕様の追加を確認するには、 グローバルメニュー () を開き、 コマース → 仕様に移動します。新しい仕様は、「仕様ラベル」タブに表示されます。

注記

現在、APIでは仕様グループに仕様ラベルを追加したり、仕様グループを作成したりすることはできません。代わりに仕様UIを使用する必要があります。 グローバルメニュー () を開き、 コマース → 仕様に移動します。詳細については、仕様グループを参照してください。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
Specifications_POST_ToInstance クラスを実行します。
```
java -classpath .:* Specifications_POST_ToInstance
```

cURLコマンドを調べてみましょう

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/specifications" \
	--data-raw '
		{
			"key": "foo",
			"title": {
				"en_US": "Foo"
			}
		}' \
	--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/specifications"`	RESTサービスのエンドポイントを指定します。
`-d "{\"key\": \"foo\", \"title\": {\"en_US\": \"Foo\"}}"`	投稿するデータを入力します。
`-u "test@liferay.com:learn"`	基本認証の認証情報を入力します。

注記

ここでは、デモンストレーション目的で基本認証を使用しています。本番環境では、 OAuth2 を介してユーザーを認証する必要があります。 OAuth2 を使用した React アプリケーションの例については、 OAuth2 を使用してユーザーを認証するを参照してください。

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

Javaクラスを調べます

Specifications_POST_ToInstance.java クラスは、 SpecificationResource サービスを呼び出すことで仕様を追加します。

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

	SpecificationResource specificationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		specificationResource.postSpecification(
			new Specification() {
				{
					key = "foo";
					title = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
				}
			}));
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

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

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

注記

main メソッドのコメントは、クラスを実行する方法を示しています。

残りのJavaクラスの例は、異なる SpecificationResource メソッドを呼び出します。

重要

サービスの詳細については、 SpecificationResource を参照してください。

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

インスタンスから仕様を取得する

cURLまたはJavaコマンドを使用して、Liferayインスタンス内のすべての仕様を一覧表示します。

Specifications_GET_FromInstance.sh

コマンド：

./Specifications_GET_FromInstance.sh

コード：

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

Specifications_GET_FromInstance.java

コマンド：

java -classpath .:* Specifications_GET_FromInstance

コード：

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

	SpecificationResource specificationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		specificationResource.getSpecificationsPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスの 仕様 オブジェクトは JSON 形式でフォーマットされています。

フィルタリング、ページネーション、検索、およびソートの仕様

このAPIは、仕様のフィルタリング、ページネーション、検索、およびソートを行うためのパラメータも受け付けます。詳細については、 getSpecificationsPage メソッドを参照してください。クエリで以下の 仕様 フィールドを使用すると、結果をフィルタリング、検索、およびソートできます。

鍵
タイトル

フィルタークエリ	説明
`key eq 'foo'`	仕様キーはfooでなければなりません。
`タイトルが「バー」と等しい`	仕様タイトルはBarである必要があります。

ソートクエリ	説明
`キー:説明`	キーで降順に並べ替えます。
`タイトル:asc`	タイトルで昇順に並べ替えます。

詳細については、 APIクエリパラメータをお読みください。

仕様書を入手する

cURL または Java get コマンドを使用して、特定の仕様を取得します。 1234 を仕様の ID に置き換えてください。

ヒント

Specifications_GET_FromInstance.[java|sh] を使用してすべての仕様のリストを取得し、特に必要な仕様の id をメモしてください。

Specifications_GET_ById.sh

コマンド：

./Specifications_GET_ById.sh 1234

コード：

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

Specifications_GET_ById.java

コマンド：

java -classpath .:* -DspecificationId=1234 Specifications_GET_ById

コード：

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

	SpecificationResource specificationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		specificationResource.getSpecification(
			Long.valueOf(System.getProperty("specificationId"))));
}

仕様 フィールドはJSONでリストされています。

仕様を修正する

cURL と Java patch コマンドを使用して、既存の仕様を更新します。 1234 を仕様の ID に置き換えてください。

Specifications_PATCH_ById.sh

コマンド：

./Specifications_PATCH_ById.sh 1234

コード：

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

Specifications_PATCH_ById.java

コマンド：

java -classpath .:* -DspecificationId=1234 Specifications_PATCH_ById

コード：

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

	SpecificationResource specificationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	specificationResource.patchSpecification(
		Long.valueOf(System.getProperty("specificationId")),
		new Specification() {
			{
				key = "bar";
				title = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

仕様を削除する

cURLとJavaの delete コマンドを使用して、既存の仕様を削除します。 1234 を仕様の ID に置き換えてください。

Specifications_DELETE_ById.sh

コマンド：

./Specifications_DELETE_ById.sh 1234

コード：

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

Specifications_DELETE_ById.java

コマンド

java -classpath .:* -DspecificationId=1234 Specifications_DELETE_ById

コード：

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

	SpecificationResource specificationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	specificationResource.deleteSpecification(
		Long.valueOf(System.getProperty("specificationId")));
}

APIエクスプローラーは、 仕様 サービスとスキーマを表示し、各サービスをテストするためのインターフェースを備えています。

注記

Liferay DXP 2024.Q4+/Portal GA129+ では、外部参照コードを使用して GET/PUT/PATCH/DELETE 仕様を指定できます。