认证
所有请求需在 Header 中携带认证信息:
# Bearer Token(用户操作)
Authorization: Bearer {access_token}
# API Key(子产品服务端集成)
X-Api-Key: {api_key}POST
/api/v1/auth/login公开邮箱密码登录,返回 JWT Access Token 和 Refresh Token。
// 请求体
{ "email": "user@example.com", "password": "YourPassword123" }
// 响应(需 MFA 时返回 mfaToken)
{
"accessToken": "eyJ...",
"refreshToken": "...",
"expiresIn": 1800,
"mfaToken": null
}POST
/api/v1/auth/sso/codeAPI Key子产品服务端获取 SSO Code,用于跳转至平台统一登录。
订阅管理
GET
/api/v1/subscriptions/myBearer查询当前租户的所有订阅(含试用、有效、到期等状态)。
POST
/api/v1/subscriptionsBearer发起订阅(新购或升级),返回关联订单,需跳转支付。
PUT
/api/v1/subscriptions/{id}/auto-renewBearer开启/关闭自动续费。
Webhook 事件
在「运营后台 → 产品详情 → Webhook 配置」中注册推送端点。所有事件使用 HMAC-SHA256 签名(Header:X-Webhook-Signature)。
| 事件类型 | 触发时机 |
|---|---|
subscription.created | 订阅创建成功(新购/试用) |
subscription.renewed | 续费成功(自动或手动) |
subscription.upgraded | 版本升级完成 |
subscription.expired | 订阅到期且未续费 |
subscription.cancelled | 用户主动取消订阅 |
subscription.suspended | 订阅因欠费或异常被暂停 |
tenant.cancelled | 租户完成账号注销(7天冷静期后) |
// Webhook Payload 结构
{
"eventType": "subscription.created",
"occurredAt": "2026-06-05T10:00:00Z",
"data": {
"tenantId": "...",
"subscriptionId": "...",
"planType": "Professional",
"status": "Active"
}
}