文档
PoolNode 项目与网站管理 API
RustMinerSystem 内置 PoolNode 的项目激活、端口、接入点、网站、TLS、证书、模板和 APP 配置接口。
PoolNode 项目与网站管理 API
本章记录 RustMinerSystem 后台调用的 /api/poolnode/* 管理接口。它们与 PoolNode 用户端开放 API /api/user/* 不同,主要供节点所有者配置项目和网站。
PoolNode 接口常返回 { status, error, data } 包装结构。前端会从 data 读取真实结果,并把 status: 4 视为项目尚未激活。
项目申请和激活
| 方法 | 路径 | 主体/用途 |
|---|---|---|
| GET | /api/poolnode/project/info |
获取项目状态、名称和币种费率。 |
| POST | /api/poolnode/project/apply |
申请项目:{ name, token }。 |
| POST | /api/poolnode/project/active |
激活项目:{ code, token, captcha_token }。 |
| POST | /api/poolnode/project/unactive |
注销当前项目。 |
注销会清空前端的项目、费率和端口状态。执行前应确认结算和网站数据已经备份。
节点端口和接入点
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/poolnode/ports |
获取节点端口列表。 |
| POST | /api/poolnode/port/new |
在节点服务器创建端口。 |
| POST | /api/poolnode/extra/{port} |
修改指定监听端口的公开模式和统一钱包。 |
| DELETE | /api/port/{id} |
删除节点端口,复用通用端口删除接口。 |
| GET | /api/poolnode/endpoints |
获取节点接入地区/上游端点。 |
| GET | /api/poolnode/ping/{id} |
测试接入端点延迟。 |
| GET | /api/poolnode/project/stats?k={coin} |
获取指定节点币种统计。 |
| GET | /api/poolnode/sync/info |
获取同步成功、失败和明细。 |
部分币种的延迟测试会追加 ?k=KAS。创建端口主体与通用端口结构接近,节点前端额外使用:
{
"port": 3333,
"name": "Pool Port",
"currency": "PI-BTC",
"pool_address": "<接入点 ID 的 JSON 字符串>",
"mode": 1,
"protocol": 0,
"category": "poolnode",
"proxy_addr": ""
}
修改附加配置:
{
"mode": 1,
"proxy_addr": "<公开模式钱包或子账号>"
}
网站访问设置
| 方法 | 路径 | 请求/用途 |
|---|---|---|
| GET | /api/poolnode/index/port |
获取网站端口。 |
| POST | /api/poolnode/index/port |
修改网站端口:{ "r": 8080 }。 |
| GET | /api/poolnode/route |
获取网站安全路径。 |
| POST | /api/poolnode/route |
修改安全路径:{ "k": "route" }。 |
| GET | /api/poolnode/enable/index |
获取公网访问状态。 |
| POST | /api/poolnode/enable/index/{flag} |
开关公网访问。当前后端标志与 UI 布尔值相反。 |
| GET | /api/poolnode/index/tls |
获取 TLS 状态。 |
| POST | /api/poolnode/index/tls/{flag} |
设置 TLS 状态。 |
端口、路径和 TLS 修改可能触发服务重启,调用端必须准备切换到新地址。
网站证书
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/poolnode/cert |
获取当前证书类型。 |
| POST | /api/poolnode/cert/upload |
上传网站 PEM 证书和私钥。 |
| POST | /api/poolnode/cert/reset |
恢复内置网站证书。 |
上传主体为 { pem, key },两个字段均是 UTF-8 文本的 Base64 编码。
个性化网站和模板
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/poolnode/webconfig |
获取网站名称、Logo、公告等配置。 |
| POST | /api/poolnode/webconfig |
保存网站配置。 |
| GET | /api/poolnode/pool/asset/selected |
获取当前模板。 |
| GET | /api/poolnode/pool/assets |
获取所有可用模板。 |
| GET | /api/poolnode/pool/asset/status |
获取模板下载状态。 |
| POST | /api/poolnode/pool/asset |
选择模板。 |
| POST | /api/poolnode/pool/asset/reset |
恢复默认模板。 |
网站配置保存为 Base64 编码 JSON:
{
"k": "<Base64(JSON.stringify(config))>"
}
选择模板:
{
"asset_id": 1,
"item_id": 2
}
APP 通信配置
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/poolnode/project/url |
获取 APP API 地址、名称和邀请码。 |
| POST | /api/poolnode/project/url |
保存 APP 通信地址。 |
{
"api_url": "https://pool.example.com/safe-route",
"refresh": 0
}
