快速开始
如何获取 OfApp.cn API Key
这篇快速开始说明如何获取 OfApp.cn API Key、安全保存到环境变量或 Secret,并用最小请求验证后再接入工具和项目。
API Key 是你使用 OfApp.cn 的凭证。普通用户可以把它填进天才游乐场或 AI 客 户端,开发者可以把它放进终端、服务端环境变量、Codex CLI 或项目 Secret 里。它的作用不是“选择模型”,也不是“决定请求地址”,而是告诉服务端“这次请 求是谁发起的”。
本文只讲一件事:怎样拿到 OfApp.cn API Key、怎样安全保存、怎样确认它真的 可用。具体模型、能力、价格、套餐、额度和倍率请以 OfApp.cn 控制台或官方文 档为准。
| 项目 | 内容 |
|---|---|
| 适合人群 | 刚开始使用 OfApp.cn 的普通用户、Codex 用户、AI 客户端用户、开发者和团队管理员 |
| 阅读时间 | 约 8 分钟 |
| 核心问题 | API Key 从哪里获取、放在哪里、如何验证、泄露后怎么处理 |
| 你会得到 | Key 使用流程、环境变量模板、Secret 管理建议、最小验证命令和泄露处理清单 |
| 边界提醒 | 本文不列具体模型、价格、套餐或额度;相关信息请以 OfApp.cn 控制台或官方文档为准 |
| 读者 | 你现在可能遇到什么 | 读完能做什么 |
|---|---|---|
| AI 初学者 | 不知道 Key、Base URL、模型名分别是什么 | 知道三者的分工和最小验证顺序 |
| 办公和创作者 | 想用天才游乐场聊天、读文件、生图 | 获取 Key 后先在网页入口试用 |
| 开发者 | 想把 API 接进脚本、SDK 或服务端 | 把 Key 放到环境变量和部署 Secret |
| Codex 用户 | 想让 Codex CLI 使用 OfApp.cn | 准备 OPENAI_API_KEY 和 Base URL |
| 团队管理员 | 多人共用项目,需要避免泄露 | 建立 .env.example、权限和轮换规则 |
如果你还没有想好具体要接哪个工具,也可以先读完本文,只完成“创建 Key + 安 全保存 + 最小验证”三步。
先分清三件事
Section titled “先分清三件事”很多接入问题来自把 API Key、Base URL 和模型名混在一起看。先把它们分开, 后面的排错会轻松很多。
| 配置 | 作用 | 常见错误 |
|---|---|---|
| API Key | 证明调用者身份 | 写进前端、日志、截图或公开仓库 |
| Base URL | 决定请求发往哪个入口 | 漏写 /v1,或重复拼接 /v1/v1 |
| 模型名 | 决定调用哪个模型 | 凭旧截图猜模型,或使用当前账号不可用模型 |
本站示例使用占位 Key sk-xxxx。真实 Key 只从 OfApp.cn 控制台复制,不放进
教程、README、截图、聊天记录或公开日志。
这条流程适合个人,也适合团队。个人先保证不泄露,团队还要保证谁创建、谁保 管、谁轮换都清楚。
- 打开 OfApp.cn。
- 登录或注册账号。
- 进入控制台中创建或复制 API Key。
- 把 Key 保存到本地环境变量、Secret 管理或客户端密钥输入框。
- 不要把真实 Key 写进项目文件、公开聊天、截图或教程。
- 用最小请求验证 Key、Base URL 和模型名是否能配合工作。
如果你只是想先体验聊天、写作、读文件或生图,可以创建 Key 后进入天才游乐 场。等你需要 Codex、SDK、AI 客户端或自动化脚本时,再回来配置 Base URL。
环境变量模板
Section titled “环境变量模板”终端里可以先用环境变量保存。下面的 Key 是占位符,不是真实密钥。
export OPENAI_API_KEY="sk-xxxx"export OPENAI_BASE_URL="https://api.ofapp.cn/v1"export OPENAI_MODEL="以控制台可用模型为准"检查变量是否存在时,只打印长度,不打印完整 Key。
echo "key length: ${#OPENAI_API_KEY}"如果你使用 .env 文件,建议提交 .env.example,不要提交真实 .env。
OPENAI_API_KEY=sk-xxxxOPENAI_BASE_URL=https://api.ofapp.cn/v1OPENAI_MODEL=以控制台可用模型为准放到哪里更安全
Section titled “放到哪里更安全”| 场景 | 推荐保存位置 | 不要这样做 |
|---|---|---|
| 本地终端 | shell 环境变量、.env.local |
把真实 Key 写进 README |
| Node.js / Python 服务 | 服务端环境变量、密钥管理系统 | 在浏览器组件中直接调用 API |
| Vercel / Netlify | Project Environment Variables | 写进前端公开变量 |
| GitHub Actions | GitHub Secrets | 打印完整 Authorization |
| Docker | Compose Secret、运行时 -e |
写进 Dockerfile 镜像层 |
| AI 客户端 | 客户端的密钥输入框 | 把 Key 发给别人代填 |
前端网页里的 JavaScript 会被用户看到,所以 API Key 不应该进入浏览器包。前 端需要使用 AI 能力时,应请求你自己的后端,由后端读取 Key。
API Key 使用场景矩阵
Section titled “API Key 使用场景矩阵”同一把 Key 可以出现在不同工具链里,但保存位置、验证方式和泄露风险不一样。 下面这张矩阵适合用作个人配置清单,也适合放进团队接入规范。
| 场景 | Key 放在哪里 | 不要放在哪里 | 验证方式 |
|---|---|---|---|
| 本地 cURL 验证 | 当前 shell 环境变量 | 命令历史中的真实 Key、截图、聊天记录 | curl "$OPENAI_BASE_URL/models" 返回可读结果 |
| Node.js / Python 服务端 | 服务器环境变量或 Secret 管理 | 前端包、浏览器 LocalStorage、公开仓库 | 服务端 smoke test 能读取变量并完成请求 |
| Codex / CLI 工具 | 本机安全配置或环境变量 | README、日志、终端录屏 | 最小任务能读取 OPENAI_API_KEY 和 Base URL |
| CI/CD | 平台 Secret | workflow 明文、构建产物 | CI 只打印脱敏状态并完成 smoke test |
| 团队网关 | 后端 Secret、租户权限和用量记录 | 共享文档明文、群聊、工单截图 | 日志脱敏、权限边界和用量异常都可追踪 |
获取 Key 后,不要直接接复杂业务。先用最小请求验证配置链路。
curl "$OPENAI_BASE_URL/models" \ -H "Authorization: Bearer $OPENAI_API_KEY"这个请求的目标是确认三件事:
| 检查点 | 通过后说明什么 |
|---|---|
| Key 不为空 | 终端或运行环境读到了变量 |
| Base URL 正确 | 请求到了 OfApp.cn 当前 API 入口 |
| Bearer 鉴权通过 | Key 和入口来自同一套配置 |
如果你的工具不支持 /models,可以使用 OfApp.cn 官方文档里当前推荐的最小
示例。验证成功后,再接 OpenAI-compatible API 快速开始、
OpenAI SDK 或 Codex CLI。
接入工具时怎么填
Section titled “接入工具时怎么填”不同工具的字段名称不一样,但核心仍然是 Key、Base URL 和模型名。
| 工具类型 | 重点确认 |
|---|---|
| 天才游乐场 | Key 是否保存,聊天、读文件、生图是否能从网页入口开始 |
| Codex CLI | 是否读取 OPENAI_API_KEY,Base URL 是否指向 OfApp.cn |
| OpenAI SDK | apiKey / api_key 是否来自环境变量,Base URL 是否配置 |
| AI 客户端 | 是否会自动追加 /v1,模型名是否从控制台复制 |
| Claude 兼容生态 | 使用的是 OpenAI 风格入口,还是 Messages 兼容入口 |
不要用一个工具的配置界面去猜另一个工具。遇到不确定的客户端,先看它的文档 或用最小请求确认最终 URL。
团队协作建议
Section titled “团队协作建议”团队使用 API Key 时,重点不是“大家都能拿到”,而是“最少的人能接触真实 Key”。
| 做法 | 为什么 |
|---|---|
| 每个环境单独配置 Key | 测试、预览、生产互不影响 |
提交 .env.example |
新成员知道变量名,但看不到真实 Key |
| 用 Secret 管理生产 Key | 避免 Key 出现在仓库和镜像里 |
| 日志默认脱敏 | 排错时不会把 Bearer Token 打出去 |
| 离职或泄露时轮换 | 减少旧 Key 长期有效带来的风险 |
如果某个脚本、插件或同事需要 Key,先问清它是否真的需要完整 Key。很多时候 只需要变量名、Base URL 或脱敏后的错误日志。
泄露后处理清单
Section titled “泄露后处理清单”只要真实 Key 出现在公开仓库、聊天记录、截图、日志平台或前端包里,就应按 泄露处理。
- 立即撤销或轮换对应 Key。
- 更新本地、部署平台、客户端和定时任务中的新 Key。
- 检查 Git 历史、CI 日志、错误上报和截图。
- 用最小请求确认新 Key 可用。
- 记录泄露原因,补上
.gitignore、Secret 管理和日志脱敏。
不要只删除那一行日志就结束。别人可能已经看到或复制了旧 Key。
| 现象 | 常见原因 | 去哪里排查 |
|---|---|---|
| 401 Unauthorized | Key 缺失、复制错误、Bearer 头错误 | 401 Unauthorized |
| invalid API key | Key 和 Base URL 不匹配,或运行时读到旧 Key | invalid API key |
| 404 Not Found | Base URL 缺少 /v1 或重复拼接 |
如何配置 Base URL |
| model not found | 模型名不可用或写错 | model not found |
| 本地成功线上失败 | 部署 Secret 没配置或没重新部署 | 常见错误排查 |
排错顺序很重要:先验证 Key 和 Base URL,再看模型名、SDK、业务参数和网络。
API Key 从哪里获取?
Section titled “API Key 从哪里获取?”从 OfApp.cn 控制台创建或复制。普通用户可以创建 Key 后先进入天才游乐场;进 阶用户再把 Key 配置到 Codex、AI 客户端、OpenAI SDK 或自己的项目中。
可以把 API Key 给 Codex 看吗?
Section titled “可以把 API Key 给 Codex 看吗?”通常不需要。Codex 只需要知道环境变量名称,例如 OPENAI_API_KEY。真实 Key
应由你在本地终端、配置文件或系统凭证里保存,不写进提示词和项目文件。
API Key 可以放在前端吗?
Section titled “API Key 可以放在前端吗?”不可以。前端代码会暴露给用户。前端页面需要调用 AI 能力时,应通过自己的后 端接口,由后端读取 Key 并完成鉴权、限流和日志脱敏。
一把 Key 可以用于多个工具吗?
Section titled “一把 Key 可以用于多个工具吗?”OfApp.cn 官方页面强调同一把 Key 可用于网页、Codex、AI 客户端和项目代码等 场景。实际模型、能力、价格和额度请以 OfApp.cn 控制台或官方文档为准。
Key 失效怎么办?
Section titled “Key 失效怎么办?”先确认复制时没有多余空格、环境变量实际生效、Base URL 和 Key 来自同一服务 商。仍失败时,用最小 cURL 请求复现,并查看 invalid API key。
.env.example 可以提交吗?
Section titled “.env.example 可以提交吗?”可以,但里面只能放变量名和占位值,例如 OPENAI_API_KEY=sk-xxxx。真实
.env 应写进 .gitignore,不要提交到仓库。
截图里不小心露出 Key 怎么办?
Section titled “截图里不小心露出 Key 怎么办?”按泄露处理:立即撤销或轮换 Key,删除公开截图,检查聊天记录、文档和日志平 台,并更新所有正在使用旧 Key 的环境。
- OfApp.cn 官网:核对 OfApp.cn 面向 OpenAI、Codex、AI 客户端和天才游乐场的入口说明。
- OfApp.cn 官方文档:核对 Base URL、API Key、Bearer 鉴权和
/v1入口相关信息。 - 天才游乐场:核对普通用户从网页入口体验聊天、图片和模型能力的上下文。
- OpenAI API 认证文档:参考 API Key、Bearer 鉴权、环境变量和服务端密钥保护原则。
- OpenAI API 生产最佳实践:参考不要在代码或公开仓库暴露 Key、使用环境变量或密钥管理服务的建议。
- 如何配置 Base URL:继续配置统一 API 入口。
- OpenAI-compatible API 快速开始:用最小请求验证。
- 如何用 OpenAI SDK 接入:把 Key 放进服务端 SDK。
- Codex CLI 快速接入 OfApp.cn:让 Codex 读取 OfApp.cn 配置。
- 常见错误排查:处理 Key、Base URL 和模型名问题。
- invalid API key:排查密钥无效和环境变量问题。
- 401 Unauthorized:排查鉴权失败。
OfApp.cn API Key 是身份凭证,不是模型名,也不是 Base URL。先从控制台获取, 再保存到环境变量、Secret 或客户端密钥框,用最小请求验证,再接 Codex、SDK、 AI 客户端或业务项目。真实 Key 不进前端、仓库、日志、截图和聊天记录; 无法确认是否泄露时,直接轮换。