身份验证

身份验证

所有 API 请求都需要身份验证。myumbrella.ai 支持两种身份验证方式：用于服务器间调用的 API 密钥和用于面向用户集成的 OAuth 2.0。

API 密钥

在设置 → API 密钥中生成 API 密钥。每个密钥都有特定的权限范围。

在 Authorization 头中包含您的 API 密钥：

curl -X GET https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123def456" \
  -H "Content-Type: application/json"

密钥类型

类型	前缀	使用场景
正式	mu_live_	生产环境 API 调用
测试	mu_test_	沙盒测试（无实际收费）

OAuth 2.0

对于代表商家执行操作的应用，请使用 OAuth 流程：

1. 将商家重定向至：

   https://app.myumbrella.ai/oauth/authorize?client_id=YOUR_ID&redirect_uri=YOUR_URI&scope=plans:read+claims:write

2. 授权后，使用授权码换取访问令牌：

   curl -X POST https://api.myumbrella.ai/oauth/token \
     -d "grant_type=authorization_code" \
     -d "code=AUTH_CODE" \
     -d "client_id=YOUR_ID" \
     -d "client_secret=YOUR_SECRET"

速率限制

• 正式密钥：1,000 次请求/分钟
• 测试密钥：100 次请求/分钟
• 速率限制头：X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset

错误响应

身份验证失败返回 401 状态码：

{
  "error": "unauthorized",
  "message": "Invalid or expired API key"
}