API客户端认证指南

认证方式概览

在调用「zh/api-client」相关接口时，需通过以下认证方式确保安全性：

1. OAuth 2.0
   ✅ 推荐使用标准OAuth协议，通过Authorization头携带Bearer Token
   

   

   OAuth_2_0流程图
   
   点击查看完整OAuth认证文档

2. API Key
   ⚠️ 需在请求头添加X-API-Key字段，适用于简单场景
   示例：X-API-Key: your_123_key_here

3. JWT认证
   🔐 通过加密令牌验证身份，需在Authorization头使用Bearer方案
   令牌有效期建议控制在15分钟内

认证流程步骤

1. 获取认证凭证

   • 登录API客户端文档查看凭证申请指南
   • 通过控制台生成密钥或令牌

2. 构建请求头

   GET /v1/resource HTTP/1.1
   Host: api.example.com
   Authorization: Bearer <token>
   X-API-Key: <key>
   

3. 验证响应状态

   • 200 OK：认证成功
   • 401 Unauthorized：凭证错误
   • 429 Too Many Requests：请求频率过高

安全建议

• 🛡️ 始终使用HTTPS协议
• ⏱️ 设置合理的请求频率限制（推荐500次/分钟）
• 📁 在/api-client/auth路径下可查看完整安全策略说明

访问API客户端认证示例获取代码实现参考