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

通貨APIの基本

Liferay DXP 2024.Q1+/Portal GA112+

通貨の管理は、アプリケーションメニューまたはREST APIを使用して行うことができます。通貨を作成および管理するには、ヘッドレスコマース管理カタログサービスを呼び出します。

重要

通貨APIは、Liferay DXP 2024.Q1/Portal GA112のリリース機能フラグの背後でリリースされました。 2024年第2四半期/ポータルGA120で一般提供(GA)されました。

通貨を追加する

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

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

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

Liferayが起動したら、

  1. Currency API Basicsをダウンロードして解凍してください。

    curl https://resources.learn.liferay.com/examples/liferay-e6w7.zip -O
    
    unzip liferay-e6w7.zip
    
  2. 通貨はインスタンスにスコープされ、各通貨は一意のcodeを指定する必要があります。通貨を作成するには、 nameとrateも指定する必要があります。

cURLスクリプトを使用して新しい通貨を追加します。コマンドラインで、 curlフォルダに移動します。 Currencies_POST_ToInstance.shスクリプトを実行してください。

./Currencies_POST_ToInstance.sh

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

{
   "active": false,
   "code": "AED",
   "externalReferenceCode": "AED",
   "formatPattern": {
      "en_US": "###,##0.00"
   },
   "id": 37006,
   "maxFractionDigits": 2,
   "minFractionDigits": 2,
   "name": {
      "en_US": "UAE Dirham"
   },
   "primary": false,
   "priority": 0,
   "rate": 3.67,
   "roundingMode": "HALF_EVEN",
   "symbol": ""
}
注記

externalReferenceCodeは Liferay DXP 2025.Q1/Portal GA132 で追加されました。これを使って、カタログ、チャネル、支払いエントリと連携させることができます。注文と価格表は、通貨のidを使用してリンクされていましたが、現在はcodeを使用しています。

レート欄は、基本通貨に対する換算レートを指定します。例えば、主要通貨が米ドル(USD)で、UAEディルハム(AED)を作成する場合、為替レートによって1ドルが何ディルハムになるかが決まります。通貨をプライマリーとして設定する場合、レートは1.00でなければなりません。

maxFractionDigitsとminFractionDigitsのデフォルト値は2です。これは通貨の小数点以下の桁数を指定します。

roundingModeのデフォルト値はHALF_EVENです。これはjava.math.RoundingMode列挙型を使用して、通貨の丸め処理戦略を提供します。丸めモードには、 UP 、 DOWN 、 CEILING 、 FLOOR 、 HALF_UP 、 HALF_DOWN 、 HALF_EVEN 、 UNNECESSARYの値を使用できます。

丸めモードプラスの値四捨五入した値負の値四捨五入した値説明
UP3.144-3.14-4正の数については、正の無限大の方向に四捨五入します。負の数の場合、 UP 0から遠ざかる方向に切り上げます。
DOWN3.143-3.14-3正負の数値はともにゼロ方向に四捨五入します。
CEILING3.144-3.14-3正の数については、正の無限大の方向に四捨五入します。負の数の場合、 CEILING 0 から 0 の方向に丸めます。
FLOOR3.143-3.14-4正の数については、ゼロ方向に四捨五入します。負の数の場合、 FLOOR 0 から切り上げます。
HALF_UP3.54-3.5-3最も近い隣人に向かってラウンドする。もしその数字が隣接する2つの数字のちょうど中間であれば、切り上げられます。
HALF_DOWN3.53-3.5-4最も近い隣人に向かってラウンドする。もしその数値が隣接する2つの数値のちょうど中間値であれば、切り捨てられます。
HALF_EVEN2.52-2.5-2最も近い隣人に向かってラウンドする。もしその数が隣接する2つの数のちょうど中間にある場合、最も近い偶数に切り上げられます。
UNNECESSARY3.14該当なし-3.14該当なし丸め処理が行われないように、 ArithmeticExceptionをスローします。

通貨の追加を確認するには、グローバルメニュー(Applications Menu icon)を開き、コマース→通貨に移動します。新しい通貨が登場した。

新しい通貨が追加されたことを確認してください。

