SuperAPI AI 工具集

using-b2c-tooling-sdk

编程与开发

查看项目

更新于 10-16 08:44

技能介绍

用途:介绍如何消费 salesforce-b2c-tooling-sdk 这个 Python SDK。导入名为 b2c_tooling_sdk,发行名为 salesforce-b2c-tooling-sdk;异步优先,并提供完整同步外观,要求 Python 3.10+。开发 SDK 本身另见 python/b2c-tooling-sdk/CLAUDE.md,完整符号目录见 references/api-catalog.md。

安装:尚未上 PyPI,开发期从 git 安装:pip install "git+https://github.com/SalesforceCommerceCloud/b2c-developer-tooling.git@main#subdirectory=python/b2c-tooling-sdk",也可固定发布标签。Notebook 另装 pip install ipykernel。正式发布后为 pip install salesforce-b2c-tooling-sdk。

同步与异步:脚本、notebook、REPL 从 b2c_tooling_sdk.sync 导入,阻塞、无需 await;已在事件循环内(Web 服务、异步应用)从 b2c_tooling_sdk 导入并 await。不要在运行中的事件循环里调用同步外观,可能死锁。流式 API(tail_logs、cartridge watching)仅异步提供。

认证:有 dw.json 时优先 resolve_config() + create_b2c_instance(),自动选择认证机制。也可显式选择:OAuth 客户端凭据、JWT Bearer、PKCE 交互登录、共享会话存储、Basic、API key;SLAS 用于店面购物者令牌。SDK 与 @salesforce/b2c-cli 共享磁盘上的 auth-sessions.json,可先跑 b2c auth login <clientId>,再运行非交互 Python 复用会话。不确定凭据支持哪些方法时用 resolve_auth_strategy 或 check_available_auth_methods。

配置:resolve_config() 合并 CLI 同源配置(从 cwd 向上查找 dw.json、~/.mobify、package.json、settings.json),create_b2c_instance() 构建已认证实例;也可传 NormalizedConfig 覆盖。多环境 dw.json(configs 数组)用 ResolveConfigOptions(instance="staging") 选择,优先级为指定名、active: true、root。

API 分层:operations(b2c_tooling_sdk.operations.)面向任务、失败抛类型化异常,推荐多数场景;clients(instance.ocapi、instance.webdav、SCAPI create__client)为低层,返回 ClientResult(data, error, response),4xx/5xx 不抛异常。能力覆盖代码部署、作业、站点、目录/BM 用户/角色、ODS 沙箱、指标、日志、Account Manager 与原始 HTTP。SCAPI Admin 客户端需系统认证与 short_code、tenant_id。

SLAS:仅子路径导入,不在顶层。get_guest_token(SlasTokenConfig(...)) 获取购物者 JWT,get_registered_token 用于登录客户;同步版本在 b2c_tooling_sdk.sync。工具 SDK 没有专用店面客户端,获得令牌后用 httpx 携带 bearer 调用 Shopper 端点。运行示例见 python/samples/ 下的脚本与 notebook,复制 dw.example.json 为 dw.json 并填入凭据。