Commerce Services Connector
Adobe CommerceとMagento Open Sourceの一部の機能はCommerce Servicesによって提供され、SaaS (Software as a Service)としてデプロイされます。 これらのサービスを使用するには、実稼動用およびサンドボックス API キーを使用してCommerce インスタンスを接続し、設定でデータ領域を指定する必要があります。 各インスタンスに対して1回だけ接続を設定する必要があります。
これらのAPI キーを生成できるのは、Commerce ライセンス所有者のみです。 ライセンス所有者でない場合は、ストアのCommerce ライセンスを所有しているユーザーまたはチームにキーをリクエストしてください。
利用可能なサービス availableservices
次に、Commerce Services Connectorを通じてアクセスできるCommerce機能を示します。
デザイン
上位レベルでは、Commerce Services Connectorは次のコア要素で構成されています。
次の節では、これらの各要素について詳しく説明します。
資格情報 apikey
実稼動用およびサンドボックス API キーは、 ライセンス所有者のCommerce アカウントから生成されます。 Commerce アカウントは、一意のCommerce ID (MageID)によって識別されます。 加盟店の組織のライセンス所有者は、アカウントが良好な状態であれば、商品レコメンデーションやライブサーチなどのサービス用のAPI キーを生成できます。
キーは、ライセンス所有者に代わってプロジェクトや環境を管理するシステムインテグレーターまたは開発チームと「知っておく必要がある」方法で共有できます。 ライセンス所有者からShared Accessを付与された開発者は、アカウントのSwitch Accounts ドロップダウンに加盟店の組織が存在する場合でも、ライセンス所有者に代わってキーを生成することはできません。
さらに、ソリューションインテグレーターはCommerce Servicesを使用する権利があります。 ソリューション インテグレーターの場合、Commerceのパートナー契約の署名者はAPI キーを生成する必要があります。
キー識別子 実稼動環境 および サンドボックス は、Commerce Servicesがデータを保存するSaaS データスペース環境を参照します(Adobe Commerce環境には含まれません)。 ローカル、開発、ステージング、実稼動のAdobe Commerce環境で同じAPI キーのセットを使用できます。重要なのは、設定したデータ領域に対して正しいキーペアを貼り付けることです。
通常、ライセンスオーナーは、Adobe Commerce アカウントのプライマリ担当者であり、Adobe Commerce オンクラウドインフラストラクチャプロジェクトのプロジェクトオーナーと必ずしも同じではありません。
実稼動およびサンドボックス API キーの生成 genapikey
-
https://account.magento.comでCommerce アカウントにログインします。
-
「Magento」タブで、サイドバーの「API Portal」を選択します。
-
環境 メニューから、実稼動または サンドボックス を選択します。
-
API キー セクションに名前を入力し、新規を追加をクリックしてダイアログを開き、新しいキーをダウンロードします。
note warning WARNING 秘密鍵のコピーまたはダウンロードは1回のみです。 安全な保管: -
「ダウンロード」をクリックして秘密鍵を保存し、ダイアログを閉じます。
-
各環境(実稼動環境とサンドボックス)に対して、上記の手順を繰り返します。
「API キー」セクションに、API (公開)キーが表示されるようになりました。 ライセンスに関連する環境またはインストールのいずれかでSaaS プロジェクト を選択または作成する場合は、4つのキー(実稼動用キーとサンドボックスキーの両方、パブリック+プライベート)がすべて必要です。
SaaS設定 saasenv
Commerce Servicesが適切な場所にデータを送信できるように、Commerce インスタンスをSaaS プロジェクトとSaaS データスペースで設定する必要があります。 SaaS プロジェクトは、あらゆるSaaS データ空間をグループ化します。 SaaS データ スペースは、Commerce Servicesが作業できるようにデータを収集および保存するために使用されます。 このデータの一部はCommerce インスタンスからエクスポートされ、一部はストアフロントの買い物客の行動から収集される可能性があります。 そのデータは、クラウドストレージのセキュリティを確保するために保持されます。
Product RecommendationsとLive Searchの場合、SaaS データ スペースにはカタログと行動データが含まれます。 Commerce設定で🔗を選択すると、Commerce インスタンスをSaaS データ領域にポイントできます。
管理者にライブサーチ設定フィールドが見つからない場合は、選択したデータスペースに対して正しいAPI キーペアを入力したことを確認します(実稼動データスペースでは実稼動キーを使用し、テストデータスペースではサンドボックスキーを使用します)。 誤ったキーを設定した場合、ライブサーチなどのSaaS サービスは、そのAdobe Commerce環境では使用できません。
API キーの削除 delapikey
API キーを削除する前に、置き換えキーを生成して安全に保存します。 新しいキーを使用するためにすべての統合を更新し、依存サービスが期待どおりに機能していることを確認します。
管理パネルに Live Search 設定フィールドが表示されない場合は、その環境に正しいSaaS API キーを入力したことを確認してください。 実稼動データ領域には実稼動SaaS キーを、ステージング データ領域にはステージング キーを使用します。 誤ったキーが設定されている場合、Adobe Commerce環境ではSaaS サービス(Live Searchを含む)を利用できません。
削除するAPI キーで、Deleteをクリックします。 確認メッセージが表示されたら、キーを完全に削除する操作を確認します。
SaaS データ空間のプロビジョニング
Adobe Commerceをご利用のお客様は、SaaS プロジェクトごとに、1つの本番データスペースと2つのテストデータスペースにアクセスできます。
実稼動以外の環境では、テストデータスペースを使用できますが、複数の環境で同じデータスペースを同時に使用することは避けてください。 テストデータスペースを別の環境に移動する場合は、新しい環境で選択して設定する前にデータクリーンアップを実行します。
複数のステージング環境を持つAdobe Commerce Cloud Pro プロジェクトの場合は、 サポートリクエストを送信することにより、ステージング環境ごとに追加のテストデータスペースをリクエストできます。 ただし、ステージング環境が1つしかなく、追加のテストデータスペースが必要な場合は、次のオプションを使用できます。
-
カスタマーサクセスチームまたは専任のカスタマーサクセスマネージャーに連絡して、追加のステージング環境をリクエストしてください。
-
追加のテストデータ領域をリクエストし、追加のデータ領域のビジネス上の理由を示すには、サポートリクエスト を送信します。 この要求は承認済みです。
Adobe Payment Servicesをご利用のMagento Open Sourceのお客様は、追加のデータスペースをリクエストすることもできます。 テストデータスペースをリクエストするには、 サポートリクエスト を送信する前に、支払いチームに追加データスペースの事前承認を依頼してください。
複数のクラウドプロジェクトまたはオンプレミス(ライブ/実稼動)のインストールを所有しているお客様は、 サポートリクエスト を送信することで、各プロジェクトまたはインスタンスの追加の実稼動およびテストデータスペースをリクエストすることもできます。
SaaS プロジェクトの選択または作成 createsaasenv
SaaS プロジェクトを選択または作成するには、ストアのCommerce ライセンス所有者からCommerce API キーをリクエストします。
-
管理者 サイドバーで、システム/サービス/Commerce Services Connectorに移動します。
Commerce Services Connector セクションが表示されない場合は、目的のCommerce サービス のCommerce モジュールをインストールし、
magento/module-services-idパッケージがインストールされていることを確認します。 -
Sandbox API KeysおよびProduction API Keys セクションにキー値を貼り付けます。
- 秘密鍵には、キーの先頭に
-----BEGIN PRIVATE KEY-----、キーの末尾に-----END PRIVATE KEY-----を含める必要があります。 - 実際のキーのコピーがない場合は、ライセンス所有者に確認し、値を設定に接続します。
データベースのバックアップまたはスナップショットからコピーしたキー値を貼り付けないでください。 設定が保存されると、暗号化の追加レイヤーが適用され、キーは機能しません。
- 秘密鍵には、キーの先頭に
-
保存をクリックします。
キーに関連付けられているSaaS プロジェクトはすべて、SaaS識別子 セクションのプロジェクト フィールドに表示されます。
-
SaaS プロジェクトが存在しない場合は、プロジェクトを作成をクリックします。 次に、プロジェクト フィールドに、SaaS プロジェクトの名前を入力します。
混乱を避けるために、特定のCommerce サービスをプロジェクトの名前として使用しないでください(例:Live Search、Product Recommendations、Data Connection)。 ライセンスが複数のSaaS プロジェクト用にプロビジョニングされていない限り、同じSaaS プロジェクトを複数のサービスに使用できます。
-
Commerce ストアの現在の設定に使用する データ領域 を選択します。
Commerce サービスと統合する個別のインスタンスがある場合、 サポートチケットを送信して、追加のインスタンスごとに新しいSaaS プロジェクトをリクエストします。 サポートがSaaS プロジェクトを作成したら、同じAPI キー を使用してインスタンス のCommerce Services Connectorを設定し、新しいSaaS プロジェクトとデータスペースを選択します。
SaaS プロジェクトまたはデータスペースの名前を変更するには、いずれかの横にある 名前を変更 をクリックします。 名前を変更してもサービスには影響しません。名前は、プロジェクトとデータ空間を識別して区別するのに役立つラベルにすぎません。
IMS組織(オプション) organizationid
Adobe Commerce インスタンスをAdobe Experience Platformに接続するには、Adobe IDを使用してAdobe アカウントにログインします。 ログインすると、Adobe アカウントに関連付けられているIMS組織がこのセクションに表示されます。
SaaS データ書き出し
Commerce インスタンスがCommerce Servicesに正常に接続すると、SaaS データ書き出しプロセスによってCommerce サーバーからCommerce SaaS ServicesにCommerce データが書き出され、接続されているCommerce サービスに同期できるようになります。 管理者では、 データ管理ダッシュボード を使用して同期ステータスを確認できます。 詳しくは、SaaS データ書き出しガイド を参照してください。