开发接入

把设备状态接入你的工具

通过 HTTPS API 查询当前账号下的设备、远程访问地址、连接状态和最近活动。所有个人接口都会限定为当前账号自己的设备。

快速开始

认证方式

推荐使用 HTTP 请求头传递设备登录码，避免凭证出现在浏览器历史或服务器访问日志中。

Authorization: Bearer YOUR_DEVICE_LOGIN_CODE
Accept: application/json

设备登录码可在“账号设置”页查看。请不要将它写入前端网页、公开仓库或日志。

常用接口

设备与连接查询

GET

/api/client/devices

列出当前账号绑定的所有设备。

GET

/api/client/lookup?device=DEVICE_CODE&key=LOOKUP_KEY

查询指定设备的在线状态、访问地址和最近变化。

GET

/api/client/tunnels?device=DEVICE_CODE&key=LOOKUP_KEY

查询指定设备的连接服务列表。

GET

/api/client/activity?device=DEVICE_CODE&key=LOOKUP_KEY

获取设备最近活动和访问地址变化。

调用示例

cURL 与 JavaScript

cURL

curl "https://natdog.imzzh.cn/api/client/lookup?device=DEVICE_CODE&key=LOOKUP_KEY" \
  -H "Accept: application/json"

JavaScript

const response = await fetch(
  "/api/client/devices",
  { headers: {
      Authorization: "Bearer " + loginCode,
      Accept: "application/json"
  }}
);
const data = await response.json();

更新检查

软件版本接口

GET /api/updates/latest?component=client&channel=stable&version=v1.0.0
GET /api/updates/latest?component=core&channel=stable&version=v1.0.0

无新版本时返回 204 No Content；有新版本时返回版本、更新说明、文件地址、SHA256 和强制更新标记。

响应与错误

常见 HTTP 状态

200请求成功

401登录凭证缺失或无效

403当前账号无权访问

404设备不存在或不属于当前账号

423设备已被限制

429请求过于频繁