API 参考

ShopFaaS REST API 与 Webhook 事件参考，供第三方集成与应用扩展开发使用。

ShopFaaS 提供两种对外 API 体系，供第三方集成与应用扩展开发使用：

API 类型	用途	路径	认证
REST API	第三方集成、外部系统对接	`/api/*`	API Key 或 JWT Bearer Token
Webhook	应用扩展接收店铺事件推送	应用配置的 URL	HMAC-SHA256 签名

统一响应格式

所有 REST API 返回统一响应体：

{
  code: string,    // "ok" 表示成功，其他字符串表示失败
  msg: string,     // 中文消息
  data?: T         // 成功时的数据
}

约定：code === "ok" 表示成功，任何其他字符串均表示失败。

店长在「设置 → 应用 → API 密钥」创建 API Key：

curl -X GET https://your-store.com/api/products \
  -H "X-ShopFaaS-API-Key: your-api-key"

在应用扩展的 plugin.json 中声明订阅的事件，ShopFaaS 会将事件推送到应用配置的 URL。

X-ShopFaaS-API-Key: <app-api-key>

API Key 由店长在后台创建，关联店铺与权限范围。适用于：

Authorization: Bearer <jwt-token>

JWT Token 通过登录接口获取，适用于：

REST API 端点清单、认证与调用示例。

Webhook 事件类型、签名验证与重试机制。

内部业务 API（贡献者参考）。