跳转到主要内容

​
认证

所有 API 请求必须使用支持的方法进行认证。这确保了对您账户数据的安全访问，并防止未经授权的使用。

​
认证方法

​
API 密钥认证

最简单的方法是使用 API 密钥。将 API 密钥包含在请求头中： 
Authorization: Bearer YOUR_API_KEY
示例： 
GET /api/users
Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

​
OAuth 2.0

对于更高级的集成，使用 OAuth 2.0：
  1. 获取访问令牌：使用 OAuth 流程获取访问令牌
  2. 包含在请求中：将令牌添加到 Authorization 头中
  3. 刷新令牌：根据需要处理令牌过期
示例： 
POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

​
基本认证

对于测试目的，支持基本认证： 
Authorization: Basic BASE64_ENCODED_CREDENTIALS
其中 BASE64_ENCODED_CREDENTIALS 是 username:password 的 base64 编码。

​
安全最佳实践

  • 安全存储密钥：切勿在客户端代码中公开或记录 API 密钥
  • 使用 HTTPS：始终通过 HTTPS 发送请求
  • 定期轮换密钥：定期更改 API 密钥以确保安全
  • 监控使用情况：跟踪 API 密钥使用情况以检测异常

​
错误响应

如果认证失败，API 将返回： 
{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}