RESTful API
快连提供完整的RESTful API,支持账号管理、节点查询、流量统计、配置生成等操作。API采用HTTPS加密传输,使用API Key进行身份验证。所有响应返回JSON格式。
认证方式
在HTTP请求头中携带API Key:Authorization: Bearer YOUR_API_KEY。API Key可在官网个人中心→开发者设置中生成。每个账号最多生成5个API Key,支持单独禁用和删除。
API端点
| 方法 | 端点 | 说明 |
|---|---|---|
| GET | /api/v1/nodes | 获取所有可用节点列表 |
| GET | /api/v1/nodes/{id}/status | 获取指定节点实时状态 |
| POST | /api/v1/wireguard/config | 生成WireGuard配置文件 |
| GET | /api/v1/usage | 获取流量使用统计 |
| GET | /api/v1/account | 获取账号信息和订阅状态 |
| POST | /api/v1/account/subaccount | 创建子账号(企业版) |
请求示例
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.klanifl.com.cn/v1/nodes
SDK下载
Python SDK
支持Python 3.7+,封装所有API端点。通过pip安装:pip install kuailian-sdk。包含完整的类型注解和文档字符串。
Node.js SDK
支持Node.js 14+,TypeScript类型定义。通过npm安装:npm install @kuailian/sdk。支持Promise和async/await。
Go SDK
支持Go 1.18+,通过go get安装:go get github.com/kuailian/sdk-go。包含context支持和错误处理。
Java SDK
支持Java 8+,Maven依赖。包含同步和异步客户端,支持Spring Boot自动配置。
WireGuard配置生成
开发者可通过API或官网生成WireGuard配置文件,用于自定义客户端或路由器部署。每个配置包含私钥、公钥、端点地址、允许的IP范围等。配置文件格式兼容所有标准WireGuard客户端。
配置示例
[Interface]
PrivateKey = your_private_key
Address = 10.0.0.2/32
DNS = 1.1.1.1
[Peer]
PublicKey = server_public_key
Endpoint = node.klanifl.com.cn:51820
AllowedIPs = 0.0.0.0/0, ::/0
路由器插件开发
快连OpenWrt插件基于LuCI开发,开源代码托管在GitHub。开发者可基于插件源码进行二次开发,支持自定义UI、批量节点管理、定时任务等功能。插件采用Shell+Lua编写,兼容OpenWrt 19.07及以上版本。
编译环境
- OpenWrt SDK 19.07+
- libopenssl、libpthread依赖
- LuCI 2.0(可选,用于Web界面)
- WireGuard工具(wireguard-tools)
集成最佳实践
企业SSO集成
企业版支持SAML 2.0和OIDC协议,可与企业现有SSO系统(如Okta、Azure AD、钉钉、企业微信)集成。员工使用企业账号即可登录快连,无需单独注册。管理员可在SSO后台统一管理访问权限。
自动化部署
通过API和Terraform Provider,可实现快连节点和账号的自动化部署。支持在CI/CD流水线中自动创建测试账号、生成配置、清理资源。适用于DevOps场景和自动化测试环境。
开发者支持
开发者技术支持邮箱:[email protected]。API文档在线地址:https://docs.klanifl.com.cn。GitHub开源组织:https://github.com/kuailian。欢迎提交Issue和Pull Request。