[仅限PaaS]{class="badge informative" title="仅适用于云项目(Adobe管理的PaaS基础架构)和内部部署项目上的Adobe Commerce 。"}

载入和安装

NOTE
对于使用Adobe Commerce Optimizer或Adobe Commerce Optimizer Connector的Commerce解决方案,请使用促销服务GraphQL API,而不是目录服务GraphQL API。

要使用目录服务GraphQL API从Commerce实例请求和接收产品数据,请安装目录服务。 目录服务以Composer PHP元包的形式从repo.magento.com存储库提供。

NOTE
如果您的Commerce实例使用实时搜索或产品推荐,则当您载入或升级这些服务时,会自动安装或更新目录服务。 有关详细信息,请参阅实时搜索产品推荐的安装说明。
如果您使用的是Adobe Commerce as a Cloud Service,则您的环境中提供了最新版本的中继包。 要开始使用这些服务,请参阅目录服务入门
有关使用Adobe Commerce Optimizer的Commerce店面实施,请参阅适用于Adobe Commerce Optimizer的促销服务开发人员指南

系统要求

软件要求

Adobe Commerce 2.4.4+。 有关详细信息,请参阅系统要求

支持的平台

  • 云基础架构上的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)
  • 配置服务和数据导出
  • 访问服务

安装目录服务扩展

预修课程

在运行Adobe Commerce 2.4.4或更高版本的Adobe Commerce实例上安装最新版本的目录服务扩展(magento/catalog-service)。 目录服务是作为repo.magento.com存储库中的编辑器中继包提供的。

云基础架构

使用此方法为Commerce Cloud实例安装Catalog Service。

  1. 在本地工作站上,转到云基础架构项目上Adobe Commerce的项目目录。

    note
    NOTE
    有关在本地管理Commerce项目环境的信息,请参阅《云基础架构用户指南》上的 Adobe Commerce中的使用CLI管理分支
  2. 查看要使用Adobe Commerce Cloud CLI更新的环境分支。

    code language-shell
    magento-cloud environment:checkout <environment-id>
    
  3. 使用编辑器添加magento/catalog-service模块:

    code language-bash
    composer require magento/catalog-service --no-update
    
  4. 更新包依赖关系。

    code language-bash
    composer update "magento/catalog-service"
    
  5. 添加、提交并将composer.jsoncomposer.lock文件的代码更改推送到云环境。

    code language-shell
    git add -A
    git commit -m "Add catalog service module"
    git push origin <branch-name>
    

    将更新推送到云环境会启动Commerce云部署流程以应用更改。 从部署日志中检查部署状态。

内部部署

使用此方法为内部部署实例安装Catalog Service。

  1. 使用编辑器添加magento/catalog-service包:

    code language-bash
    composer require magento/catalog-service --no-update
    
  2. 更新依赖项并安装扩展:

    code language-bash
    composer update  "magento/catalog-service"
    
  3. 升级Adobe Commerce:

    code language-bash
    bin/magento setup:upgrade
    
  4. 清除缓存:

    code language-bash
    bin/magento cache:clean
    
    note tip
    TIP
    在某些情况下,特别是在部署到生产环境时,您可能希望避免清除编译的代码,因为这样可能需要一些时间。 在进行任何更改之前,请确保备份系统。

配置服务和数据导出

要在安装Catalog Service之后将目录服务与Adobe Commerce实例集成,请完成以下任务。 此集成支持在Commerce实例、目录服务和其他支持服务之间进行数据同步和通信。 SaaS数据导出扩展处理数据同步。

  1. 通过指定API密钥并选择SaaS数据空间来设置Commerce Services Connector

    Commerce服务连接器设置是使用Adobe Commerce服务(如目录服务、实时搜索和产品推荐)所需的一次性过程。 如果已为其他服务配置了连接器,请跳过此步骤。

  2. 数据管理功能板执行初始数据同步。

    初始同步可能需要几分钟到几小时时间,具体取决于目录大小。 您可以从“数据管理”仪表板监视同步状态。 初始同步后,目录会持续导出产品数据以使服务保持最新。

    note
    NOTE
    您还可以使用Commerce CLI从命令行启动初始同步。 请参阅​_SaaS数据导出指南_​中的初始同步

要确保正确运行目录导出,请执行以下操作:

  • 确认cron作业正在运行
  • 验证索引器是从Admin运行,还是使用Commerce CLI命令bin/magento indexer:info运行。
  • 验证Catalog Attributes Feed, Product Feed, Product Overrides FeedProduct Variant Feed索引器是否设置为Update by Schedule

监测数据同步并排除其故障

要验证数据同步是否正常工作,请确认已成功从Adobe Commerce导出数据,并且数据已成功传递到连接的Commerce服务。 使用部署中的功能板检查这两个步骤。

从导出开始,然后确认投放。

  1. 在Commerce管理员中检查同步状态。

    转到​System > Data Transfer > Data Feed Sync Status

    带有馈送项状态报告的数据馈送同步状态页面 {width="800" modal="regular"}

    同步运行时,馈送数据显示已成功发送的记录。 选择信息源以查看详细信息或解决同步问题。

  2. 确认数据已传送到“连接的Commerce服务”。

    从Commerce管理员转到​System > Data Transfer > Data Management Dashboard

    数据管理功能板显示连接的Commerce服务中已同步的目录数据 {width="700" modal="regular"}

    验证是否显示预期的产品、价格和属性。

TIP
如果数据同步还有其他问题,请参阅查看日志和疑难解答

必要时使用Commerce CLI手动重新同步馈送。 有关重新同步选项和其他故障排除步骤,请参阅​ SaaS Data Export Guide ​中的Manage synchronization

NOTE
如果“数据馈送同步状态”页面在Commerce on Cloud或本地部署的Commerce Admin中不可用,请按照扩展安装说明启用它。
recommendation-more-help
commerce-help-catalog-service