# 工具API

这里记录了一些由BlackBE团队提供的工具API

[GET] /utils/xuid 通过Xbox玩家代号查询XUID
[GET] /utils/bds/download 获取BDS下载链接
[GET] https://motdbe.blackbe.work/api 获取基岩版服务器的状态
[GET] https://motdbe.blackbe.work/api/java 获取Java版服务器的状态
[GET] https://motdbe.blackbe.work/status_img 生成基岩版服务器状态图片
[GET] https://motdbe.blackbe.work/status_img/java 生成Java版服务器状态图片

# [GET] /utils/xuid 通过Xbox玩家代号查询XUID

说明

通过Xbox Live玩家代号(Xbox Live Gamertag)查询对应的XUID

ep: https://api.blackbe.work/openapi/v3/utils/xuid?gamertag=blackbetest (opens new window)

# 可用参数

参数	类型	解释
gamertag	string	Xbox Live玩家代号(Xbox Live Gamertag)

# 响应

{
	"success": true,
	"status": 2000,
	"message": "查询成功",
	"version": "v3.1",
	"codename": "Moriya Suwako",
	"time": 1641304631,
	"data": {
		"xuid": "2535424045177658" //XUID
	}
}

# Status

Status	Message	解释
2000	查询成功	查询成功
2001	查询的玩家不存在	查询的玩家不存在
4001	请输入需要查询的玩家代号	参数为空
5005	请求失败，服务端出现错误	服务器出错

# [GET] /utils/bds/download 获取BDS下载链接

说明

# 可用参数

参数	类型	解释
os	string	操作系统，可选`windows`和`ubuntu`
jump	bool	是否直接302重定向到下载链接

# 响应

{
    "success": true,
    "status": 2000,
    "message": "OK",
    "version": "v3.1.0",
    "codename": "Moriya Suwako",
    "time": 1659197507,
    "data": {
        "url": "https://minecraft.azureedge.net/bin-win/bedrock-server-1.19.11.01.zip", // 下载链接
        "version": "1.19.11.01" // 版本号
    }
}

# Status

Status	Message	解释
2000	OK	获取成功
4001	请输入正确的Jump参数	参数不正确
5005	请求失败，服务端出现错误	服务器出错

# [GET] https://motdbe.blackbe.work/api 获取基岩版服务器的状态

说明

通过UDP协议获取基岩版服务器的状态

在线查询工具

http://motdbe.blackbe.work (opens new window)

ep: https://motdbe.blackbe.work/api?host=play.easecation.net:19132 (opens new window)

# 可用参数

参数	类型	注释
host	string	服务器地址

# 响应

{
    "status": "online", //服务器状态
    "host": "play.easecation.net:19132", //返回查询Host
    "motd": "§l§aEase§6Cation§r§3 §r§7§kEC§r §l§6BUILD BATTLES§r §7§kEC§r", //Motd
    "agreement": 503, //协议版本
    "version": "1.18.30", //客户端版本
    "online": 17, //服务器在线人数
    "max": 5000, //服务器人数上限
    "level_name": "Powered by Nemisys", //存档名称 (Motd 2)
    "gamemode": "Survival", //游戏模式
    "server_unique_id": "1716375064464556351", // 服务器唯一ID
    "delay": 32 //连接服务器延迟(ms)
}

# [GET] https://motdbe.blackbe.work/api/java 获取Java版服务器的状态

说明

通过TCP协议获取Java版服务器的状态

在线查询工具

http://motdbe.blackbe.work (opens new window)

ep: https://motdbe.blackbe.work/api/java?host=mc.hypixel.net:25565 (opens new window)

# 可用参数

参数	类型	注释
host	string	服务器地址

# 响应

{
    "status": "online", //服务器状态
    "host": "mc.hypixel.net:25565", //返回查询Host
    "motd": "A Minecraft Server", //服务器广播内容Motd
    "agreement": 756, //协议版本
    "version": "1.17.1", //客户端版本
    "online": 1, //服务器在线人数
    "max": 50, //服务器人数上限
    "sample": [
        {
            "id": "2af7c37c-f9cd-3524-a8eb-2550408c7a8f", //玩家ID
            "name": "Puppet2299" //玩家名字
        },
    ], //在线玩家列表，没有玩家则会返回null
    "favicon": "data:image/png;base64,...", //服务器图标(base64)
    "delay": 110 //连接服务器延迟(ms)
}