API 认证
晨羽智云API使用API Key进行认证，确保您的账户和资源安全。本指南将详细介绍如何获取、使用和管理API Key。
在线API测试功能: 本文档支持在线API测试！在任何API页面的右侧，您都可以找到API Playground，输入您的API Key后即可直接测试接口，无需编写代码。
获取API Key
1. 登录控制台
访问 晨羽智云控制台 并使用您的账户登录。
2. 创建API Key
进入API管理
在控制台左侧导航栏中，点击”API管理”菜单
重要提醒 - 请妥善保管您的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接口：
访问API页面
导航到任何API接口页面（如”余额查询”、“实例列表”等）
找到API Playground
在页面右侧或底部找到”API Playground”区域
输入API Key
在”Authorization”输入框中输入您的API Key，格式为：Bearer your_api_key
发送请求
点击”Try it”按钮发送请求，查看实时响应结果
测试示例
测试余额查询接口:
- 访问”余额查询”页面
- 在Authorization输入框中输入：
Bearer sk-xxx...
- 点击”Try it”按钮
- 查看返回的余额信息
测试创建实例接口:
- 访问”创建实例”页面
- 输入API Key：
Bearer sk-xxx...
- 填写请求参数（pod_uuid、gpu_uuid等）
- 点击”Try it”发送请求
- 查看实例创建结果
安全提醒: 在公共环境中使用API Playground时，请注意保护您的API Key安全。测试完成后建议清除输入框中的API Key。
安全最佳实践
API Key管理
- 环境变量: 将API Key存储在环境变量中，不要硬编码到代码中
- 密钥管理: 使用专业的密钥管理系统（如AWS KMS、Azure Key Vault）
- 版本控制: 确保API Key不会意外提交到版本控制系统
- 容器化: 在容器环境中使用Secrets管理API Key
# 设置环境变量
export CHENYU_API_KEY="cy_1234567890abcdef1234567890abcdef"
# 在代码中使用
import os
api_key = os.getenv('CHENYU_API_KEY')
安全事件响应
如果发现API Key可能被泄露或滥用，请立即采取以下措施：
立即禁用
在控制台中立即禁用或删除相关的API Key
认证错误处理
常见错误
401 Unauthorized
429 Too Many Requests
错误原因:
- 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"
}
错误原因:解决方案:import time
def api_call_with_retry(func, max_retries=3):
for attempt in range(max_retries):
try:
return func()
except requests.exceptions.HTTPError as e:
if e.response.status_code == 429:
# 从响应头获取重试时间
retry_after = int(e.response.headers.get('Retry-After', 60))
time.sleep(retry_after)
else:
raise
环境配置
开发环境
# 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具有访问您账户资源的权限，请务必妥善保管。如有任何安全疑问，请及时联系技术支持团队。
相关资源