​
API 认证

晨羽智云API使用API Key进行认证，确保您的账户和资源安全。本指南将详细介绍如何获取、使用和管理API Key。
在线API测试功能: 本文档支持在线API测试！在任何API页面的右侧，您都可以找到API Playground，输入您的API Key后即可直接测试接口，无需编写代码。

​
获取API Key

​
1. 登录控制台

访问 晨羽智云控制台 并使用您的账户登录。

​
2. 创建API Key

1

进入API管理

在控制台左侧导航栏中，点击”API管理”菜单
2

创建新密钥

点击”创建API Key”按钮
3

配置权限

根据需要设置API Key的权限范围
4

保存密钥

复制生成的API Key并妥善保存
重要提醒 - 请妥善保管您的API Key，切勿泄露。

​
使用API Key

​
认证方式

在所有API请求中，需要在HTTP头中包含认证信息： 
Authorization: Bearer YOUR_API_KEY

​
完整请求示例

curl -X GET "https://www.chenyu.cn/api/open/v2/balance/info" \
  -H "Authorization: Bearer cy_1234567890abcdef1234567890abcdef" \
  -H "Content-Type: application/json"

​
在线API测试

​
使用API Playground

本文档集成了强大的API Playground功能，让您无需编写代码即可测试所有API接口：
1

访问API页面

导航到任何API接口页面（如”余额查询”、“实例列表”等）
2

找到API Playground

在页面右侧或底部找到”API Playground”区域
3

输入API Key

在”Authorization”输入框中输入您的API Key，格式为：Bearer your_api_key
4

设置参数

根据需要填写查询参数或请求体参数
5

发送请求

点击”Try it”按钮发送请求，查看实时响应结果

​
测试示例

测试余额查询接口:
  1. 访问”余额查询”页面
  2. 在Authorization输入框中输入：Bearer sk-xxx...
  3. 点击”Try it”按钮
  4. 查看返回的余额信息
安全提醒: 在公共环境中使用API Playground时，请注意保护您的API Key安全。测试完成后建议清除输入框中的API Key。

​
安全最佳实践

​
API Key管理

​
安全事件响应

如果发现API Key可能被泄露或滥用，请立即采取以下措施：
1

立即禁用

在控制台中立即禁用或删除相关的API Key
2

创建新密钥

创建新的API Key，并更新应用配置
3

联系支持

如有必要，联系技术支持团队进行进一步调查

​
认证错误处理

​
常见错误

错误原因:
  • API Key无效或已过期
  • 请求头格式错误
  • API Key被禁用
解决方案:
# 检查API Key格式
if not api_key.startswith('cy_'):
    raise ValueError("Invalid API key format")

# 检查请求头
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

​
环境配置

​
开发环境

# development.py
import os
from dotenv import load_dotenv

load_dotenv()

CHENYU_API_KEY = os.getenv('CHENYU_API_KEY_DEV')
CHENYU_BASE_URL = 'https://www.chenyu.cn/api/open/v2'

​
生产环境

# production.py
import os

# 从环境变量或密钥管理系统获取
CHENYU_API_KEY = os.getenv('CHENYU_API_KEY_PROD')
CHENYU_BASE_URL = 'https://www.chenyu.cn/api/open/v2'

# 生产环境额外配置
TIMEOUT = 30
MAX_RETRIES = 3

​
测试API Key

创建API Key后，可以使用以下命令测试其是否正常工作： 
# 测试API Key是否有效
curl -X GET "https://www.chenyu.cn/api/open/v2/balance/info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
成功响应示例： 
{
  "code": 0,
  "msg": "查询成功",
  "data": {
    "balance": 1000.50,
    "card_balance": 500.00
  }
}
安全提醒 - API Key具有访问您账户资源的权限，请务必妥善保管。如有任何安全疑问，请及时联系技术支持团队。

​
相关资源