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

仕様APIの基本

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

仕様の追加

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

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

メールアドレス test@liferay.com とパスワード testを使用して、 http://localhost:8080 で 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

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

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

注

現在、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 エクスプローラーの /o/api (例: http://localhost:8080/o/api) で確認できます。


注


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


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


重要


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


以下は、cURLとJavaを使用して、他の Specification 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));
}

インスタンスの Specification オブジェクトはJSONでフォーマットされています。
仕様の絞り込み、ページネーション、検索、並び替え
このAPIでは、仕様の絞り込み、ページ分割、検索、並べ替えを行うためのパラメーターも許可します。 詳細については、 getSpecificationsPage メソッドを参照してください。 クエリでは、以下の Specification フィールドを使用して、結果のフィルタリング、検索、ソートを行うことができます：

key
title



フィルタークエリ 説明


key eq 'foo' 仕様キーはfooでなければなりません。
title eq 'Bar' 仕様タイトルはBarである必要があります。




ソートクエリ 説明


key:desc キーで降順に並べ替えます。
title:asc タイトルで昇順に並べ替えます。


詳細については、 API クエリ パラメータ を参照してください。
仕様書の取得
cURL または Java get コマンドで特定の仕様を取得します。 1234を仕様のIDに置き換えます。


ヒント


すべての仕様のリストを取得するには、 Specifications_GET_FromInstance.[java|sh] を使用し、具体的に必要な仕様の ID を書き留めておきます。


仕様_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"

仕様_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"))));
}

SpecificationフィールドはJSONで記載されています。
仕様にパッチを適用する
cURLとJava patch コマンドで既存の仕様を更新します。 1234を仕様のIDに置き換えます。
仕様_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"

仕様_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に置き換えます。
仕様_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"

仕様_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 仕様を使用することができます。


関連トピック

製品APIの基本


					
							
								
									Capability:
								
									
										
											Commerce
										
									
							
							
								
									Resource Type:
								
									
										
											Official Documentation
										
									
							
							
								
									Feature:
								
									
										
											Product Information
										
									
									
										
											Products
										
									
							
							
								
									Deployment Approach:
								
									
										
											Liferay PaaS
										
									
									
										
											Liferay SaaS
										
									
									
										
											Liferay Self-Hosted

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

引数	説明
`-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"`	基本認証の認証情報を入力します。

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

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