Http接口
获取版本更新
向下列接口发送post请求,可获取当前服务器的软件版本及更新连接
http://服务器IP:9007/getConfig
例:http://127.0.0.1:9007/getConfig
返回结果
{"软件版本":"1.0.as","强制更新":true,"更新链接":"http://www.baidu.com"}
webSocket接口
账号登录
请求格式:
{
"消息类型": "登录",
"消息内容": {
"卡密": "卡密",
"机器码": "机器码"
}
}
返回结果:
登录总共有以下几种返回值:
登录成功
登录失败,卡密已过期
登录失败,当前卡密不存在
登录失败,当前卡密已登录
注意:只有登录结果为“登录成功”才会返回到期时间,否则只会返回登录结果
{
"消息类型": "登录",
"消息内容": {
"登录结果": "登录成功",
"到期时间": "2022-11-14 19:03:41"
}
}
远程键值
请求格式:
{
"消息类型": "远程键值",
"消息内容": {
"键": "要获取的键",
"标识": "自定义标识"
}
}
返回结果:
{
"消息类型": "远程键值",
"消息内容": {
"值": "返回的值",
"标识": "自定义标识"
}
}
若未登录,则返回如下内容
{
"消息类型": "远程键值",
"消息内容": {
"标识": "自定义标识",
"值": "未登录"
}
}
若键或值不存在或者获取失败,则返回如下内容
{
"消息类型": "远程键值",
"消息内容": {
"标识": "自定义标识",
"值": ""
}
}
获取路径
请求格式
{
"消息类型": "获取路径",
"消息内容": {
"地图名称": "GwanGorge",
"地图密码": "12345",
"距离误差": "7",
"高度误差": "5",
"寻找最近首坐标":1,
"当前坐标": {
"x": "-357.17",
"y": "-0.25",
"z": "16"
},
"目的地坐标": {
"x": "252.01",
"y": "-184.18",
"z": "8"
}
}
}
获取路径返回
若发送的地图名不存在或密码错误,则返回如下内容
{
"消息类型": "获取路径",
"消息内容": {
"值": "地图读取失败"
}
}
若路径计算失败,则返回如下内容
{
"消息类型": "获取路径返回",
"消息内容": {
"值": "路径计算失败"
}
}
若未登录,则返回如下内容
{
"消息类型": "获取路径",
"消息内容": {
"值": "未登录"
}
}
若计算路径成功,返回如下内容(此处省略大多数坐标,只显示三个,实际返回值以计算结果为准)
{
"消息类型": "获取路径",
"消息内容": {
"值": [{
"x": -256.927,
"y": 296.13,
"z": -6.52897
}, {
"x": -120.477,
"y": 591.046,
"z": -8
}, {
"x": -4670.54,
"y": 18210.7,
"z": -35.5758
}]
}
}
获取地图配置
请求格式
{
"消息类型": "获取地图配置",
"消息内容": {
"地图名称": "测试",
"地图密码": "测试"
}
}
若未登录,则返回如下内容
{
"消息类型": "获取地图配置",
"消息内容": {
"值": "未登录"
}
}
若获取成功,则返回如下内容
"是否公开": 1 如果是1代表公开,如果是0代表非公开
{
"消息类型": "获取地图配置",
"消息内容": {
"值": {
"地图配置": "上传过的是什么配置,就会返回什么配置",
"是否公开": 1
}
}
}
若发送的地图名不存在或密码错误,则返回如下内容
{
"消息类型": "获取地图配置",
"消息内容": {
"值": ""
}
}
获取地图数据
{
"消息类型": "获取地图数据",
"消息内容": {
"地图名称": "测试",
"地图密码": "测试"
}
}
若未登录,则返回如下内容
{
"消息类型": "获取地图数据",
"消息内容": {
"值": "未登录"
}
}
若获取成功,则返回如下内容
{
"消息类型": "获取地图数据",
"消息内容": {
"值": [{
"x": -256.927,
"y": 296.13,
"z": -6.52897
}, {
"x": -120.477,
"y": 591.046,
"z": -8
}, {
"x": -4670.54,
"y": 18210.7,
"z": -35.5758
}]
}
}
添加修改地图
请求格式
"是否公开": 1 如果是1代表公开,如果是0代表非公开
{
"消息类型": "添加修改地图",
"消息内容": {
"地图名称": "测试",
"地图密码": "测试",
"地图数据": "json格式的地图数据",
"地图ID": "1",
"是否公开": 1
}
}
若未登录,返回如下内容
{
"消息类型": "添加修改地图",
"消息内容": {
"值": "未登录"
}
}
若添加或修改失败,返回如下内容
{
"消息类型": "添加修改地图",
"消息内容": {
"值": "失败"
}
}
若添加成功,返回如下内容
{
"消息类型": "添加修改地图",
"消息内容": {
"值": "成功"
}
}
删除地图
{
"消息类型": "删除地图",
"消息内容": {
"地图名称": "测试",
"地图密码": "测试"
}
}
若删除成功,返回如下内容
{
"消息类型": "删除地图",
"消息内容": {
"值": "成功"
}
}
断开连接
服务器在后台管理中可以主动断开与客户端的连接,断开连接后,如果进行断线重连的操作,依然会正常连接服务器,所以建议收到此数据后,不要进行断线重连操作
断开连接时,客户端会收到以下内容
{
"消息类型": "断开链接",
"消息内容": "服务器主动断开"
}