玄月授权接口文档

1.为什么选择Websocket协议呢

1. ws协议能有更好的跨域和墙的穿透能力
2. 可以在没有防火墙的情况下在应用层比http协议 防CC攻击效果更加好 (ps:很多IP代理 只能代理HTTP协议)
3. 在高并发的场景下ws协议比HTTP协议 性能更好 查询数据库次数更少
4. ws协议可以在服务器端做更多的判断用来判断客户端的合法性 (http如果本地被干掉了心跳包 那就失去了对客户端的控制)
5. ws协议比HTTP协议 有更好的实时性 ,可以随时服务器向客户端推送数据
6. 在相同的服务器配置下，WebSocket 协议通常比 HTTP 协议 能承受更高的并发连接
7. 交互速度更快,响应速度更快

​x
在5000在线用户并发情况下
HTTPS 协议的缺点
流程：客户端 → TLS 握手 → POST 心跳 20 字节 → 收到响应 → TCP 断开。
每一分钟，**全部 5000 个客户端全部重新建立 TLS+TCP 连接**。
HTTP 头部本身就几百字节；TLS 握手多轮报文。
单次客户端一轮心跳：**约 700‑1100 字节**
5000 客户端每分钟总流量：
`5000 * ~900B ≈ 4.3MB/分钟`，**≈258MB / 小时**

1.  发送心跳包可能就20字节但是携带的头部就高达几百字节,而且每次TLS解析对cpu是大的消耗,需要的带宽又高 
    大量流量消耗在 TLS 握手、HTTP 协议头，业务心跳只有 20 字节
2.  容易被批量爬虫、爆破和CC攻击
3.  服务器在国外的情况下, 审查系统会对每次请求进行审查,更容易被Reset
4.  大量短连接，会产生海量 `TIME_WAIT`，必须调优 tcp_tw_reuse；文件句柄瞬时冲高。

xxxxxxxxxx
可以问AI来判断 https与wss 协议的选择
问：
5000在线客户 并发 每分钟1次心跳  使用这两种协议用哪种好 https 和 wss
客户每次心跳包 内容大改长度为 20字节
分析服务器 cpu 和内存 和网络流量情况 来决定用哪种协议好

2. 玄月验证接口使用说明

使用websoket协议连接服务器 ,发送规定的json加密数据 来与服务器进行交互,

因群主服务器的原因 国内可能存在部分地区屏蔽情况 ，可采用转发的方式 使用自己的服务器进行转发

3. WebSocket接口

群主测试服务器连接地址 : ws://v1.msplock.vip:8810/api/user/ws?ExeID=xxx&DevID=xxxx&Version=v1.0.0

如果你购买了服务器后台 请填替换服务器IP即可 支持IPv6

通信封包加密规则：

接口通讯密钥(服务器自动下发)

提交数据加密：所有提交的数据发送:需通过RC4加密 才能与服务器通信

返回数据解密：所有返回的数据发送:需要通过RC4解密

服务器下发的数据均为 base64编码

注意: 连接服务器,服务器会自动下发接口加密的通讯密钥,需要使用 <<作者密钥>> 解密出接口的通讯密钥,之后使用新密钥进行加解密操作

需要将json 字符串进行utf-8 编码 在进行RC4加密 base64编码发送

可参考Python 源码进行制作其他语言的SDK

断线重连机制:

为防止服务器更新或重启情况下 有大量连接请求(类似与ddos攻击) 造成服务器短时间资源带宽紧张

推荐 程序等待30-60秒 时间,在进行断线重连操作 易SDK ✔ GoSDK ✔ PythonSDK ✔ C++✔

3.1 连接地址说明

群主测试服务器连接地址 ws://v1.msplock.vip:8810/api/user/ws?ExeID=xxx&DevID=xxxx

3.2 获取软件基本信息

var json = { "Type": "GetExeInfo" }

Result:

xxxxxxxxxx
{
  "Tag": "GetExeInfo",
  "Code": 1,
  "Msg": "获取成功",
  "Data": {
    "Exe": {
      "Address": "",
      "AdminID": "646e0cdba20867821d3cc050",
      "BindCount": 3,
      "GiveTime": 10,
      "ID": "65bc7fe8defb0198aac98e3e",
      "IsBindIP": false,
      "IsDK": true,
      "IsDbg": true,
      "IsDeviceID": true,
      "IsReg": true,
      "IsSafeQuit": false,
      "IsUpDate": false,
      "IsWebLogin": false,
      "Key": "",
      "LoginMod": 0,
      "Md5": "",
      "Notice": "我是软件公告66666666666",
      "PayLink": "",
      "State": true,
      "SubTime": 15,
      "Title": "玄月授权",
      "Versions": "1.0.0"
    }
  },
  "Time": "1784967638"
}

3.3 获取验证码

var json = { "Type": "GetCode" }

Result:

xxxxxxxxxx
{
    "Tag": "GetCode",
    "Code": 1,
    "Msg": "ok",
    "Data": "WUG1",
    "Time": "1785203615"
}

3.4 用户注册

var json = { "Type": "Register", "Data": { "Name": Name, "Pwd": Pwd, "Code": Code } }

Result:

