接入文档

接入指南

从零开始,照着做就能配好。把 base_url 指向 api.nianfeng.tech、填入 API Key 即可。

Base URL · api.nianfeng.tech 协议 · OpenAI & Anthropic 用量 API · v1

照着做即可完成接入。 命令行工具的安装命令都已配好镜像加速,直接照抄粘贴即可。

一、获取 API Key

  1. 打开 api.nianfeng.tech/login,用管理员分配给你的账号登录。
  2. 进入控制台后,点左侧菜单「API 密钥」。
  3. 点「新建令牌」,名称随意(如 my-mac),额度按需,创建后复制以 sk- 开头的密钥。
  4. 妥善保存这串 Key,后面每个工具都要用到。它等同于你的账号,不要外发。

下文所有出现 sk-你的Key 的地方,都替换成你复制的这串密钥。

二、安装 Node 环境

Claude Code 和 Codex 都需要 Node.js(18 及以上)。只用图形客户端(如 Cherry Studio)或只用 curl 的可跳过本节。用下面任一方式安装。

A方式 A:下载安装包(最简单,推荐新手)
  1. 打开镜像站:https://npmmirror.com/mirrors/node/,点最新的 v20.x 目录。
  2. Windows 下载 node-v20.x.x-x64.msi,macOS 下载 node-v20.x.x.pkg,双击安装,一路下一步。
B方式 B:用 nvm(方便切换版本)
macOS / Linux
# 用 gitee 镜像装 nvm(更快更稳)
curl -o- https://gitee.com/mirrors/nvm/raw/v0.40.1/install.sh | bash
# 重开终端后,让 nvm 从镜像下载 node
export NVM_NODEJS_ORG_MIRROR=https://npmmirror.com/mirrors/node
nvm install 20
✓验证
node -v   # 显示 v20.x.x 即安装成功
npm -v
★关键一步:把 npm 换成镜像源(只需一次)

设置后,之后所有 npm install 都走镜像加速,不再卡住。强烈建议先做这一步。

npm config set registry https://registry.npmmirror.com
npm config get registry   # 确认输出 https://registry.npmmirror.com

三、直接调用(命令行 / 代码)

OpenAI 格式(兼容所有 OpenAI SDK / 工具)

curl https://api.nianfeng.tech/v1/chat/completions \
  -H "Authorization: Bearer sk-你的Key" \
  -H "Content-Type: application/json" \
  -d '{"model":"claude-opus-4-8","messages":[{"role":"user","content":"你好"}]}'

Anthropic 格式(兼容 Claude SDK)

curl https://api.nianfeng.tech/v1/messages \
  -H "x-api-key: sk-你的Key" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{"model":"claude-sonnet-5","max_tokens":1024,"messages":[{"role":"user","content":"你好"}]}'

Python(OpenAI SDK)

# 先装 SDK(镜像加速)
pip install openai -i https://pypi.tuna.tsinghua.edu.cn/simple

from openai import OpenAI
client = OpenAI(base_url="https://api.nianfeng.tech/v1", api_key="sk-你的Key")
r = client.chat.completions.create(
    model="claude-opus-4-8",
    messages=[{"role":"user", "content":"你好"}])
print(r.choices[0].message.content)

能返回一段回复,就说明网络与 Key 都没问题。模型名可在 可用模型 页查。

四、Windows 设置环境变量

Windows 上接入 Claude Code / Codex 前,先按本节设好环境变量。macOS / Linux 用户可跳过。

1打开终端

开始菜单搜索 PowerShell 或 Windows Terminal 打开;或在任意文件夹空白处按住 Shift + 右键 →「在此处打开 PowerShell 窗口」。后面的 claude、codex 命令都在这里运行。

2方法一:图形界面设置(推荐,最直观)
  1. 按 Win + S 搜索「环境变量」,点开「编辑系统环境变量」;或按 Win + R 输入 sysdm.cpl 回车 →「高级」标签 →「环境变量」。
  2. 在上半部分「用户变量」中点「新建」。
  3. 变量名填 ANTHROPIC_BASE_URL,变量值填 https://api.nianfeng.tech,确定。
  4. 再点「新建」:变量名 ANTHROPIC_AUTH_TOKEN,变量值 sk-你的Key,确定。
  5. 要用 Codex 的话,再新建一个:NIANFENG_API_KEY = sk-你的Key。
  6. 层层点「确定」关闭窗口。必须关闭并重新打开终端(以及 VSCode 等编辑器)后才生效。
3方法二:命令行设置(setx)

在 PowerShell 中执行,每条设一个变量;setx 只对之后新开的终端生效:

