用語APIの基本

アプリケーションメニューやREST APIで利用規約を管理できます。 headless-admin-commerce-orderから/termsのエンドポイントを使用して、利用規約を作成・管理します。

用語の追加

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

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

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

Liferayが起動したら、

1. Term API の基本 をダウンロードして解凍します。

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

   unzip liferay-a9v8.zip
   

2. 利用規約を作成するには、ラベル、名前、優先度、タイプの4つのパラメータが必要です。

   パラメータ	値タイプ	説明/ 例
   ラベル	文章	カンマ区切りのロケール/値プロパティのリストを入力してください: {"en_US": "Foo", "es_ES": "Bar"}
   名前	文章	利用規約項目に固有の名前を入力してください: "名前": "foo"
   優先度	数値（倍精度浮動小数点数）	一意の数値優先度を入力してください: "優先度": 1.2
   タイプ	文章	"支払条件" または "配送条件": "タイプ": "支払条件を指定します。"

   cURLスクリプトを使用して、インスタンスに利用規約を追加します。 コマンドラインで、 curl フォルダーに移動します。 Terms_POST_ToInstance.sh スクリプトを実行します。

   ./Terms_POST_ToInstance.sh
   

   JSONレスポンスには、新たに追加された利用規約が表示されます。

   {
      "アクション" : {
         "パーミッション" : {
            "メソッド" : "PATCH"、
            "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
         },
         "get" : {
            "method" : "GET"、
            "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
         }、
         "update" : {
            "メソッド" : "PATCH"、
            "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
         }、
         "削除" : {
            "メソッド" : "削除"、
            "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
         }
      },
      "active" : false,
      "description" : {
         "en_US" : ""
      },
      "displayDate" : "2023-03-03T13:16:00Z",
      "externalReferenceCode" : "7fa19a0c-4c98-6c36-f1bc-5a2c4257220c"、
      "id" : 46418、
      "label" : {
         "en_US" : "Foo"
      },
      "name" : "foo",
      "priority" : 0.0、
      "タイプ" : "支払い条件"、
      "タイプローカライズド" : "支払い条件"、
      "typeSettings" : ""、
      "workflowStatusInfo" : {
         "code" : 0,
         "ラベル" : "承認済み"、
         "label_i18n" : "承認済み"
      }
   }
   

3. グローバルメニュー () → コマース → 利用規約 に移動します。 新たに追加された利用規約が表示されます。

   

4. または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。

   javac -classpath .:* *.java
   

5. Terms_POST_ToInstance クラスを実行します。

   java -classpath .:* Terms_POST_ToInstance
   

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

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms" \
	--data-raw '
		{
			"label": {
				"en_US": "Foo"
			},
			"名前": "foo",
			"優先度": 0,
			"type": "payment-terms"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "[e-mail]:learn"

ここでは、コマンドの引数を紹介します。

引数	説明
-H "Content-Type: application/json"	リクエストボディの形式をJSONに設定します。
-X POST	指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms"	RESTサービスのエンドポイントを指定します。
-d "{\"label\": {\"en_US\": \"Foo\"}, \"name\": \"foo\", \"優先度": 0、 \"タイプ": \"支払い条件"}"	投稿するデータを入力します。
-u "[e-mail]:learn"	基本認証の認証情報を入力します。

注記

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

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

Javaクラスを調べます

Terms_POST_ToInstance.java クラスは、 TermResource サービスを呼び出すことで、利用規約を追加します。

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

	TermResource termResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		termResource.postTerm(
			new Term() {
				{
					label = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
					name = "foo";
					priority = 0D;
					type = "payment-terms";
				}
			}));
}

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

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

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

注記

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

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

重要

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

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

インスタンスから条件を取得する

cURLまたはJavaコマンドで、Liferayインスタンスの全利用規約を一覧表示することができます。

Terms_GET_FromInstance.sh

コマンド：

./Terms_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms" \
	--user "[e-mail]:learn"

Terms_GET_FromInstance.java

コマンド：

java -classpath .:* Terms_GET_FromInstance

コード：

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

	TermResource termResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		termResource.getTermsPage(null, null, Pagination.of(1, 2), null));
}

インスタンスのTermオブジェクトがJSONに一覧表示されます。

用語のフィルタリング、ページネーション、検索、および並べ替え

返された利用規約の絞り込み、ページ分割、検索、並び替えを行うことができます。 詳細については、 getTermsPage メソッドを参照してください。 priorityおよびtypeフィールドを使用して、結果の絞り込み、検索、並べ替えを行います。

フィルタークエリ	説明
type eq 'payment-terms'	利用規約は支払い条件に関するものでなければならない。
優先度が0の場合	利用規約の優先順位は0でなければならない

ソートクエリ	説明
優先度:説明	優先度 の降順で並べ替えます。
優先度:desc、タイプ:desc	まず優先度 で降順に並べ替え、次にタイプ で降順に並べ替えます。

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

期間を取得する

cURLとJavaのgetコマンドで特定の利用規約を取得します。 1234を利用規約のIDに置き換えます。

ヒント

すべての利用規約のリストを取得するには、 Terms_GET_FromInstance.[java|sh] を使用し、特に必要な利用規約の id をメモしてください。

Terms_GET_ById.sh

コマンド：

./Terms_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/${1}" \
	--user "[e-mail]:learn"

Terms_GET_ById.java

コマンド：

java -classpath .:* -DtermId=1234 Terms_GET_ById

コード：

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

	TermResource termResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		termResource.getTerm(Long.valueOf(System.getProperty("termId"))));
}

TermフィールドはJSONでフォーマットされています。

用語を修正する

cURLとJava patchコマンドで既存の利用規約を更新します。 1234を利用規約のIDに置き換えます。

Terms_PATCH_ById.sh

コマンド：

./Terms_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/${1}" \
	--data-raw '
		{
			"label": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "[e-mail]:learn"

Terms_PATCH_ById.java

コマンド：

java -classpath .:* -DtermId=1234 Terms_PATCH_ById

コード：

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

	TermResource termResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	termResource.patchTerm(
		Long.valueOf(System.getProperty("termId")),
		new Term() {
			{
				label = new HashMap<String, String>() {
					{
						put("en_US"、 "バー");
					}
				};
			}
		});
}

用語を削除する

cURLとJavaの delete コマンドで既存の規約を削除します。 1234を利用規約のIDに置き換えます。

Terms_DELETE_ById.sh

コマンド：

./Terms_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/${1}" \
	--request "DELETE" \
	--user "[e-mail]:learn"

Terms_DELETE_ById.java

コマンド

java -classpath .:* -DtermId=1234 Terms_DELETE_ById

コード：

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

	TermResource termResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	termResource.deleteTerm(Long.valueOf(System.getProperty("termId")));
}

API Explorer は Term サービスとスキーマを表示し、各サービスをテストするためのインターフェースを備えています。

関連トピック

• 注文APIの基本
• 注文タイプAPIの基本