上線和安裝
安裝目錄服務,以使用目錄服務GraphQL API從Commerce執行個體要求及接收產品資料。 目錄服務是以repo.magento.com存放庫中Composer中繼資料的形式提供。
系統需求
軟體需求
- Adobe Commerce 2.4.4+
- PHP 8.1、8.2、8.3
- Composer: 2.x
支援的平台
- 雲端基礎結構上的Adobe Commerce: 2.4.4+
- Adobe Commerce內部部署: 2.4.4+
端點
Catalog Service有兩個可用於上線的端點:
- 沙箱(
https://catalog-service-sandbox.adobe.io/graphql
) — 用於上線前的測試和驗證 - 製作(
https://catalog-service.adobe.io/graphql
) — 用於Commerce商家和網站的即時流量
所有Commerce測試執行個體都使用沙箱端點。
在沙箱端點上執行所有載入測試。 開始載入測試之前,請先提交支援票證,讓服務團隊可以預期額外的伺服器流量。
安裝和設定
若要開始使用Adobe Commerce的Catalog Service,必須執行下列步驟:
- 安裝目錄服務延伸模組(
magento/catalog-service
) - 設定服務與資料匯出
- 存取服務
安裝目錄服務擴充功能
先決條件
-
存取repo.magento.com以安裝擴充功能。 如需金鑰產生與取得必要許可權,請參閱取得您的驗證金鑰。 如需雲端安裝,請參閱雲端基礎結構上的Commerce指南
-
存取Adobe Commerce應用程式伺服器的命令列。
在執行Adobe Commerce 2.4.4版或更新版本的Adobe Commerce執行個體上安裝最新版本的目錄服務擴充功能(magento/catalog-service
)。 目錄服務是以Composer中繼資料的形式從repo.magento.com存放庫傳送。
使用此方法來安裝Commerce Cloud執行個體的Catalog Service。
-
在本機工作站上,變更至雲端基礎結構專案上Adobe Commerce的專案目錄。
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將目錄服務模組新增至您的專案:
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 Data Export擴充功能處理。
-
設定Commerce Services Connector,方法是指定API金鑰並選取SaaS資料空間。
Commerce服務聯結器設定是使用Adobe Commerce服務(例如目錄服務、即時搜尋和產品Recommendations)所需的一次性程式。 如果您已經為另一個服務設定了聯結器,請略過此步驟。
-
從資料管理儀表板執行初始資料同步。
視目錄大小而定,初始同步可能需要幾分鐘到幾小時的時間。 您可以從「資料管理」控制面板監視同步化狀態。 初始同步後,「目錄」會持續匯出產品資料,以保持服務在最新狀態。
note note NOTE 您也可以使用Commerce CLI從命令列啟動初始同步。 請參閱_SaaS Data Export Guide_中的Initial sync。
若要確保目錄匯出可正確執行:
- 確認cron工作正在執行。
- 請確認索引子是從Admin執行,或使用Commerce CLI命令
bin/magento indexer:info
執行。 - 確認
Catalog Attributes Feed, Product Feed, Product Overrides Feed
和Product Variant Feed
索引子已設定為Update by Schedule
。
監控資料同步並疑難排解
透過Commerce Admin,您可以使用資料管理控制面板來監視同步化程式。 使用Commerce CLI和記錄檔來管理和疑難排解程式。
存取服務
可透過HTTPS使用POST命令從 https://catalog-service.adobe.io/graphql
端點存取Catalog Service GraphQL API。
在您的GraphQL查詢中,您必須指定多個HTTP標頭,包括您在「管理員」中新增到Adobe Commerce Services Connector設定的公開API金鑰。 如需詳細資訊,請參閱Storefront Services GraphQL檔案。
防火牆設定
若要允許Catalog Service通過防火牆,請新增commerce.adobe.io
至允許清單。
目錄服務和API網格
適用於Adobe Developer App Builder🔗的API Mesh可讓開發人員使用AdobeIO將私人或協力廠商API和其他介面與Adobe產品整合。
請參閱Catalog Service 和API Mesh主題,以取得安裝和設定詳細資料。
資料管理控制面板
如需Catalog Service資料同步處理的詳細資訊,請參閱資料管理儀表板。