ディスカウントAPIの基本
アプリケーションメニューから、またはREST APIを使用して割引を管理できます。 headless-admin-commerce-pricing サービスを呼び出して、割引を作成・管理します。
ディスカウントを追加する
新しいLiferay DXPインスタンスを起動し、以下を実行します。
メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
Liferayが起動したら。
-
割引API基礎編 をダウンロードし、解凍してください。
-
ディスカウントはインスタンスにスコープされます。 cURLスクリプトを使用して、新しい割引を追加してください。 コマンドラインで、
curl
フォルダに移動します。Discount_POST_ToInstance.sh
スクリプトを実行する。JSONレスポンスには、新しい割引が追加されたことが示されています。
-
割引の追加を確認するには、 グローバルメニュー(
) を開き、 コマース → ディスカウント に移動します。 新しい割引が表示されます。
-
または、Javaクライアントを使用してRESTサービスを呼び出します。
java
フォルダに移動し、ソースファイルをコンパイルします。 -
Discount_POST_ToInstance
クラスを実行します。
クーポンコードを追加する
割引にクーポンコードを追加するには、 useCouponCode
を true
に設定し、 couponCode
フィールドに値を設定する。 クーポンコードの利用を制限する場合は、下表の設定をご利用ください。
制限の種類 | 設定 | 説明 |
---|---|---|
使用回数 | "limitationType" : "limited for total" "limitationTimes" : 5 (任意の整数) | クーポンコードは合計5回まで使用可能です。 |
1アカウントあたりの利用回数 | "limitationType "です。"limited for account" "limitationTimesPerAccount" :5 (任意の整数) | 1アカウントにつき5回までクーポンコードを使用することができます。 |
使用回数とアカウント別 | "limitationType" : "limited for account and total" "limitationTimesPerAccount":2 (任意の整数)"limitationTimes" : 5 (任意の整数) | クーポンコードは1アカウントにつき2回まで使用でき、合計5回まで使用できます。 |
cURLコマンドの検証
Discount_POST_ToInstance.sh
スクリプトは、cURL コマンドで REST サービスを呼び出します。
ここでは、コマンドの引数を紹介します。
引数 | 説明 |
---|---|
-H "Content-Type: application/json" | リクエストボディの形式をJSONに設定します。 |
-X POST | 指定されたエンドポイントで呼び出す HTTP メソッドを設定します。 |
"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts" | RESTサービスのエンドポイントを指定します。 |
-d "{\"level\": \"L1\", \"limitationType\": \"unlimited\", \"target\": \"products\", \"title\": \"Foo\", \"usePercentage\": true}" | 投稿するデータを入力します。 |
-u "test@liferay.com:learn" | 基本認証の認証情報を入力します。 |
ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth 2.0を使用する 経由でユーザーを認証する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証 をご覧ください。
他のcURLコマンドも同様のJSON引数を使用しています。
Javaクラスを調べる
Discount_POST_ToInstance.java
クラスは、 DiscountResource
サービスを呼び出して割引を追加します。
このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。
行(省略形) | 説明 |
---|---|
DiscountResource.Builder builder = ... | DiscountResource サービスインスタンスを生成するための Builder を取得する。 |
DiscountResource discountResource = builder.authentication(...).build(); | 基本認証を使用し、 DiscountResource サービスインスタンスを生成します。 |
discountResource.postDiscount(...); | discountResource.postDiscount メソッドを呼び出し、postにデータを渡します。 |
プロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.pricing.client.jar
ファイルが含まれていることに注意してください。 すべての REST アプリケーションのクライアント JAR 依存情報は、インストール先の API Explorer で /o/api
(例: http://localhost:8080/o/api) から確認できます。
main
メソッドのコメントでは、クラスの実行を実演しています。
残りのサンプルJavaクラスは、異なる DiscountResource
のメソッドを呼び出します。
サービスの詳細は DiscountResource を参照ください。
以下は、cURLとJavaを使用して、他の ディスカウント
RESTサービスを呼び出す例です。
インスタンスから割引を受ける
cURLやJavaのコマンドで、Liferayインスタンスのすべてのディスカウントをリストアップします。
Discounts_GET_FromInstance.sh
コマンド:
コード:
Discounts_GET_FromInstance.java
コマンド:
コード:
インスタンスの Discount
オブジェクトはJSONでフォーマットされています。
割引を受ける
cURL または Java get
コマンドで特定の割引を取得します。 1234
を割引のIDに置き換えてください。
Discounts_GET_FromInstance.[java|sh]を使用して、すべての割引のリストを取得し、特に欲しい割引の
id` をメモします。
Discount_GET_ById.sh
コマンド:
コード:
Discount_GET_ById.java
コマンド:
コード:
Discount
フィールドはJSONで記載されています。
パッチアディスカウント
cURLとJava patch
コマンドで既存の割引を更新します。 1234
を割引のIDに置き換えてください。
Discount_PATCH_ById.sh
コマンド:
コード:
Discount_PATCH_ById.java
コマンド:
コード:
ディスカウントを削除する
cURL と Java delete
コマンドで既存の割引を削除する。 1234
を割引のIDに置き換えてください。
Discount_DELETE_ById.sh
コマンド:
コード:
Discount_DELETE_ById.java
コマンド
コード:
RESTサービスの使用 では、 Discount
のサービスとスキーマを表示し、各サービスをテストするためのインターフェイスを備えています。