oo
Analytics Cloud
Commerce
DXP / Portal
Liferay Cloud
Reference
開発者ガイド

Term API の基礎知識

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

用語の追加

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

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

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

Liferayが起動したら。

  1. Term API Basics](./liferay-a9v8.zip)をダウンロードし、解凍してください。

    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"}を入力します。
    名前 テキストボックス 規約項目のユニークな名称を入力する。
    "name "を入力します。"foo"
    重要度 数字（ダブル） ユニークな数値の優先順位を入力します。
    "priority "を入力します。1.2
    種類 テキストボックス "payment-terms" または "delivery-terms":
    "type "を指定する。"payment-terms"

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

    ./Term_POST_ToInstance.sh

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

    {
   "actions" : {
      "permissions" : {
         "method" : "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" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
      },
      "delete" : {
         "method" : "DELETE",
         "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,
   "type" : "payment-terms",
   "typeLocalized" : "Payment Terms",
   "typeSettings" : "",
   "workflowStatusInfo" : {
      "code" : 0,
      "label" : "approved",
      "label_i18n" : "Approved"
   }
}

  3. Global Menu(Applications Menu icon) → Commerce → Terms and Conditions に移動します。 新しく追加された規約が表示されます。

    規約の追加を確認する。

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

    javac -classpath .:* *.java

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

    java -classpath .:* Term_POST_ToInstance

cURLコマンドの検証

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

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

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

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

Javaクラスを調べる

Term_POST_ToInstance.java クラスは、 TermResource サービスを呼び出して条件を追加します。

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "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 = ... TermResource サービスインスタンスを生成するための Builder を取得します。
TermResource termResource = builder.authentication(...).build(); 基本認証を使用し、 TermResource サービスインスタンスを生成します。
termResource.postTerm(...); termResource.postTerm メソッドを呼び出し、postにデータを渡します。

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

note

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

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

important

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

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

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

LiferayのインスタンスからcURLやJavaのコマンドで全ての規約を一覧できます。

Terms_GET_FromInstance.sh

コマンド：

./Terms_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms" \
	--user "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

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

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

返された条件をフィルタリング、ページ分割、検索、ソートすることができます。 詳しくは、 getTermsPage メソッドをご覧ください。 優先順位 および タイプ フィールドを使用して、結果のフィルタリング、検索、およびソートを行います。

フィルタークエリ 説明
type eq 'payment-terms' 条件は、payment-terms型であること。
priority eq 0 規約の優先順位が0になること
ソートクエリ 説明
priority:desc 優先順位 で降順に並びます。
priority:desc,type:desc まず 優先順位 の降順で並べ、次に タイプ の降順で並べます。

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

タームを取得する

cURLとJavaの get コマンドで特定の条件を取得します。 1234 を規約のIDに置き換えてください。

tip

Terms_GET_FromInstance.[java|sh]を使用して、すべての条件のリストを取得し、特に欲しい条件の id をメモする。

Term_GET_ById.sh

コマンド：

./Term_GET_ById.sh 1234

コード：

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

Term_GET_ById.java

コマンド:

java -classpath .:* -DtermId=1234 Term_GET_ById

コード:

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

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

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

タームを貼る

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

Term_PATCH_ById.sh

コマンド：

./Term_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 "test@liferay.com:learn"

Term_PATCH_ById.java

コマンド:

java -classpath .:* -DtermId=1234 Term_PATCH_ById

コード:

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

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

タームを削除する

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

Term_DELETE_ById.sh

コマンド：

./Term_DELETE_ById.sh 1234

コード：

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

Term_DELETE_ById.java

コマンド

java -classpath .:* -DtermId=1234 Term_DELETE_ById

コード:

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

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

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

Capability:
Commerce
Deployment Approach:
Liferay PaaS
Liferay SaaS
Liferay Self-Hosted
Feature:
API Development
Orders and Fulfillment