オンボーディングとインストール
カタログサービスをインストールし、Catalog Service GraphQL API を使用してCommerce インスタンスから商品データをリクエストし、受け取ります。 カタログサービスは、repo.magento.com リポジトリからコンポーザメタパッケージとして提供されます。
必要システム構成
ソフトウェア要件
- Adobe Commerce 2.4.4 以降
- PHP 8.1、8.2、8.3
- コンポーザー:2.x
サポートされているプラットフォーム
- クラウドインフラストラクチャー上のAdobe Commerce:2.4.4 以降
- Adobe Commerce オンプレミス:2.4.4 以降
エンドポイント
Catalog Service には、オンボーディングに使用できる 2 つのエンドポイントがあります。
- サンドボックス(
https://catalog-service-sandbox.adobe.io/graphql
) – 運用開始前のテストと検証に使用 - 実稼動(
https://catalog-service.adobe.io/graphql
) - Commerceのマーチャントおよび web サイトのライブトラフィックに使用します。
すべてのCommerce テストインスタンスは、サンドボックス エンドポイントを使用します。
サンドボックスエンドポイントですべての負荷テストを実行します。 負荷テストを開始する前に、 サポートチケットを送信して、サービスチームが追加のサーバートラフィックを予測できるようにします。
インストールと設定
Adobe Commerceの Catalog Service を使い始めるには、次の手順が必要です。
- カタログサービス拡張機能(
magento/catalog-service
)のインストール - サービスとデータの書き出しの設定
- サービスへのアクセス
カタログサービス拡張機能のインストール
前提条件
-
repo.magento.com にアクセスして、拡張機能をインストールします。 キーの生成と必要な権限の取得については、 認証キーの取得を参照してください。 クラウドインストールについては、Commerce on Cloud Infrastructure ガイドを参照してください
-
Adobe Commerce アプリケーションサーバーのコマンドラインにアクセスします。
Adobe Commerce バージョン 2.4.4 以降が稼働しているAdobe Commerce インスタンスに、最新バージョンのカタログサービス拡張機能(magento/catalog-service
)をインストールします。 カタログサービスは、repo.magento.com リポジトリからコンポーザメタパッケージとして提供されます。
このメソッドを使用して、Commerce Cloudインスタンスの Catalog Service をインストールします。
-
ローカルワークステーションで、Adobe Commerce on cloud infrastructure プロジェクトのプロジェクトディレクトリに移動します。
note note NOTE Commerce Adobe Commerce プロジェクト環境のローカル管理について詳しくは、クラウドインフラストラクチャユーザーガイドの CLI を使用したブランチの管理を参照してください。 -
Adobe Commerce Cloud CLI を使用して更新する環境ブランチを確認します。
code language-shell magento-cloud environment:checkout <environment-id>
-
カタログサービスモジュールを追加します。
code language-bash composer require magento/catalog-service --no-update
-
パッケージの依存関係を更新します。
code language-bash composer update "magento/catalog-service"
-
composer.json
ファイルとcomposer.lock
ファイルのコード変更をコミットしプッシュします。 -
composer.json
ファイルとcomposer.lock
ファイルのコード変更を追加、コミットし、クラウド環境にプッシュします。code language-shell git add -A git commit -m "Add catalog service module" git push origin <branch-name>
アップデートをクラウド環境にプッシュすると、Commerce クラウドデプロイメントプロセスが開始され変更が適用されます。 デプロイメントログからデプロイメントステータスを確認します。
オンプレミスのインスタンスに Catalog Service をインストールするには、この方法を使用します。
-
Composer を使用して、Catalog Service モジュールをプロジェクトに追加します。
code language-bash composer require magento/catalog-service --no-update
-
依存関係を更新し、拡張機能をインストールします。
code language-bash composer update "magento/catalog-service"
-
Adobe Commerceをアップグレード :
code language-bash bin/magento setup:upgrade
-
キャッシュをクリアする:
code language-bash bin/magento cache:clean
note tip TIP 場合によっては(特に実稼動環境にデプロイする場合)、コンパイル済みのコードは時間がかかるので、クリアしないようにしたい場合があります。 変更を加える前に、システムを必ずバックアップしてください。
サービスとデータの書き出しの設定
Catalog Service をインストールしたら、次のタスクを実行してカタログサービスをAdobe Commerce インスタンスに統合します。 この統合により、Commerce インスタンス、カタログサービスおよびその他のサポートサービス間のデータ同期と通信が可能になります。 データ同期は、SaaS データ書き出し拡張機能で処理されます。
-
API キーを指定し、SaaS データ空間を選択して 🔗0}Commerce サービスコネクタ } を設定します。
Commerce Services Connector のセットアップは、カタログサービス、ライブ検索、製品RecommendationsなどのAdobe Commerce サービスを使用するために必要な 1 回限りのプロセスです。 別のサービス用にコネクタを既に設定している場合は、この手順をスキップします。
-
データ管理ダッシュボードから初期データ同期を実行します。
カタログのサイズに応じて、最初の同期に数分から数時間かかる場合があります。 同期ステータスは、データ管理ダッシュボードから監視できます。 最初の同期の後、カタログは、サービスを最新の状態に保つために、継続的に製品データを書き出します。
note note NOTE Commerce CLI を使用して、コマンドラインから初期同期を開始することもできます。 SaaS データ書き出しガイドの 初期同期 を参照してください。
カタログの書き出しが正しく実行されていることを確認するには:
- cron ジョブが実行中であることを確認
- インデクサーが 管理者から、またはCommerce CLI コマンド
bin/magento indexer:info
ールを使用して実行されていることを確認します。 Catalog Attributes Feed, Product Feed, Product Overrides Feed
とProduct Variant Feed
のインデクサーがUpdate by Schedule
に設定されていることを確認します。
データ同期の監視とトラブルシューティング
Commerce Admin から、Data Management Dashboard を使用して同期プロセスを監視できます。 Commerce CLI とログを使用して、プロセスの管理とトラブルシューティングを行います。
サービスへのアクセス
Catalog Service GraphQL API には、 https://catalog-service.adobe.io/graphql
エンドポイントから、POSTコマンドを使用して HTTPS でアクセスできます。
GraphQL クエリでは、管理者でAdobe Commerce サービスコネクタ設定に追加した公開 API キーを含む、複数の HTTP ヘッダーを指定する必要があります。 詳しくは、 ストアフロントサービスGraphQL ドキュメントを参照してください。
ファイアウォール設定
ファイアウォールを通過する Catalog Service を許可するには、commerce.adobe.io
を許可リストに追加します。
カタログサービスと API メッシュ
Adobe Developer App Builderの API メッシュを使用すると、開発者は、プライベートまたはサードパーティの API およびその他のインターフェイスを、Adobe IO を使用するAdobe製品と統合できます。
インストールと設定について詳しくは、Catalog Service および API メッシュに関するトピックを参照してください。
データ管理ダッシュボード
データの同期について詳 Catalog Service くは、 データ管理ダッシュボードを参照してください。