用户与订阅 API
QuicProxy 使用开放友好的 MIT 开源协议,可随意修改、随意闭源。核心 API 免费提供用户管理、流量统计与订阅分发能力,适用于 trojan / anytls / shadowquic 入站。
我们的承诺
所有项目都不会出现机场、VPN、VPS、IP 代理等将你的客户引流到其他竞争对手的广告。
鉴权
以下接口由核心 API(api 配置)提供,使用 Authorization: <password> 请求头鉴权。/sub 为公开接口,不需要 API 密码。
用户管理
| 方法 | 路径 | 说明 |
|---|---|---|
GET | /users | 列出所有用户及其流量 |
POST | /users | 添加或更新用户,body 为 {"username":"alice","password":"secret"} |
DELETE | /users?username=alice | 删除用户并断开其连接 |
GET | /users/stats?username=alice&clear=true | 查询单个用户流量;clear=true 时原子地取值并清零,不传 username 返回全部用户 |
用户可通过配置文件顶层的 users 或 inbound 的 users 预置。运行时新增的用户与流量会持久化到 observe 的 cache。
PASS="your-api-password"
BASE="http://127.0.0.1:<API端口>"
# 添加用户
curl -X POST ${BASE}/users \
-H "Authorization: ${PASS}" \
-H "Content-Type: application/json" \
-d '{"username":"alice","password":"secret"}'
# 读取并清零 alice 的流量
curl "${BASE}/users/stats?username=alice&clear=true" -H "Authorization: ${PASS}"
订阅分发
节点链接由各 inbound 动态生成,无需手工维护。
| 方法 | 路径 | 鉴权 | 说明 |
|---|---|---|---|
GET | /sub?username=alice&password=secret | 无需 API 密码 | 按用户返回 sq / anytls / trojan 节点订阅,并在 subscription-userinfo 响应头中携带该用户已用流量 |
GET | /qr?text=<url> | 需要 | 将文本渲染为终端二维码(半块字符,宽度适配 80 列终端) |
订阅默认不限流量、不限时间(total=0; expire=0),但持续统计耗费流量。
subscription 配置
使用 subscription 指定写入节点链接的对外主机与元信息:
"subscription": {
"host": "1.2.3.4", // 写入节点链接的公网地址,支持字符串或数组
"name": "MyNode", // 可选,节点名前缀
"update_interval": 24, // 可选,profile-update-interval 响应头(小时)
"web_page_url": "https://..." // 可选,profile-web-page-url 响应头
}
host 也可以是数组,以同时下发多个地址。IPv6 节点优先,节点名会带上 -IPv4 / -IPv6 后缀:
"subscription": {
"host": ["2001:db8::1", "1.2.3.4"]
}