setx ANTHROPIC_BASE_URL "https://api.nianfeng.tech"
setx ANTHROPIC_AUTH_TOKEN "sk-你的Key"
setx NIANFENG_API_KEY "sk-你的Key"    # 用 Codex 才需要
✓验证是否成功

关掉旧终端、重新开一个,执行:

# PowerShell
echo $env:ANTHROPIC_BASE_URL
# 或在 cmd 命令提示符
echo %ANTHROPIC_BASE_URL%

能打印出 https://api.nianfeng.tech 即设置成功。

★新建 Codex 配置文件(用 Codex 才需要)

Codex 配置在 C:\Users\你的用户名\.codex\config.toml。用 PowerShell 一键创建并打开记事本编辑:

mkdir $env:USERPROFILE\.codex -Force
notepad $env:USERPROFILE\.codex\config.toml

把第六节的 config.toml 内容粘进去保存。记事本保存时,编码请选 UTF-8。

五、接入 Claude Code

前置:已装好 Node(见第二节),并已 npm config set registry https://registry.npmmirror.com。

1安装 Claude Code
npm install -g @anthropic-ai/claude-code
claude --version   # 显示版本号即安装成功
2配置指向 NianFeng(设置环境变量)
macOS / Linux(zsh)
# 写入配置文件(bash 用户把 .zshrc 换成 .bashrc)
echo 'export ANTHROPIC_BASE_URL=https://api.nianfeng.tech' >> ~/.zshrc
echo 'export ANTHROPIC_AUTH_TOKEN=sk-你的Key' >> ~/.zshrc
source ~/.zshrc   # 让配置立即生效
Windows(PowerShell)
setx ANTHROPIC_BASE_URL "https://api.nianfeng.tech"
setx ANTHROPIC_AUTH_TOKEN "sk-你的Key"
# 设完必须关闭并重新打开终端,变量才生效
或临时用法(仅当前终端有效,适合临时试用)

不想改全局配置时,直接在当前终端里设置,关掉窗口即失效。注意:必须在同一个终端窗口里接着运行 claude。

Windows(PowerShell)
$env:ANTHROPIC_BASE_URL="https://api.nianfeng.tech"
$env:ANTHROPIC_AUTH_TOKEN="sk-你的Key"
claude
macOS / Linux
export ANTHROPIC_BASE_URL=https://api.nianfeng.tech
export ANTHROPIC_AUTH_TOKEN=sk-你的Key
claude
3启动使用
  1. cd 到你的项目目录。
  2. 运行 claude,首次会问是否信任该目录,回车确认。
  3. 输入 /model claude-opus-4-8 选择模型(或用 sonnet / haiku)。
  4. 直接对话即可。想设默认模型:再加一行 export ANTHROPIC_MODEL=claude-opus-4-8。

六、接入 Codex

前置同上:Node 已装、npm 已换镜像源。

1安装 Codex
npm install -g @openai/codex
codex --version
2编辑配置文件 ~/.codex/config.toml

没有这个文件就新建。Windows 路径为 C:\Users\你的用户名\.codex\config.toml。

model = "gpt-5.5"
model_provider = "nianfeng"

[model_providers.nianfeng]
name = "NianFeng"
base_url = "https://api.nianfeng.tech/v1"
wire_api = "responses"
env_key = "NIANFENG_API_KEY"
3设置 Key 并启动
macOS / Linux
echo 'export NIANFENG_API_KEY=sk-你的Key' >> ~/.zshrc
source ~/.zshrc
codex
Windows(PowerShell)
setx NIANFENG_API_KEY "sk-你的Key"
# 重开终端后运行
codex
若你的 Codex 版本报不支持 responses,把 config.toml 里的 wire_api 改成 "chat" 即可。

七、图形客户端

Cherry Studio、ChatBox、Cline、LobeChat 等,均按「OpenAI 兼容」方式添加一个服务商:

  1. 新增服务商 / 模型来源,类型选 OpenAI。
  2. API 地址(base_url)填:https://api.nianfeng.tech/v1 部分客户端只需填 https://api.nianfeng.tech,会自动补 /v1。
  3. API Key 填:sk-你的Key。
  4. 手动添加模型:claude-opus-4-8、gpt-5.5、glm-5.2 等(全部见 可用模型)。
  5. 保存后即可对话。

Cherry Studio 可在控制台「首页 → 一键配置」直接把本网关导入,免手填。

八、配套服务:Agent 接入与团队自动化

不止裸 API —— 网关也面向 Agent 框架与团队自动化。下面分两部分:把 Agent 框架接到网关、把成员用量每天自动播报到飞书。

Agent 框架接入(OpenClaw 等)

