mcpField
B
b2c-scapi-admin

b2c-scapi-admin

github.com/salesforcecommercecloud开发5794 次安装今天更新
代码仓库

关于 b2c-scapi-admin

b2c-scapi-admin 是用于构建后端集成和通过标准 Admin API 管理 Commerce 数据的技能。它帮助开发者选择并检查操作、使用已配置的 Account Manager 认证，并审慎处理结果。

主要功能

  1. 01搜索内置 Admin API 合约
  2. 02检查操作参数与安全范围
  3. 03执行受支持的 Admin JSON 操作
  4. 04列出租户实时架构
  5. 05指导安全写入与精简结果

适用场景

  1. 01使用 Commerce API 构建后端集成
  2. 02通过 Admin API 管理 Commerce 数据
  3. 03操作前检查租户专属架构

MCP 相关

有 B2C MCP 时，该技能指导使用 `scapi_search`、`scapi_execute` 和 `scapi_schemas_list` 等工具；必要时也说明如何读取 MCP 技能资源。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/salesforcecommercecloud/b2c-developer-tooling --skill b2c-scapi-admin

安装后在 Claude Code 中输入/b2c-scapi-admin确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

evals/
trigger-evals.json
references/
CLIENT-EXAMPLES.md
INTEGRATION-PATTERNS.md
OAUTH-SCOPES.md

详细介绍

SCAPI 管理 API

通过标准管理 API 构建后端集成，或管理 Commerce 数据。 店面流程请使用 b2c-scapi-shopper 技能。

工具选择

B2C MCP 可用时：

  • 优先使用专用任务工具。否则，通过资源或 skills_read 读取一次 skill://mcp/b2c-mcp-scapi/SKILL.md，然后使用 skillRead: true。
  • scapi_search：包含标准契约，无需联网。查找方法、路径或 operationId， 然后检查选定的参数、字段和安全范围。返回精简结果。
  • scapi_execute：执行受支持的 Admin JSON 操作，使用已配置的 Account Manager 身份验证和自动操作／租户范围。使用带掩码的 config_inspect； 不要为这些调用手动获取或打印令牌。
  • scapi_schemas_list：获取实时租户架构，包括自定义属性和 API。 scapi_custom_apis_get_status：检查自定义注册状态。代码模式不支持自定义执行和二进制 传输；请使用适当的集成客户端。
  • docs_search／docs_read：查询平台语义、限制和身份验证设置。仅为重复已发现的契约， 无需重复查阅文档。

对于 CLI／集成开发：b2c scapi schemas list 和 b2c scapi schemas get <family> <name> <version> 可获取实时契约。 仅在实现外部客户端、令牌流程或批量导入时阅读集成示例。 CLI 没有对应的代码模式。

谨慎执行

  • 使用已配置的 short code、租户和站点值。Admin 身份验证需要 Account Manager 客户端、API 授权，以及 SALESFORCE_COMMERCE_API:<tenant_id>。 SLAS 凭据不能替代 Admin 凭据。
  • 使用前检查操作；示例仅供参考。对于租户专属字段，请使用实时架构。查看官方文档以了解特定版本的语义。
  • 区分创建和更新；PUT 可能同时执行这两种操作。先验证资源是否存在及操作意图， 然后读取有意义的字段以确认结果。重试失败操作前，先检查之前的写入。
  • 在 API 端进行分页和筛选，并返回 ID、选定字段、totals/hasMore 和错误。 不要输出完整响应树或记录凭据。
  • 安全规则基于 HTTP 方法：POST 搜索可能需要有针对性的允许规则。 需要确认的代码模式请求会停止；不要绕过确认。

按需参考

  • OAuth 范围：集成授权；与操作的安全要求进行对照。
  • 集成模式：ETL、同步、批量导入。
  • b2c-config 技能：CLI 凭据及优先级。
  • 官方文档：commerce-api/authorization-for-admin-apis、commerce-api/auth-z-scope-catalog、 commerce-api/timeouts-limits、commerce-api/throttle-rates、 commerce-api/inventory-impex-best-practices。

评论

支持 Markdown