关于 saleor-app
saleor-app 是用于构建 Saleor 扩展应用的开发指南,适合处理 API、Webhook、支付流程和 Dashboard 界面的开发者。它按协议、权限、支付等优先级组织规则,并提供 Next.js 示例背景。
主要功能
- 01应用清单与注册流程规则
- 02同步和异步 Webhook 处理
- 03支付应用与 Transaction API 指引
- 04GraphQL 认证与数据设置
- 05Dashboard iframe 界面规则
- 06权限范围与访问控制
适用场景
- 01定义应用清单并注册 Webhook
- 02实现 Saleor 支付应用
- 03排查 Webhook 或认证错误
- 04在 Dashboard iframe 中构建应用界面
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ saleor/ agent-skills --skill saleor-app安装后在 Claude Code 中输入/saleor-app确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdreferences/apl-implementations.mdapp-manifest-schema.mdrules/dashboard-appbridge.mddata-graphql.mddata-settings.mddev-debug.mdpayment-app.mdpermissions-access-scopes.mdprotocol-auth.mdprotocol-manifest.mdwebhook-async.mdwebhook-external.mdwebhook-sync.md详细介绍
Saleor 应用
通过 Webhook 和 GraphQL API 扩展 Saleor 的应用构建指南。
与框架无关的协议文档,包含使用 @saleor/app-sdk 的 Next.js 示例。
适用场景
- 定义应用清单或注册 Webhook
- 处理来自 Saleor 的异步/同步 Webhook 事件
- 使用 Transaction API 和服务提供商 Webhook 构建支付应用
- 对请求进行身份验证(注册握手、JWT、签名验证)
- 将应用设置存储在 Saleor 元数据中
- 在 iframe 内构建 Dashboard UI
- 使用应用令牌发起 GraphQL 调用
- 排查 Webhook 失败、身份验证错误或权限问题
- 决定谁可以查看应用以及他们应该看到什么(用户范围与应用范围)
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 协议 | 严重 | protocol- |
| 2 | 权限 | 严重 | permissions- |
| 3 | 支付应用 | 高 | payment- |
| 4 | Webhook | 高 | webhook- |
| 5 | 数据与设置 | 高 | data- |
| 6 | Dashboard UI | 中 | dashboard- |
| 7 | 开发 | 中 | dev- |
快速参考
1. 协议(严重)
protocol-manifest— 应用清单、必需端点、权限、扩展protocol-auth— 注册握手、APL、令牌作用域、JWT/签名验证
2. 权限(严重)
permissions-access-scopes— 为每项功能定义权限;在每个 API 路由上验证用户 JWT;基线与逐路由元数据;UI 与服务器端保持一致
3. 支付应用(严重)
payment-app— 财务事实、稳定引用、未知结果、退款和对账
4. Webhook(高)
webhook-async— 异步事件处理、载荷类型、重试策略、签名验证webhook-sync— 同步事件处理、响应模式、性能限制webhook-external— 接收来自外部服务的 Webhook、多租户路由
5. 数据与设置(高)
data-graphql— 应用中的 GraphQL:客户端设置、身份验证标头、代码生成、应用令牌与用户令牌data-settings— MetadataManager、EncryptedMetadataManager、按域范围持久化
6. Dashboard UI(中)
dashboard-appbridge— AppBridge iframe 协议、操作、事件、主题/区域设置同步
7. 开发(中)
dev-debug— 常见错误、Webhook 演练、隧道设置、调试清单
评论
支持 Markdown