ohmygpt-logoOhMyGPT Cookbook

设置 API 密钥

以编程方式管理 API 密钥

OhMyGPT 提供了一系列管理 API 接口,让您能够以编程方式创建和管理 API 密钥,支持需要自动分发或轮换密钥的应用场景。

创建管理员 API 密钥

要使用密钥管理 API,您首先需要创建一个具有管理员权限的 API 密钥:

  1. 登录您的 OhMyGPT 账户
  2. 前往 API 密钥管理页面
  3. 创建一个拥有管理员权限的新密钥

请注意,出于安全考虑,我们不允许通过 API 创建或修改其他 API 密钥的管理员权限。

使用场景

编程式密钥管理的常见场景包括:

  • SaaS 应用:为每个客户实例自动创建唯一的 API 密钥
  • 密钥轮换:定期轮换 API 密钥以符合安全合规要求
  • 用量监控:追踪密钥使用情况,并自动禁用超出限制的密钥

示例用法

所有密钥管理接口都需要在请求头中包含管理员 API 密钥作为 Bearer 令牌。

import requests
 
# 管理员API密钥(具备管理权限)
ADMIN_API_KEY = "your-admin-api-key"
BASE_URL = "https://api.ohmygpt.com"
 
# 获取所有API Key
response = requests.post(
    f"{BASE_URL}/api/v1/user/admin/get-api-tokens",
    headers={
        "Authorization": f"Bearer {ADMIN_API_KEY}",
        "Content-Type": "application/x-www-form-urlencoded"
    }
)

使用注意事项

  1. 密钥限制:每个用户最多可创建 5000 个 API 密钥,超出则会报错
  2. 管理员权限:出于安全考虑,不允许通过 API 创建或修改其他 API 密钥的管理员权限
  3. 请求限制
    • 创建/修改/删除密钥:10 QPS
    • 查询所有密钥:1 QPS
  4. 安全建议
    • 定期轮换 API 密钥
    • 为不同的应用或服务使用不同的 API 密钥
    • 设置适当的使用限额,防止异常消耗

目录