3.5 用户登录

var json = {"Type":"Login","Data":{"Name":Name,"Pwd":Pwd}}

Result:

3.6 卡密登录

var json = {"Type":"CarLogin","Data":{"Serial":Serial}}

Result:

3.7 卡密充值

var json = {"Type":"UserPay","Data":{"Name":Name,"Serial":Serial}}

Result:

3.8 修改密码

提交数据::{"Type":"UpUserPwd","Data":{"Name":Name,"OldPwd":OldPwd,"NewPwd":NewPwd}}

Result:

3.9 换绑

换绑成功 扣除用户到期时间

var json = {"Type":"BindDeviceID","Data":{"Name":Name,"Pwd":Pwd}}

Result:

3.10 加入设备黑名单

将用户状态 修改为禁用 并把设备加入黑名单中

var json = {"Type":"AddBlack","Data":{"Bak":Bak}}

Result:

3.11 获取用户信息

var json = {"Type":"GetUserInfo"}

Result:

3.12 设置用户配置信息

用于用户新设备下载配置文件

提交数据::{"Type":"SetUerConf","Data":{"Conf":Conf}}

Result:

3.13 获取核心加密数据

var json = {"Type":"GetExeData"}

Result:

3.14 获取远程加密变量

var json ={"Type":"GetVariable","Data":{"Key":Key}}

Result:

3.16 支付_查询卡密

判断仓库里是否有对应类型的卡密 返回卡ID

var json ={"Type":"FindCarInfo","Data":{"CarType":CarType}}

Result:

3.17 支付_创建支付订单

创建支付宝订单 返回base64 图片二维码

var json ={"Type":"AliPayCreate","Data":{"CarID":CarID}}

Result:

3.18 支付_是否到账

方式一:

var json ={"Type":"IsPay","Data":{"CarID":CarID}}

Result:

3.19 支付_提卡

返回卡密信息

var json ={"Type":"PutCar","Data":{"BuillID":BuillID}}

Result:

3.20 主动心跳

必须在5分钟之内执行一次 // 后台设置了读取超时（5分钟） 超过时间服务器自动断开连接

var json ={"Type":"Ping","Data":{"Token":Token,"Key":key}}

token 组成

Result:

3.21 下线通知

服务器自动推送 tag=OffLine 在接受事件里自己处理(程序退出)

3.22 实时消息

服务器自动推送 tag=SendMsg 在接受事件里自己处理(程序展示实时消息)

3.23 扫码登陆

var json ={"Type":"QuickLogin"}

Result:

3.24 VMP授权下发

var json={"Type":"VMPAuth","Data":{"HardwareId":HardwareId}}

Result:

###

4.HTTP网页接口

4.1 GetCode 获取验证码-POST

/api/user/GetCode?DevKey=XXXXXX

4.2 GetExeInfo 获取软件信息-POST

/api/user/GetExeInfo?DevKey=XXXXXX

4.3 UserPay 用户充值-POST

/api/user/UserPay

xxxxxxxxxx
{
"ExeID":ExeID,
"Name": Name,
"Serial": Serial,
}

4.4 UpUserPwd 更新用户密码-POST

/api/user/UpUserPwd

xxxxxxxxxx
{
"ExeID":ExeID,
"Name":Name,
"OldPwd":OldPwd,
"NewPwd":NewPwd
}

4.5 BindDeviceID 解绑-POST

/api/user/BindDeviceID

xxxxxxxxxx
{
"ExeID":ExeID,
"Name":Name,
"Pwd":Pwd
}

4.6 CarLogin 卡密登录-POST

/api/user/CarLogin?DevKey=XXXXXX

xxxxxxxxxx
{
"Serial": Serial,
}

4.7 Login 账号登录-POST

/api/user/Login?DevKey=XXXXXX

xxxxxxxxxx
{
"Name":Name,
"Pwd":Pwd, 
}

4.8 Register 用户注册-POST

/api/user/Register

xxxxxxxxxx
{
"ExeID":ExeID,
"Name":Name,
"Pwd":Pwd, 
"Code":Code,
"DevKey":DevKey,
}

4.9 FindCarInfo 获取卡密信息-POST

/api/user/FindCarInfo?DevKey=XXXXXX

xxxxxxxxxx
{
"ExeID":ExeID,
"TyCar":0
}

4.10 AliPayCreate 创建订单-POST

/api/user/AliPayCreate

xxxxxxxxxx
{
"ExeID":ExeID,
"CarID":CarID
}

4.11 PutCar 提卡-POST

/api/user/PutCar

xxxxxxxxxx
{
"ExeID":ExeID,
"BuillID":BuillID
}

4.12 IsPay 是否支付成功-POST

xxxxxxxxxx
/api/user/IsPay

xxxxxxxxxx
{
"CarID":CarID
}

4.13 GetUserEndTime 获取用户到期时间-POST

xxxxxxxxxx
/api/user/GetUserEndTime

xxxxxxxxxx
{
"ExeID":ExeID,
"Name":Name
}

4.14 ReportConnStatus 上报退出状态-POST

用于清理异常掉线占用在线表

xxxxxxxxxx
/api/user/ReportConnStatus?DevKey=xxxxx