チャンネルAPIの基本
アプリケーションメニューやREST APIでチャンネルを管理することができます。 headless-commerce-admin-channel サービスを呼び出して、チャンネルを作成・管理します。
チャネルを追加する
新しいLiferay DXPインスタンスを起動し、以下を実行します。
メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
Liferayが起動したら、
-
Channel API Basics をダウンロードし、解凍してください。
-
チャンネルはインスタンスにスコープされ、各チャンネルは
currencyCode
、name
、type
を指定する必要があります。 1つのタイプ、サイト
は、すぐに利用可能です。cURLスクリプトを使用して、新しいチャンネルを追加します。 コマンドラインで、
curl
フォルダに移動します。Channel_POST_ToInstance.sh
スクリプトを実行する。JSONレスポンスには、新しいチャンネルが追加されたことが示されています:
-
チャンネルの追加を確認するには、 Global Menu(
) を開き、 Commerce → Channels に移動してください。 新しいチャンネルが表示されます。
-
または、Javaクライアントを使用してRESTサービスを呼び出します。
java
フォルダに移動し、ソースファイルをコンパイルします。 -
Channel_POST_ToInstance
クラスを実行します。
cURLコマンドの検証
Channel_POST_ToInstance.sh
スクリプトは、cURL コマンドで REST サービスを呼び出します。
コマンドの引数は次のとおりです。
引数 | 説明 |
---|---|
-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" | 基本認証の認証情報を入力します。 |
ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth 2.0を使用する 経由でユーザーを認証する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証 をご覧ください。
他のcURLコマンドも同様のJSON引数を使用します。
Javaクラスを調べる
Channel_POST_ToInstance.java
クラスは、 ChannelResource
サービスを呼び出してチャンネルを追加します。
このクラスは、次の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) から確認できます。
main
メソッドのコメントでは、クラスの実行を実演しています。
残りのサンプルJavaクラスは、異なる ChannelResource
のメソッドを呼び出します。
サービスの詳細は ChannelResource を参照ください。
以下は、cURLとJavaを使用して他の Channel
RESTサービスを呼び出す例です。
インスタンスからチャンネルを取得する
cURLまたはJavaコマンドで、Liferayインスタンスの全チャンネルをリストアップします。
Channels_GET_FromInstance.sh
コマンド:
コード:
Channels_GET_FromInstance.java
コマンド:
コード:
インスタンスの 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
をメモします。
Channel_GET_ById.sh
コマンド:
コード:
Channel_GET_ById.java
コマンド:
コード:
チャンネル
のフィールドを JSON で列挙します。
チャンネルをパッチする
cURL と Java patch
コマンドで既存のチャンネルを更新します。 1234
を自分のチャンネルのIDに置き換えてください。
Channel_PATCH_ById.sh
コマンド:
コード:
Channel_PATCH_ById.java
コマンド:
コード:
チャンネルを削除する
cURL と Java delete
コマンドで既存のチャンネルを削除します。 1234
を自分のチャンネルのIDに置き換えてください。
Channel_DELETE_ById.sh
コマンド:
コード:
Channel_DELETE_ById.java
コマンド:
コード:
RESTサービスの使用 では、 Channel
のサービスとスキーマを表示し、各サービスをテストするためのインターフェイスを備えています。