SuperAPI AI 工具集

b2c-custom-api-development

编程与开发

查看项目

更新于 10-16 01:11

技能介绍

用途:指导在 Salesforce B2C Commerce 中开发 Custom API,把自定义脚本以 REST 端点形式暴露在 SCAPI 框架下。自定义 API URL 结构为 https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/{apiVersion}/organizations/{organizationId}/{endpointPath}。

主要能力与结构:创建自定义 API 需要三部分:API 契约(OAS 3.0 的 schema.yaml)、API 实现(使用 B2C Script API 的 script.js)、API 映射(api.json,把端点绑定到实现)。目录结构为 cartridge/rest-apis/{api-name}/,其中 API 目录名只能使用小写字母数字和连字符。契约中 Shopper API 使用 ShopperToken(需 siteId),Admin API 使用 AmOAuth2;自定义作用域以 c_ 开头、最长 25 字符,自定义参数需带 c_ 前缀。实现中导出的函数必须标记 .public = true,用 RESTResponseMgr.createSuccess() 返回成功、createError() 返回 RFC 9457 格式错误。api.json 中 implementation 名称不能带文件扩展名。

使用方式:部署并激活以注册端点,b2c code deploy ./my-cartridge --reload;仅修改已注册端点的 script.js 时可不用 --reload。用 b2c scapi custom status --tenant-id <id> 查看注册状态。cartridge 路径解析:Shopper API 走店铺站点路径,Admin API 视 siteId(真实站点、Sites-Site 或省略)分别走对应站点或 Business Manager 路径,可用 b2c sites cartridges list --bm / add 管理。Admin API 令牌需同时含 SALESFORCE_COMMERCE_API:<tenant_id> 与自定义作用域。

适用场景与限制:适合需要扩展 SCAPI 的开发者。注意平台校验规则、运行限制与安全方案可能随版本变化,编写前应通过 b2c docs search/read 或 MCP 查阅官方文档确认;常见问题包括 404(未注册/路径错误)、403(缺作用域)、503(熔断)。