凡是走 OpenAI 或 Anthropic 协议的 Agent 框架(OpenClaw,以及各类基于 OpenAI / Claude SDK 的框架),都无需改代码:把 base_url 指向网关、填入你的 API Key 即可。模型名见 模型广场。

OpenAI 协议(多数 Agent 框架)
export OPENAI_BASE_URL=https://api.nianfeng.tech/v1
export OPENAI_API_KEY=sk-你的Key
Anthropic 协议(Claude 系框架)
export ANTHROPIC_BASE_URL=https://api.nianfeng.tech
export ANTHROPIC_AUTH_TOKEN=sk-你的Key
若框架用配置文件而非环境变量,把其中的 base_url / api_key / model 三项填成上面的值即可。选 OpenAI 还是 Anthropic 端点,取决于框架支持哪种协议。

团队自动化:用量查询 API

网关提供只读的用量查询接口(v1)。把接口文档 api.nianfeng.tech/report 连同访问令牌贴给飞书机器人 / Agent,即可按需查询「本账号各 API Key、各模型的用量」。以下为接口说明,完整版见 GET /report。

1认证

所有请求携带请求头 Authorization: Bearer <访问令牌>。访问令牌在控制台 → 个人设置 →「访问令牌」生成 —— 是账号访问令牌,不是「令牌」菜单里 sk- 开头的调用密钥。令牌只读、仅能查询本账号数据。

2端点总览
方法路径认证说明
GET/report/usage必须查询账号用量汇总
GET/report无需返回本接口文档
GET/report/health无需存活探测
3查询参数 · GET /report/usage
参数必填默认说明
range否todaytoday / yesterday / 7d / 30d / mtd(本月至今)
start否—自定义起始,YYYY-MM-DD 或 Unix 秒。传 start/end 时忽略 range
end否当前自定义结束,YYYY-MM-DD(含当天)或 Unix 秒
by否model聚合维度:model 按模型 / token 按 Key / token_model 按 Key×模型

时区按东八区(UTC+8);非法参数值回退默认。

4请求示例
# 昨天,按模型
curl "https://api.nianfeng.tech/report/usage?range=yesterday&by=model" \
  -H "Authorization: Bearer <访问令牌>"
5响应字段
字段类型说明
accountstring账号用户名
bystring生效的聚合维度
currencystring固定 USD
rangeobjectlabel / start / end(Unix 秒)/ start_time / end_time
totalobjectusd / requests / prompt_tokens / completion_tokens
items[]array明细,按 usd 降序
items[].modelstring模型名(by=model/token_model 时)
items[].tokenstringAPI Key 名(by=token/token_model 时;未命名为 (default))
items[].usdnumber该项消费(美元)
items[].requestsint该项请求数
items[].prompt_tokens / completion_tokensint该项输入 / 输出 token
6响应示例 · 200 OK
{
  "account": "lijin",
  "by": "model",
  "currency": "USD",
  "range": { "label": "yesterday", "start_time": "2026-08-27 00:00", "end_time": "2026-08-28 00:00" },
  "total": { "usd": 12.34, "requests": 42, "prompt_tokens": 51200, "completion_tokens": 8300 },
  "items": [
    { "model": "claude-opus-5", "usd": 8.02, "requests": 20, "prompt_tokens": 30100, "completion_tokens": 5100 },
    { "model": "gpt-5.5", "usd": 4.32, "requests": 22, "prompt_tokens": 21100, "completion_tokens": 3200 }
  ]
}
7错误码
状态码含义处理
401缺少或无效的访问令牌检查 Bearer 头;确认用账号访问令牌而非 sk- 密钥;令牌重新生成后旧值失效
404路径不存在检查请求路径
502服务端查询失败稍后重试,持续出现联系管理员

九、常见问题

npm install 卡住 / 报网络错误?

执行 npm config set registry https://registry.npmmirror.com 换成镜像源后重装;单次也可加 --registry=https://registry.npmmirror.com。

command not found: claude / codex?

一般是全局 bin 目录不在 PATH。重开终端;仍不行则运行 npm config get prefix 看到的目录下的 bin 加入 PATH。

环境变量设了没生效?

macOS/Linux 要 source ~/.zshrc 或重开终端;Windows 用 setx 后必须重新打开终端窗口。可用 echo $ANTHROPIC_BASE_URL(Win:echo %ANTHROPIC_BASE_URL%)检查。

报 401 / 鉴权失败?

检查 Key 是否以 sk- 开头、有没有多余空格;OpenAI 格式用 Authorization: Bearer,Anthropic 格式用 x-api-key。

请求偶尔超时 / 首字慢?

多为本地网络波动,重试即可。长上下文首次较慢属正常,后续会命中缓存明显加速。

模型名在哪看?

见 可用模型 页,直接复制模型名使用。