API密钥获取与配置

优智AI为每一位用户分配了一个apikey，可以访问优智AI提供的大模型代理服务，用户可以进行充值tokens来使用

API密钥概述

什么是API密钥？

API密钥是一串唯一的字符序列，用于：

• 认证API请求身份
• 跟踪使用量和计费
• 控制访问权限
• 管理安全策略

密钥类型

1. 测试密钥：用于开发和测试，有使用限制
2. 生产密钥：用于正式环境，支持更高限额
3. 只读密钥：仅能读取数据，不能修改
4. 管理员密钥：拥有全部权限

获取API密钥

步骤1：登录控制台

访问 https://uzy-ai.com 并使用您的账户登录。

步骤2：进入API管理

1. 点击左侧菜单"API管理"
2. 选择"API密钥"标签页
3. 点击"创建新密钥"按钮

步骤3：配置密钥

填写密钥配置信息：

• 密钥名称：描述性名称，如"生产环境API密钥"
• 权限范围：选择需要的权限（读取、写入、管理）
• 有效期：设置过期时间（可选）
• IP限制：限制允许调用API的IP地址（可选）
• 使用限额：设置每月最大调用次数（可选）

步骤4：保存密钥

1. 点击"创建"按钮
2. 重要：立即复制并保存密钥
   • API密钥只显示一次
   • 关闭页面后无法再次查看
   • 建议保存到安全的位置

配置API密钥

环境变量配置

推荐使用环境变量存储API密钥：

# Linux/Mac
export YOUZHAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Windows (PowerShell)
$env:YOUZHAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

配置文件

创建配置文件 .env：

YOUZHAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
YOUZHAI_API_BASE=https://api.uzy-ai.com
YOUZHAI_API_VERSION=v1

代码中配置

import os
from youzhiai import Youzhiai

# 从环境变量读取
api_key = os.getenv("YOUZHAI_API_KEY")

# 初始化客户端
client = Youzhiai(api_key=api_key)

使用API密钥

HTTP请求头

在所有API请求的Header中添加：

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

命令行使用

curl -X POST https://api.uzy-ai.com/v1/chat/completions \
  -H "Authorization: Bearer $YOUZHAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

SDK使用

from youzhiai import Youzhiai

client = Youzhiai(api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")

response = client.chat.completions.create(
    model="gpt-3.5-turbo",
    messages=[{"role": "user", "content": "Hello!"}]
)

密钥管理

查看密钥信息

在控制台可以查看：

• 密钥使用统计
• 最近调用记录
• 错误日志
• 费用明细

轮换密钥

安全最佳实践：定期轮换API密钥

1. 创建新密钥
2. 更新应用程序配置
3. 测试新密钥
4. 禁用旧密钥
5. 监控旧密钥的使用情况
6. 确认无问题后删除旧密钥

禁用和删除

• 禁用：临时停止密钥使用，可重新启用
• 删除：永久删除密钥，不可恢复

安全最佳实践

密钥保护

1. 不要硬编码：避免在代码中直接写入密钥
2. 使用密钥管理服务：如AWS Secrets Manager、Azure Key Vault
3. 限制访问权限：按需分配最小权限
4. 监控异常使用：设置告警规则

网络安全

1. 使用HTTPS：确保所有API调用使用加密连接
2. IP白名单：限制可调用API的IP地址
3. 速率限制：防止暴力破解
4. 请求签名：对重要请求进行签名验证

开发环境

1. 使用测试密钥：开发环境使用有限制的测试密钥
2. 分离配置：不同环境使用不同密钥
3. 代码审查：确保密钥不会提交到版本库
4. 自动扫描：使用工具扫描代码中的密钥泄露

故障排除

常见错误

错误401：认证失败

可能原因：

1. API密钥错误或过期
2. 请求头格式不正确
3. IP地址不在白名单内

解决方案：

1. 检查密钥是否正确
2. 确认Bearer前缀和空格
3. 检查IP白名单设置

错误403：权限不足

可能原因：

1. 密钥权限不足
2. 资源访问受限
3. 账户欠费

解决方案：

1. 检查密钥权限设置
2. 确认资源访问权限
3. 检查账户状态

错误429：请求过多

可能原因：

1. 超过速率限制
2. 并发请求过多

解决方案：

1. 降低请求频率
2. 实现指数退避重试
3. 申请提高限额

监控与告警

使用量监控

1. 实时监控：查看当前使用情况
2. 历史统计：分析使用趋势
3. 预测分析：预测未来使用量
4. 成本分析：计算API调用成本

告警设置

1. 使用量告警：接近限额时通知
2. 错误率告警：错误率超过阈值时通知
3. 异常行为告警：检测异常调用模式
4. 费用告警：费用超过预算时通知

相关资源

• API文档
• 安全指南
• 最佳实践
• 技术支持

阅读时间: 8分钟难度等级: 初级最后更新: 2024年1月