SuperAPI AI 工具集

b2c-scapi-custom

编程与开发

查看项目

更新于 10-16 01:12

技能介绍

用途:通过 b2c CLI 插件管理 SCAPI 自定义 API 端点并检查其注册状态。若已启用 B2C MCP,注册状态优先用 scapi_custom_apis_get_status,实时契约用 scapi_schemas_list;Admin 自定义 API 执行需先读取 skill://mcp/b2c-mcp-scapi/SKILL.md,并在程序中通过 scapi.request 获取契约后再调用端点。Schema 读取需要 sfcc.scapi-schemas,执行需要声明的 c_* scope,不支持 Shopper 执行。

主要能力:列出配置租户下的全部自定义 API 端点;按状态筛选(如 active、not_registered);按类型(Admin/Shopper)或站点分组;自定义输出列(type、apiName、apiVersion、cartridgeName、endpointPath、httpMethod、status、sites、securityScheme、operationId、schemaFile、implementationScript、errorReason、id);用 --extended 显示扩展列;用 --json 输出便于脚本处理。

使用方式:若未全局安装 b2c,可用 npx @salesforce/b2c-cli 代替,例如 npx @salesforce/b2c-cli scapi custom status。tenantId、shortCode、clientId、clientSecret 会从 dw.json、SFCC_* 环境变量、当前实例或配置插件解析,通常无需传 --client-id/--client-secret/--tenant-id/--short-code,仅在覆盖时使用。可用 b2c setup inspect 查看解析后的配置及来源(--json 用于脚本,密钥默认掩码)。示例:b2c scapi custom status;b2c scapi custom status --status not_registered --columns type,apiName,endpointPath,errorReason。更多命令见 b2c scapi custom --help。

注意:tenant ID 与 organization ID 不同,后者带 f_ecom_ 前缀。沙箱租户 ID 可由主机名将连字符替换为下划线得到,如 zzpq-013.dx.commercecloud.salesforce.com 对应 zzpq_013;生产实例使用 realm 与实例标识(如 zzxy_prd)。status 命令会自动注入所需 scope(sfcc.custom-apis 及 SALESFORCE_COMMERCE_API:<tenant_id>);手动铸造令牌调用自定义 Admin API 时需自行列出租户 scope 与自定义 scope,缺少租户 scope 会返回 403。相关技能:b2c:b2c-custom-api-development、b2c-cli:b2c-code。