Nowdex

中转站接入文档

用户扫一下，就能在 Nowdex 实时查看自己在中转站里的余额

Nowdex 能读取 Sub2API 和 NewAPI 站点的余额与额度，显示在 App、小组件和锁屏上。在你的 key 页面放一个链接或二维码，用户不用复制粘贴 Base URL 和 key，扫码确认就能添加。

工作方式

  1. 用户扫码

    用 iPhone 相机扫描你 key 页面上的二维码，打开 Nowdex。

  2. 添加 api.example.com？

    此链接想添加你的 api.example.com 账户。只有你确认后，Nowdex 才会添加。

    Base URL
    api.example.com
    API Key
    ••••••••a1b2
    余额
    $42.80
    添加 api.example.com取消

    安全存储在你的钥匙串中。

    确认添加

    Nowdex 用这个 key 读出余额，用户点「添加」。

  3. Example API余额$42.80
    合计 $100.00
    已用
    $57.20
    剩余
    $42.80 · 43%
    请求次数
    1,286
    更新时间
    9:41
    Example API
    余额$42.80
    已用 $57.201.3K

    随时查看

    余额和额度显示在 App、小组件和锁屏上。

Sub2API

nowdex://connect/sub2api?v=1&baseUrl=<站点地址>&key=<sk- API key>

适合放在 API 密钥页面（/keys）每个 key 的操作里。Nowdex 用这个 key 请求：

  • GET {baseUrl}/v1/usage，Authorization: Bearer <key>：钱包余额、key 额度（含 5 小时 / 每日 / 每周窗口）或订阅的每日 / 每周 / 每月额度。
  • GET {baseUrl}/api/v1/settings/public，不带凭据：用 site_name 给账户命名，失败时用域名。

NewAPI

NewAPI 站点有两种添加方式，可以只做第一种。

方式一：API key（推荐）

nowdex://connect/newapi?v=1&baseUrl=<站点地址>&key=<sk- API key>

放在令牌页（/console/token）每个令牌的操作里。Nowdex 请求 GET {baseUrl}/api/status（不带凭据，读取站点名和金额单位）和 GET {baseUrl}/api/usage/token/（Authorization: Bearer <key>），显示这个 key 的已用和剩余额度。令牌开启「允许查询余额」后，还会显示账户余额。

方式二：系统访问令牌

nowdex://connect/newapi?v=1&baseUrl=<站点地址>&accessToken=<系统访问令牌>&userId=<用户 ID>

放在个人设置里生成系统访问令牌的位置。accessToken 和 userId（数字用户 ID）都必填，此时不传 key。Nowdex 请求 GET {baseUrl}/api/user/self，请求头带 Authorization: Bearer <访问令牌> 和 New-Api-User: <用户 ID>，显示整个账户的余额和已用额度。

这个令牌能管理整个账户，重新生成后 Nowdex 里的账户会失效。请在界面上告诉用户这一点。

生成链接和二维码

// 生成 Nowdex 添加链接。URLSearchParams 会把 + 编码为 %2B，把 / 和 : 一并编码。
function nowdexConnectURL(provider, params) {
  // provider: 'sub2api' 或 'newapi'
  // params: { baseUrl, key } 或 { baseUrl, accessToken, userId }（仅 newapi）
  // baseUrl 必须是 HTTPS 公网域名，IP、localhost 和内网域名会被拒绝
  const baseUrl = params.baseUrl.replace(/\/+$/, '').replace(/\/v1$/, '');
  const query = new URLSearchParams({ v: '1', ...params, baseUrl });
  return `nowdex://connect/${provider}?${query}`;
}

// 例：Sub2API 的 key 页面
const url = nowdexConnectURL('sub2api', { baseUrl: location.origin, key: fullKey });

// 二维码在浏览器本地生成（npm 包 qrcode），不要用在线二维码接口
import QRCode from 'qrcode';
const dataURL = await QRCode.toDataURL(url, { errorCorrectionLevel: 'M', margin: 2, width: 240 });

建议的界面：key 操作里放「添加到 Nowdex」，点击后弹出对话框，包含二维码、一个指向同一链接的「在 Nowdex 中打开」按钮、提示「用 iPhone 相机扫描二维码，在 Nowdex 中确认添加」，以及 App Store 链接。