API文档

小雨棚API接口文档

API地址

小雨棚API地址：内测中，获取前往“获取 Token（必备）”

准备

获取需要的团队 appKey appSecret （￥10/月）

• 首页 → 团队中心 → 开发设置

密钥获取

在使用小雨棚API前您需要先获取两个密钥（Token）

• access_token

• refresh_token

由于小雨棚API正在内测中，获取小雨棚API Token 请前往“前往“获取 Token（必备）”

Socket

取消兵种人数限制

地址：/squad-business/socket/forceAllRoleAvailability

方式：POST

Example Value：

{
  "podId": "xx",
  "value": ""
}

Media type：application/json

获取服务器详细信息

地址：/squad-business/socket/getRecord

方式：GET

参数：

• podId（query）

• Authorization（header）

Media type：application/json

事件

地址：/squad-business/socket/events

方式：GET

参数：

• podId（query）

• Authorization（header）

Media type：application/json

更换地图

地址：/squad-business/socket/changeMap

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "podId": "xxx",
  "mapCode": "xxx"
}

Media type：application/json

踢出服务器

地址：/squad-business/socket/kick

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "podId": "xxx",
  "eosId": "xxx",
  "reason": "xxx"
}

Media type：application/json

警告

地址：/squad-business/socket/warn

方式：POST

参数：

• podId（query）

• eosId（query）

• message（query）

• Authorization（header）

Example Value：

{
  "podId": "xxx",
  "eosId": "xxx",
  "message": "xxx"
}

Media type：application/json

广播

地址：/squad-business/socket/broadcast

方式：POST

Example Value：

{
  "podId": "xxx",
 "message": "test"
}

Media type：application/json

概要信息

地址：/squad-business/socket/summary

方式：GET

参数：

• podId（query）

• Authorization（header）

Media type：application/json

预设地图

地址：/squad-business/socket/setNextMAP

方式：POST

Example Value：

{
  "podId": "xxx",
  "mapCode": "test"
}

Media type：application/json

跳边

地址：/squad-business/socket/changeForce

方式：POST

Example Value：

{
  "podId": "xxx",
  "eosId": "test"
}

Media type：application/json

封禁

地址：/squad-business/socket/ban

方式：POST

Example Value：

{
  "podId": "xxx",
  "steamId": "xxx",
  "reason": "xxx",
  "day": 0
}

Media type：application/json

随机打乱

地址：/squad-business/socket/balance

方式：POST

Example Value：

{
  "podId": "xxx"
}

Media type：application/json

重置队名

地址：/squad-business/socket/renameSquad

方式：POST

Example Value：

{
  "podId": "xxx",
  "teamId": "1",
  "squadId": "2"
}

Media type：application/json

在线OP信息

地址：/squad-business/socket/renameSquad

方式：GET

参数：

• podId（query）

• Authorization（header）

Media type：application/json

始终填满所有载具位置

地址：/squad-business/socket/forceAllVehicleAvailability

方式：POST

Example Value：

{
  "podId": "xxx",
  "value": "1"
}

Media type：application/json

取消部署要求限制

地址：/squad-business/socket/forceAllDeployableAvailability

方式：POST

Example Value：

{
  "podId": "xxx",
  "value": "1"
}

Media type：application/json

可以使用对方载具

地址：/squad-business/socket/disableVehicleTeamRequirement

方式：POST

Example Value：

{
  "podId": "xx",
  "value": ""
}

Media type：application/json

取消载具装限制

地址：/squad-business/socket/disableVehicleKitRequirement

方式：POST

Example Value：

{
  "podId": "xx",
  "value": "1"
}

Media type：application/json

设置服务器时间倍数（0-20倍）

地址：/squad-business/socket/slomo

方式：POST

Example Value：

{
  "podId": "xx",
  "value": "1"
}

Media type：application/json

取消复活时间

地址：/squad-business/socket/noRespawnTimer

方式：POST

Example Value：

{
  "podId": "xx",
  "value": "1"
}

Media type：application/json

重载配置文件

地址：/squad-business/socket/noRespawnTimer

方式：POST

Example Value：

{
  "podId": "xxx"
}

Media type：application/json

记录查询

击杀记录查询

地址：/squad-business/wound/page

方式：POST

Example Value：

