Developer API

API 接入文档

使用 API Token 获取业务列表、凭据与实时用量，方便集成到自有系统。

安卓 App

配套安卓客户端支持首次启动绑定网站域名，之后在该域名下登录并同步业务、协议、凭据、用量与订阅地址。域名可在「我的 → 绑定站点 → 修改」中随时更换，更换域名会要求重新登录。

域名探测接口：GET /api/v1/ping，返回站点名称、版本与当前可用协议，App 在绑定域名时会先调用该接口验证连通性。

GET /api/v1/ping

{
  "ok": true,
  "data": {
    "site_name": "极光IP",
    "protocols": [ { "code": "vless", "name": "VLESS" } ]
  }
}

认证方式

所有 API 请求需要在请求头中携带 Authorization: Bearer <API_TOKEN>。Token 可在「用户中心 → 账户设置」查看或重新生成。

# 基础地址
https://zuip.cn/api/v1
# 请求示例
curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://zuip.cn/api/v1/services

App 使用网站账户登录，服务端校验密码后返回用户 API Token。Token 与网页端共用，修改密码不会自动失效，可在网页「账户设置」重新生成。

POST /api/v1/login
Content-Type: application/json

{ "email": "demo@auroraip.cn", "password": "demo123" }

{
  "ok": true,
  "data": {
    "token": "YOUR_API_TOKEN",
    "user": { "name": "演示用户", "balance": 452 }
  }
}

获取业务列表

返回当前账户下所有已开通业务的连接信息与用量。建议在服务端调用，避免 Token 泄露。

GET /api/v1/services

{
  "ok": true,
  "data": [
    {
      "id": 12,
      "service_no": "SVC261102A1B2C3",
      "name": "动态住宅 · 标准流量包",
      "status": "active",
      "billing_type": "traffic",
      "protocol": "vmess",
      "protocol_name": "VMess",
      "expires_at": "2026-12-31 23:59:59",
      "traffic_limit_gb": 50,
      "traffic_used_gb": 12.4,
      "host": "hk1.auroraip.cn",
      "port": 443,
      "username": "u2-svc...",
      "password": "uuid",
      "sub_url": "https://hk1.auroraip.cn/sub/..."
    }
  ]
}

获取账户信息

用于校验 Token 有效性或同步账户余额。

GET /api/v1/profile

{
  "ok": true,
  "data": {
    "id": 2,
    "name": "Demo User",
    "email": "demo@auroraip.cn",
    "balance": 500
  }
}

字段说明

status：active 运行中 / pending 开通中 / suspended 暂停 / expired 到期 / exhausted 流量用尽
protocol：vless / vmess / trojan / shadowsocks / hysteria2 等，由购买时选择的 X-UI 入站决定
billing_type：monthly 包月 / bandwidth 带宽 / traffic 流量
traffic_limit_gb：0 表示不限流量；traffic_used_gb 为已用流量（GB）
host / port / username / password：可直接用于代理客户端或 SDK 的连接凭据
sub_url：订阅地址，可导入 Clash、v2rayN 等客户端

错误码

401：Token 缺失或无效，请检查请求头
404：资源不存在或无权限访问
422：参数校验失败，响应体包含 message
429：请求频率过高，请稍后重试
500：服务端异常，请提交工单

X-UI 集成说明

平台直接连接 3x-ui 节点：管理员在「节点管理」中填写面板 API 地址，并优先配置 API Token（admin 权限）；也可使用管理员账号密码，系统会自动获取 Cookie 会话与 CSRF Token。保存后可一键同步全部入站为协议线路，每个入站自带协议、端口与传输网络，系统不会限定单一协议。

插件会自动识别 3x-ui v3 的「客户端一等对象」API 与旧版入站 API：v3 使用 /panel/api/clients/* 全量更新客户端，旧版回退到入站 settings.clients，两种面板返回的嵌套 JSON 都能正确解析。

套餐可绑定多条线路，用户在结算时自选协议与节点。支付成功后系统按协议生成不同的 X-UI 客户端结构（VLESS / VMess 使用 UUID，Trojan / Shadowsocks 使用 password，Hysteria2 使用 auth），并同步额度、有效期与启用状态；到期、暂停、重置流量等操作同样会下发到面板。

若面板不可达，业务会保留为「开通中」，支持一键重试。管理员可在「插件管理」切换自动 / v3 / 旧版接口模式，配置 SSL 证书校验、超时与演示模式。

请勿在前端页面暴露 API Token。所有涉及凭据的调用应在服务端完成。

API 接入文档

安卓 App

认证方式

App 登录

获取业务列表

获取账户信息

字段说明

错误码

X-UI 集成说明