チャンネルAPIの基本

アプリケーションメニューやREST APIでチャンネルを管理することができます。 headless-commerce-admin-channel サービスを呼び出して、チャンネルを作成・管理します。

チャネルを追加する

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

docker run -it -m 8g -p 8080:8080 。

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

Liferayが起動したら、

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

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

   unzip liferay-a2t5.zip
   

2. チャンネルはインスタンスにスコープされ、各チャンネルは currencyCode、 name、 typeを指定する必要があります。 1つのタイプ、 サイトは、すぐに利用可能です。

   cURLスクリプトを使用して、新しいチャンネルを追加します。 コマンドラインで、 curlフォルダに移動します。 Channel_POST_ToInstance.sh スクリプトを実行する。

   ./Channel_POST_ToInstance.sh
   

   JSONレスポンスには、新しいチャンネルが追加されたことが示されています：

   {
      "currencyCode" : "USD",
      "externalReferenceCode" : "29f395e8-779c-e95e-36f6-844a1ebf00c4",
      "id" : 46901,
      "name" : "Foo",
      "siteGroupId" : 0,
      "type" : "site"
   }
   

3. チャンネルの追加を確認するには、 Global Menu() を開き、 Commerce → Channels に移動してください。 新しいチャンネルが表示されます。

   

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

   javac -classpath .:* *.java
   

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

   java -classpath .:* Channel_POST_ToInstance
   

cURLコマンドの検証

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

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

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

Javaクラスを調べる

Channel_POST_ToInstance.java クラスは、 ChannelResource サービスを呼び出してチャンネルを追加します。

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

	ChannelResource channelResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		channelResource.postChannel(
			new Channel() {
				{
					currencyCode = "USD";
					name = "Foo";
					type = "site";
				}
			}));
}

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

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

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

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

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

インスタンスからチャンネルを取得する

cURLまたはJavaコマンドで、Liferayインスタンスの全チャンネルをリストアップします。

Channels_GET_FromInstance.sh

コマンド：

./Channels_GET_FromInstance.sh

コード：

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

Channels_GET_FromInstance.java

コマンド：

java -classpath .:* Channels_GET_FromInstance

コード：

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

	ChannelResource channelResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		channelResource.getChannelsPage(
			null, null, Pagination.of(1, 2), null));
}

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

チャネルのフィルタリング、ページ分割、検索、ソート

このAPIは、チャンネルをフィルタリング、ページ分割、検索、ソートするためのパラメータも受け付けます。 詳しくは、 getChannelsPage メソッドをご参照ください。 クエリでは、以下の Channel フィールドを使用して、結果のフィルタリング、検索、ソートを行うことができます：

• name
• siteGroupId

フィルタークエリ	説明
siteGroupId eq '12345'	チャネルの siteGroupId は 12345 と同じでなければなりません。
name eq 'Foo'	チャンネル名はFooと同じでなければならない。

ソートクエリ	説明
name:desc	名前の降順で並べます。
siteGroupId:asc	siteGroupIdの昇順でソートする。

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

チャンネルを取得する

cURL または Java get コマンドで特定のチャンネルを取得します。 1234 をチャンネルのIDに置き換えてください。

Channel_GET_ById.sh

コマンド：

./Channel_GET_ById.sh 1234

コード：

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

Channel_GET_ById.java

コマンド：

java -classpath .:* -DchannelId=1234 Channel_GET_ById

コード：

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

	ChannelResource channelResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		channelResource.getChannel(
			Long.valueOf(System.getProperty("channelId"))));
}

チャンネル のフィールドを JSON で列挙します。

チャンネルをパッチする

cURL と Java patch コマンドで既存のチャンネルを更新します。 1234 を自分のチャンネルのIDに置き換えてください。

Channel_PATCH_ById.sh

コマンド：

./Channel_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-channel/v1.0/channels/${1}" \
	--data-raw '
		{
			"name": "Bar"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

Channel_PATCH_ById.java

コマンド：

java -classpath .:* -DchannelId=1234 Channel_PATCH_ById

コード：

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

	ChannelResource channelResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	channelResource.patchChannel(
		Long.valueOf(System.getProperty("channelId")),
		new Channel() {
			{
				name = "Bar";
			}
		});
}

チャンネルを削除する

cURL と Java delete コマンドで既存のチャンネルを削除します。 1234 を自分のチャンネルのIDに置き換えてください。

Channel_DELETE_ById.sh

コマンド：

./Channel_DELETE_ById.sh 1234

コード：

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

Channel_DELETE_ById.java

コマンド：

java -classpath .:* -DchannelId=1234 Channel_DELETE_ById

コード：

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

	ChannelResource channelResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	channelResource.deleteChannel(
		Long.valueOf(System.getProperty("channelId")));
}

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