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

チャンネルAPIの基本

アプリケーションメニューから、またはREST APIを使ってチャンネルを管理できます。チャネルを作成および管理するには、 headless-commerce-admin-channel サービスを呼び出します。

チャネルを追加する

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

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

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

Liferayが起動したら、

Channel API Basicsをダウンロードして解凍します。

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

unzip liferay-a2t5.zip

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

cURLスクリプトを使用して、新しいチャンネルを追加します。コマンドラインで、curlフォルダに移動します。 Channels_POST_ToInstance.sh スクリプトを実行します。
```
./Channels_POST_ToInstance.sh
```
JSONレスポンスには、新しいチャンネルが追加されたことが示されています。
```
{
   "currencyCode" : "USD",
   "externalReferenceCode" : "29f395e8-779c-e95e-36f6-844a1ebf00c4",
   "id" : 46901,
   "name" : "Foo",
   "siteGroupId" : 0,
   "type" : "site"
}
```
チャネルの追加を確認するには、 グローバルメニュー () を開き、 コマース → チャネルに移動します。新しいチャンネルが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java
```
javac -classpath .:* *.java
```



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


cURLコマンドの検証
Channels_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" 基本認証の認証情報を入力します。




注


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


他のcURLコマンドも同様のJSON引数を使用しています。
Javaクラスを調べる
Channels_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メソッドを呼び出し、投稿するデータを渡します。


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


注


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


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


重要


サービスの詳細については、 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に置き換えてください。


ヒント


すべてのチャネルのリストを取得するには、 Channels_GET_FromInstance.[java|sh] を使用し、必要なチャネルの id を書き留めておきます。


Channels_GET_ById.sh
コマンド：
./Channels_GET_ById.sh 1234

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

Channels_GET_ById.java
コマンド：
java -classpath .:* -DchannelId=1234 Channels_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"))));
}

ChannelのフィールドがJSONに一覧表示されます。
チャンネルにパッチを適用する
cURL と Java patch コマンドで既存のチャンネルを更新します。 1234 を自分のチャンネルのIDに置き換えてください。
チャネル_PATCH_ById.sh
コマンド：
./Channels_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"

Channels_PATCH_ById.java
コマンド：
java -classpath .:* -DchannelId=1234 Channels_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に置き換えてください。
チャネル_DELETE_ById.sh
コマンド：
./Channels_DELETE_ById.sh 1234

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

Channels_DELETE_ById.java
コマンド
java -classpath .:* -DchannelId=1234 Channels_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")));
}

API エクスプローラー には、 チャネル サービスとスキーマが表示され、各サービスをテストするためのインターフェースがあります。

					
							
								
									Capability:
								
									
										
											Commerce
										
									
							
							
								
									Resource Type:
								
									
										
											Official Documentation
										
									
							
							
								
									Feature:
								
									
										
											API Development
										
									
									
										
											Storefronts
										
									
							
							
								
									Deployment Approach:
								
									
										
											Liferay PaaS
										
									
									
										
											Liferay SaaS
										
									
									
										
											Liferay Self-Hosted

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

引数	説明
`-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"`	基本認証の認証情報を入力します。

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

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