用途
Saleor App 是一份面向 Saleor 电商平台应用开发的指南,目标是帮助开发者用统一的方式构建通过 webhook 和 GraphQL API 扩展 Saleor 的应用。文档以框架无关的协议说明为主,并给出使用 @saleor/app-sdk 的 Next.js 示例。
主要能力
指南按优先级组织为七类规则:
- 协议(CRITICAL):protocol-manifest 说明应用 manifest、必需端点、权限与扩展;protocol-auth 覆盖注册握手、APL、token 作用域、JWT 与签名校验。
- 权限(CRITICAL):permissions-access-scopes 指导按功能定义权限,在每个 API 路由上校验用户 JWT,采用基线加路由级 meta 的方式,并让 UI 与服务端保持一致。
- 支付应用(CRITICAL):payment-app 涉及财务准确性、稳定引用、未知结果、退款与对账。
- Webhook(HIGH):webhook-async 处理异步事件、载荷类型、重试策略与签名校验;webhook-sync 处理同步事件、响应结构与性能约束;webhook-external 处理接收外部服务 webhook 与多租户路由。
- 数据与设置(HIGH):data-graphql 说明应用内 GraphQL 客户端配置、认证头、代码生成以及应用 token 与用户 token 的区别;data-settings 介绍 MetadataManager、EncryptedMetadataManager 与按域范围的持久化。
- Dashboard UI(MEDIUM):dashboard-appbridge 介绍 AppBridge iframe 协议、动作、事件以及主题和语言同步。
- 开发调试(MEDIUM):dev-debug 汇总常见错误、webhook 试运行、隧道配置与调试清单。
使用方式
文档按主题给出适用场景清单,例如:定义应用 manifest 或注册 webhook、处理来自 Saleor 的同步/异步 webhook 事件、用 Transaction API 和支付服务商 webhook 构建支付应用、处理认证请求(注册握手、JWT、签名校验)、在 Saleor metadata 中保存应用设置、在 iframe 内构建 Dashboard UI、使用应用 token 发起 GraphQL 调用、调试 webhook 失败/认证错误/权限问题,以及决定谁能查看应用及其可见内容(用户范围与应用范围)。
适用场景
适合开发 Saleor 应用、支付集成、webhook 处理与 Dashboard 嵌入界面的开发者,也适合排查认证、权限与 webhook 相关问题。
限制
资料未提供具体安装命令、代码示例细节、版本兼容要求以及收费信息。