{
  "podId": "19e82cd1-999f-48de-aa90-d680ddd2125b",
  "playerId": "00029e23825946af9073431ba5c3beff",
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

聊天记录查询

地址：/squad-business/chat/page

方式：POST

Example Value：

{
  "pageNo": 1,
  "pageSize": 10,
  "podId": "19e82cd1-999f-48de-aa90-d680ddd2125b",
  "contentApproved": true,
  "startTime": "2024-03-01 00:00:00",
  "endTime": "2024-03-11 00:00:00"
}

Media type：application/json

玩家信息查询

地址：/squad-business/player/page

方式：POST

Example Value：

{
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

玩家本局事件查询

地址：/squad-business/record/eventList

方式：GET

参数：

• podId（query）

• eosId（query）

• Authorization（header）

Media type：application/json

游戏记录

地址：/squad-business/history/page

方式：POST

Example Value：

{
  "playerId": "",
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

指令日志

地址：/squad-business/cmdLog/page

方式：POST

Example Value：

{
  "podId": "",
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

飞天记录

地址：/squad-business/camera/page

方式：POST

Example Value：

{
  "podId": "",
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

比赛记录查询

地址：/squad-business/match/page

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "podId": "f36e0452-88c0-4651-93b1-7c82bf5913c4",
  "keywords": "Narva",
  "pageNo": 1,
  "pageSize": 10
}

Media type：application/json

查询战绩信息

地址：/squad-business/record/listByMatchId

方式：GET

参数：

• matchId（query）

• Authorization（header）

Media type：application/json

玩家战绩分页查询

地址：/squad-business/record/page

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "pageNo": 1,
  "pageSize": 10,
  "steamId": "76561198183319294"
}

Media type：application/json

根据比赛ID查询当局详细事件

地址：/squad-business/record/eventListByMatchId

方式：GET

参数：

• eosId（query）

• matchId（query）

• Authorization（header）

Media type：application/json

根据 Steam ID 查询玩家信息

地址：/squad-business/player/getBySteamId

方式：GET

参数：

• steamId（query）

Media type：application/json

权限管理

新增权限组

地址：/squad-business/role/insert

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "roleCode": "test_role",
  "roleType": "op",
  "remark": "备注",
  "podId": "xxx",
  "joinMessage": "OP{0}进入服务器..."
}

Media type：application/json

修改权限组

地址：/squad-business/role/update

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "roleId": "88eca627-0295-44c6-87af-86088406f1b7",
  "roleCode": "test_role",
  "roleType": "op",
  "remark": "备注1",
  "podId": "xxx",
  "joinMessage": "OP{0}进入服务器..."
}

Media type：application/json

删除权限组

地址：/squad-business/role/delete

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "roleId": "88eca627-0295-44c6-87af-86088406f1b7"
}

Media type：application/json

分页查询

地址：/squad-business/role/page

方式：POST

Example Value：

{
  "pageNo": 1,
  "pageSize": 10,
  "podId": "xxxx",
  "keywords": ""
}

Media type：application/json

授权给玩家

地址：/squad-business/role/empower

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "playerKey": "xxxx",
  "roleId": "88eca627-0295-44c6-87af-86088406f1b7",
  "termDay": 0,
  "remark": "备注"
}

Media type：application/json

删除玩家

地址：/squad-business/role/deletePlayer

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "roleId": "88eca627-0295-44c6-87af-86088406f1b7",
  "playerKey": "xxxx"
}

Media type：application/json

查询角色玩家列表

地址：/squad-business/role/playerList

方式：GET

参数：

• roleId（query）

• keywords（query）

Media type：application/json

导入

地址：/squad-business/role/importCfg

方式：POST

参数：

• file（string）

• podId（string）

Media type：application/json

导出

地址：/squad-business/role/getAdminCfg

方式：GET

参数：

• podId（query）

Media type：application/json

保存角色权限

地址：/squad-business/role/savePermission

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "roleId": "",
  "permissionList": [
    "forceteamchange",
    "kick"
  ]
}

Media type：application/json

查看角色权限

地址：/squad-business/role/permissionList

方式：GET

参数：

• roleId（query）

Media type：application/json

批量修改玩家 角色时间

地址：/squad-business/role/savePermission

方式：POST

Example Value：

{
  "roleId": "xxx",
  "termDay": 0
}

Media type：application/json

设置

修改设置

地址：/squad-business/setting/modifySetting

方式：POST

参数：

• Authorization（header）

Example Value：

{
  "podId": "19e82cd1-999f-48de-aa90-d680ddd2125b",
  "setting": {
    "teamKillCheck": true,
    "teamKillMessage": "{0} tk 了{1},请在公屏道歉，否则将被踢出服务器",
    "maxTkNum": 6,
    "teamKillSorryTime": 2,
    "maxForceChangeNum": 5,
    "forceChangeTime": 5,
    "inactiveCheck": false,
    "inactiveTime": 10,
    "broadcastList": [
      "小雨棚插件2.0测试服"
    ],
    "autoReply": {
      "test": "测试"
    }
  }
}

Media type：application/json

获取设置

地址：/squad-business/setting/getByPodId

方式：GET

参数：

• podId（query）

Media type：application/json

地图池

地图分页查询

地址：/squad-business/map/page

方式：POST

Example Value：

{
  "pageNo": 1,
  "pageSize": 10,
  "keywords": "Ba"
}

Media type：application/json