または、Javaクライアントを使用してRESTサービスを呼び出します。

  1. javaフォルダに移動し、ソースファイルをコンパイルします。

    javac -classpath .:* *.java
    
  2. Currencies_POST_ToInstanceクラスを実行します。

    java -classpath .:* Currencies_POST_ToInstance
    

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

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/currencies" \
	--data-raw '
		{
			"code": "AED",
			"name": {
				"en_US": "UAE Dirham"
			},
		   "rate": 3.67
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

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

引数説明
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/currencies"RESTサービスのエンドポイントを指定してください。
--data-raw "{ "code": "AED", "name": { "en_US": "UAE Dirham" }, "rate": 3.67 }"投稿するデータを入力してください。
--header "Content-Type: application/json"リクエストボディのフォーマットをJSONに設定してください。
--request POST指定されたエンドポイントで呼び出すHTTPメソッドを設定します。
--user "test@liferay.com:learn"基本認証の認証情報を入力します。
注記

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

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

Javaクラスを調べます

Currencies_POST_ToInstance.javaクラスは、 CurrencyResourceサービスを呼び出すことで通貨を追加します。

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

	CurrencyResource currencyResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		currencyResource.postCurrency(
			new Currency() {
				{
					code = "AED";
					name = new HashMap<String, String>() {
						{
							put("en_US", "UAE Dirham");
						}
					};
					rate = new BigDecimal(3.67);
				}
			}));
}

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

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

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

注記

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

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

重要

サービスの詳細については、 CurrencyResourceをご覧ください。

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

インスタンスから通貨を取得する

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

Currencies_GET_FromInstance.sh

コマンド:

./Currencies_GET_FromInstance.sh

コード:

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

Currencies_GET_FromInstance.java

コマンド:

java -classpath .:* Currencies_GET_FromInstance

コード:

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

	CurrencyResource currencyResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		currencyResource.getCurrenciesPage(
			null, null, Pagination.of(1, 2), null));
}

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

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

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

  • アクティブ
  • 主要な
  • コード
  • 名前
フィルタークエリ説明
name eq 'UAE Dirham'通貨名はUAEディルハムと一致する必要があります。
code eq 'AED'通貨コードはAEDでなければなりません。
active eq falseこの通貨は有効ではありません

クエリでnameフィールドを使用して結果を並べ替えることができます。

ソートクエリ説明
name:desc通貨名で降順に並べ替えます。

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

通貨を取得する

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

ヒント

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

Currencies_GET_ById.sh

コマンド:

./Currencies_GET_ById.sh 1234

コード:

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

Currencies_GET_ById.java

コマンド:

java -classpath .:* -DcurrencyId=1234 Currencies_GET_ById

コード:

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

	CurrencyResource currencyResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		currencyResource.getCurrency(
			Long.valueOf(System.getProperty("currencyId"))));
}

CurrencyフィールドはJSON形式で表示されます。

通貨をパッチする

cURLとJavaのpatchコマンドを使用して、既存の通貨情報を更新します。 1234あなたの通貨のIDに置き換えてください。

Currencies_PATCH_ById.sh

コマンド:

./Currencies_PATCH_ById.sh 1234

コード:

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

Currencies_PATCH_ById.java

コマンド:

java -classpath .:* -DcurrencyId=1234 Currencies_PATCH_ById

コード:

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

	CurrencyResource currencyResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	currencyResource.patchCurrency(
		Long.valueOf(System.getProperty("currencyId")),
		new Currency() {
			{
				name = new HashMap<String, String>() {
					{
						put("en_US", "United Arab Emirates Dirham");
					}
				};
			}
		});
}

通貨を削除する

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

Currencies_DELETE_ById.sh

コマンド:

./Currencies_DELETE_ById.sh 1234

コード:

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

Currencies_DELETE_ById.java

指示

java -classpath .:* -DcurrencyId=1234 Currencies_DELETE_ById

コード:

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

	CurrencyResource currencyResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	currencyResource.deleteCurrency(
		Long.valueOf(System.getProperty("currencyId")));
}

APIエクスプローラーには、 Currencyサービスとスキーマが表示され、各サービスをテストするためのインターフェースが備わっています。