无忧IP客户端8.0版本接口说明文档

文档概述

本文为无忧IP客户端8.0正式版完整接口文档，标注适配客户端版本、请求地址、调用方式、参数详情与返回实例，涵盖节点操作、进程管理、系统配置、模拟器绑定等全部功能接口，可直接用于自动化脚本开发、批量控IP项目搭建。

一、基础接口信息

• 默认接口地址：http://127.0.0.1:54321

• 端口规则：起始端口54321，占用自动+1，最大54331

• 文档最新版本：20230425

二、版本更新日志

20220406：v1接口正式发布

20220415：新增多款实用接口，优化文档内容

20220418：新增用户唯一ID、客户端版本号接口；优化节点切换请求限制；完善Win7系统适配

20220504：上线DNS代理、上号顺序、优先可用节点代理设置接口

20220507：新增开机自启、自动最小化、随机进程名、性能优化、切换保护、禁用本地等开关接口

20220517：支持一键结束全部代理进程、节点无网自动切换

20220530：新增到期提醒、Ping状态检测、指定节点结束进程功能

20220616：新增全局一键切换所有节点接口

20220624：全部核心接口支持命令行直接调用

20221215：开放指定节点绑定代理进程接口

20230425：新增节点绑定、防重复绑定、模拟器区分绑定及绑定数据读取接口

三、统一标准返回格式

{
    "action": "接口标识",
    "message": "错误提示信息",
    "result": 0, //0=成功 非0=错误码
    "timestamp": "响应时间",
    "data": {} //业务返回数据
}

四、全部接口明细

1. 获取用户唯一ID | GET | /api/v1/getUserIdentitySessionId

2. 获取本机分配节点列表 | GET | /api/v1/getAllotNodeList

3. 单节点切换 | GET | /api/v1/nodeRequestSwitch

4. 批量节点切换 | GET | /api/v1/nodeBatchRequestSwitch

5. 获取已代理进程列表 | GET | /api/v1/getAllProxyProcessLists

6. 单节点网络实时检测 | GET | /api/v1/nodeNetworkDetection

7. 查询进程是否代理成功 | GET | /api/v1/queryProcessIsProxy

8. 批量提交网络检测 | GET | /api/v1/submitNodeNetworkDetection

9. 查询网络检测结果 | GET | /api/v1/queryNodeNetworkDetection

10. 获取客户端版本号 | GET | /api/v1/getClientVersion

11. DNS代理开关设置 | GET | /api/v1/setDnsProxySwitch

12. 设置上号顺序模式 | GET | /api/v1/setProxyOrderMode

13. 启用优先可用节点代理 | GET | /api/v1/setProxyAvailableUse

14. 开机自启配置 | GET | /api/v1/setAutoStart

15. 登录自动最小化开关 | GET | /api/v1/setAutoMinimize

16. 随机进程名防检测 | GET | /api/v1/setRandomProgramName

17. 系统性能优化开关 | GET | /api/v1/setPerformanceOptimization

18. 节点切换失败保护 | GET | /api/v1/setNodeSwitchProtect

19. 禁用本地网络 | GET | /api/v1/setDisableLocal

20. 结束全部代理进程 | GET | /api/v1/exitAllProxyProcesses

21. 节点无网自动切换 | GET | /api/v1/setNodeNoNetworkSwitching

22. 节点到期提醒开关 | GET | /api/v1/setNodeExpireRemind

23. 节点Ping状态检测开关 | GET | /api/v1/setNodePing

24. 结束指定节点代理进程 | GET | /api/v1/exitNodeProxyProcesses

25. 一键切换全部节点 | GET | /api/v1/nodeRequestSwitchAll

26. 远程退出客户端 | GET | /api/v1/exitProgram

27. 指定节点绑定代理进程 | GET | /api/v1/setAppointNodeProxy

28. 全局节点绑定开关 | GET | /api/v1/setNodeBindSwitch

29. 禁止节点重复绑定 | GET | /api/v1/setNodeRepeatBindSwitch

30. 模拟器区分绑定开关 | GET | /api/v1/setNodeDiffSimulatorBindSwitch

31. 读取节点绑定数据列表 | GET | /api/v1/getNodeBindDataList

五、调用注意事项

1. 所有接口统一采用GET请求方式，严格对照适配版本调用；
2. 全局切换节点接口调用间隔不得低于15秒；
3. 仅驱动V5内核支持无窗口热切换IP，其余模式仅空闲节点可切换；
4. 海外线路开启DNS代理需手动填写有效DNS地址，避免解析失败；
5. 功能开关统一规则：1为开启，0为关闭。