SuperAPI AI 工具集

marketplace-add-xmc

编程与开发

查看项目

更新于 10-16 01:58

技能介绍

用途

该技能帮助用户为 Sitecore Marketplace 应用添加 XM Cloud API 集成。当用户希望访问 Sites、Pages、Authoring、Content Transfer、Search 或 Agent 等 XM Cloud API 时,可使用本技能。

前置条件

必须先安装 XMC 包。如果尚未安装,执行以下命令:

npx shadcn@latest add https://marketplace-sdk.sitecorecloud.io/r/xmc.json

主要能力

技能覆盖以下 XM Cloud API 及其命名空间:

  • Sites:命名空间 xmc.sites.*,用于列出/获取站点、当前站点上下文。
  • Pages:命名空间 xmc.pages.*,用于列出/获取页面、当前页面上下文。
  • Authoring:命名空间 xmc.authoring.*,用于针对 authoring API 执行 GraphQL 查询/变更。
  • Content Transfer:命名空间 xmc.contentTransfer.*,用于导入/导出内容。
  • Search:命名空间 xmc.search.*,用于搜索内容项。
  • Agent:命名空间 xmc.agent.*,用于调用 XM Cloud agents。

使用方式

第一步:确定需要哪个 API。技能会询问用户(或从 $ARGUMENTS 推断)所需的 XMC API,对应上表选择。

第二步:选择客户端或服务端调用方式。

  • 客户端:使用 client.query() / client.mutate(),更简单,适用于任何架构。
  • 服务端:使用 experimental_createXMCClient(),需要 Auth0(全栈架构)。

第三步:实现。参考 xmc-patterns.md 中每个 API 的完整代码模式。

第四步:建议相关技能。可使用 /marketplace-build-component 为数据构建 UI;可使用 /marketplace-sdk-reference 获取详细类型信息。

参考文件

XMC Patterns — 每个 XMC API 的代码模式。

适用场景

适用于需要在 Sitecore Marketplace 应用中集成 XM Cloud API 的开发者,例如需要读取站点或页面上下文、执行 authoring GraphQL 操作、导入导出内容、搜索内容项或调用 XM Cloud agents 的场景。

限制

使用服务端方式需要 Auth0,且属于全栈架构。其他限制暂未提供。