快速开始
本指南带你走完接入 小关API 的最短路径:注册账号 → 登录控制台 → 充值额度 → 创建 API 令牌 → 发起第一次请求。
阅读建议
第一次接入时,建议按顺序完成下面五步,再开始正式调用:
注册账号 → 登录控制台 → 充值额度 → 创建 API 令牌 → 发起第一次请求
已能正常调用后,再按你使用的客户端阅读对应的接入教程(Claude Code、Codex 等)。
直接看 小白教程 —— 用 Cherry Studio 或 Chatbox 图形界面点几下就能用上。
十分钟跑通全链路
这是最短路径,按顺序做完就能用上:
| # | 步骤 | 完成标志 |
|---|---|---|
| 01 | 准备客户端 —— 装 Codex + CC-Switch | 两个软件都能打开 |
| 02 | 登录控制台 —— 注册 / 进入用户台 | 能看到数据看板 |
| 03 | 创建 API Key —— 命名并立即保存 | 令牌列表里有你的 key |
| 04 | 导入 CC-Switch —— 一键导入 Provider | CC-Switch 里出现 小关API |
| 05 | 启用配置 —— 状态切到「使用中」 | Provider 状态变成启用 |
| 06 | 打开 Codex —— 输入 hi 并发送 | 收到回复 |
| 07 | 验证用量 —— 回控制台看记录 | 日志页有这条调用 |
每一步「你应该看到什么」详见下面的分步说明。
只用图形界面的话,直接看 小白教程(Cherry Studio / Chatbox),同样十分钟内能跑通。
第一步:注册账号
注册入口:
https://api.yzgz.cn/register
打开后填写邮箱/手机号与密码完成注册。注册完成后,建议先确认能正常跳转到 登录页 或 控制台。
建议后续为不同用途分别创建 API Key(测试、生产、某个具体项目),不要一把 Key 通吃。
第二步:登录账号
登录入口:
https://api.yzgz.cn/login
登录成功后进入控制台首页。顶部导航有 首页 / 控制台 / 模型广场 / 文档,左侧菜单有 数据看板 / 令牌管理 / 钱包管理。
更换浏览器或清理缓存后可能需要重新登录。
第三步:充值额度
进入控制台后,先确认账户余额充足。
- 控制台传送门 → 「钱包管理」
- 或左侧边栏 → 钱包管理
充值后回到 数据看板 查看:
- 当前余额
- 历史消耗
- 请求次数
- 统计额度
充值与计费
| 你想知道 | 去哪看 |
|---|---|
| 充值后有多少额度 | 钱包管理页面显示的实际到账额度 |
| 调用会扣多少额度 | 模型广场 中对应模型、对应分组的最终价格 |
账户没有可用额度时,即使 API Key 创建成功,接口请求也可能依然失败。
模型广场里的价格已经折算完成,不需要自己换算美元或再次计算倍率。详见 令牌分组说明。
第四步:创建 API 令牌
API Key(也叫「令牌」或「密钥」)就是后面要粘贴到配置文件或输入框中的一串身份凭证。它不是模型名称,也不是请求地址。
新手只要记住 3 步
- 按客户端教程指定的分组创建令牌
- 提交后回令牌列表直接复制 —— 剪贴板里是纯 API Key,不包含
Bearer - 回到配置页面:
- 独立的 API Key 输入框 → 直接粘贴完整内容
- 只有配置文件/请求示例中的占位文字才需要替换
创建步骤
- 左侧菜单 令牌管理
- 点 添加令牌
- 填写令牌信息:
| 字段 | 说明 | 建议 |
|---|---|---|
| 令牌名称 | 仅用于你自己辨认 | 用项目名,如 blog-prod、测试 |
| 令牌分组 | 决定这把 key 能调用哪些模型 | 先到模型广场确认模型所属分组,不要凭名字猜 |
| 过期时间 | 可选;不填表示长期有效 | 生产 key 建议设 90 天轮换 |
| 额度设置 | 可选;限制这把 key 的最大调用额度 | 按用量给,先给小额 |
| 模型可用列表 | 限制可调用的模型,留空表示不限制 | 新手建议留空 |
- 点 提交,完成创建
- 回到令牌列表,在密钥栏直接复制
API Key 只应保存在本机受控配置文件、服务端环境变量或安全密钥管理工具中。 不要写进前端代码、公开仓库或聊天截图里。
需要一把 Key 调用多个模型?
选择 Auto 分组,创建时保持默认设置即可;如需控制路由优先级,只在「调整分组顺序」中拖动排列。
Auto 会按请求中的 model 自动路由,不能通过勾选分组来改变范围。详见 Auto 分组令牌。
对分组规则不熟悉时,先选具体分组,更好排查。
你的 API_KEY 到底填在哪里?
你的API_KEY / YOUR_API_KEY 只是占位文字,不能原样保留。
| 看到的位置 | 正确填写方式 | 注意事项 |
|---|---|---|
| JSON 或 TOML | 把引号里的占位符替换为完整 API Key | 保留原有引号,不要删字段名或等号 |
.env 文件 | GEMINI_API_KEY=你的完整 API Key | 不加引号,等号两边不加空格 |
| 网页上的 API Key 输入框 | 直接粘贴完整 API Key | 不加引号,不要输入 Bearer |
请求示例的 Authorization: Bearer *** | 只替换 Key | Bearer 只有示例里写了才保留 |
示例:
"OPENAI_API_KEY": "你的API_KEY"
替换后应保持同样结构:
"OPENAI_API_KEY": "sk-xxxxxxxxxxxxxxxx"
第五步:发起第一次请求
调用前先确认三项:
| 项 | 值 |
|---|---|
| Base URL | https://api.yzgz.cn/v1 |
| Authorization | Bearer YOUR_API_KEY |
| 模型 | 该分组下当前可用的模型名 |
curl https://api.yzgz.cn/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-opus-4-5",
"messages": [{"role": "user", "content": "你好"}]
}'
完整示例(含 Anthropic / Gemini 协议、SSE 流式)见 第一次请求。
想确认当前 key 能看到哪些模型:
curl https://api.yzgz.cn/v1/models -H "Authorization: Bearer $API_KEY"
第六步(可选):配置客户端
如果你要在 CLI、桌面客户端或 VS Code 插件里用,按对应教程配置。
| 你在用什么 | 读这里 |
|---|---|
| Codex CLI / VS Code 插件 | Codex 配置 |
| Claude Code CLI / VS Code 插件 | Claude Code 配置 |
| ChatGPT 桌面版 | ChatGPT 桌面版配置 |
| Claude 桌面版 | Claude 桌面版配置 |
| Gemini / Antigravity | Gemini 配置 |
| OpenClaw | OpenClaw 配置 |
| Hermes Agent | Hermes Agent 配置 |
| WorkBuddy | WorkBuddy 配置 |
| Grok Build | Grok Build 配置 |
| Kimi Code CLI | Kimi Code 配置 |
| GLM(经 Claude Code) | GLM 配置 |
| 多家供应商一键切换 | CC-Switch 配置 |
| 全部客户端 | Agent 客户端配置大全 |
| 图形界面(Cherry Studio / Chatbox) | 小白教程 |
需要 Node.js 的先看 Node.js 环境准备。
第七步:确认调用生效
- 确认客户端读取了配置 —— 启动日志里不应再出现官方域名
- 发一句最短的话测试 —— 比如
hi - 回控制台「日志」页看用量 —— 有记录就说明真通了
先看状态码:快速定位
| 状态码 | 含义 | 优先检查 |
|---|---|---|
| 401 | 未授权 / API_KEY_REQUIRED | Authorization: Bearer *** 是否存在、环境变量是否为空、Key 是否填到了错误字段 |
| 404 | 找不到 chat/completions | 主调用路径是 /v1/messages 与 Responses API;客户端只能发 /v1/chat/completions 时,切换到对应模式 |
| 200 但模型不可用 | 有响应但不能用 | 先确认 CC-Switch 当前 Provider 已启用;直接调 API 的开发者再请求 /v1/models,用返回的模型 ID |
| 请求卡住 / 超时 | 上游或本地问题 | 先用最短文本测试;确认没有额外代理、错误的流式设置或重复的 /v1 路径 |
| 429 | 限流 | 降低并发,减少请求频率,见 服务条款 |
| 503 | 通道暂时不可用 | get_channel_failed,稍后重试 |