BlackBE Wiki

# 私有仓库API

# [GET] /private/repositories/list 私有仓库列表

说明

查询用户私有仓库列表

注意

此API必须提交有效的APIToken

ep:https://api.blackbe.work/openapi/v3/private/repositories/list (opens new window)

# 可用参数

# 响应

{
    "success": true,
    "status": 2000,
    "message": "查询成功DeSu",
    "version": "v3.1",
    "codename": "Moriya Suwako",
    "time": 1640008037,
    "data": {
        "repositories_num": 1, //仓库数量
        "repositories_list": [
            {
                "uuid": "2b39814e-43f4-4921-af77-83cdb955e783", //仓库UUID
                "name": "测试云黑库", //仓库名字
                "type": 1, //仓库类型，1公开私有库，2不公开私有库
                "list_num": 2, //包含条目数量
                "server": "nyan.xyz:19132", //仓库服务器地址
                "server_type": "PocketMine-MP" //仓库服务器类型
            }
        ]
    }
}

# Status

Status Message 解释
2000 查询成功DeSu 查询成功
2001 你还没有创建云黑库哦 用户没有创建云黑库
4001 无效的Token APIToken无效/没有提交
5000 内部错误 服务器出错

# [GET] /private/repositories/piece/list 私有仓库条目列表

说明

查询私有云黑库条目列表

分页API

此API需要分页查询

注意

查询非公开私有库条目需要提交仓库所有者的APIToken

ep:https://api.blackbe.work/openapi/v3/private/repositories/piece/list?uuid=2b39814e-43f4-4921-af77-83cdb955e783&page=1&page_size=10 (opens new window)

# 可用参数

参数 类型 解释
uuid string 需要查询仓库的UUID
page string 页数(第X页)，不提交默认为1
page_size string 单页返回条目数量，不提交默认为10

# 响应

{
    "success": true,
    "status": 2000,
    "message": "查询成功DeSu",
    "version": "v3.1",
    "codename": "Moriya Suwako",
    "time": 1640010284,
    "data": {
        "repositories_name": "TestRepositories", //仓库名字
        "page_num": 1, //总页数
        "piece_num": 2, //条目数量(本次返回的条目数量，非总条目数量)
        "piece_list": [
            {
                "uuid": "f6b876a6-1ee1-47cb-87bc-e54dd5b310fd", //条目UUID
                "name": "TestPlayer", //玩家名字
                "xuid": "", //玩家XUID
                "info": "测试啦测试", //违规信息
                "time": "2021-12-11", //作案时间
                "level": 1, //违规等级
                "qq": 1012140043, //玩家QQ
                "area_code": "+86", //玩家手机号区号
                "phone": 10000000000 //玩家手机号
            },
            {
                "uuid": "e56fb342-09c8-4d2c-b6f1-bbc205c9ec2d",
                "name": "blackbetest",
                "xuid": "",
                "info": "开发者测试账号，有需要可以联系NyanCatda获取登陆方式!",
                "time": "2020-06-13",
                "level": 1,
                "qq": 100000,
                "area_code": "+86",
                "phone": 10000000000
            }
        ]
    }
}

# Status

Status Message 解释
2000 查询成功DeSu 查询成功
2001 此云黑库没有条目 查询的仓库没有条目
4000 请输入需要查询的仓库的UUID 没有提交仓库UUID
4040 查询的云黑库不存在 查询的云黑库不存在/查询非公开仓库没有提交APIToken/查询的非公开仓库不属于用户
5000 内部错误 服务器出错

# [POST] /private/repositories/piece/upload 上传私有仓库条目

说明

上传条目到私有仓库

注意

此API必须提交有效的APIToken

ep:https://api.blackbe.work/openapi/v3/private/repositories/piece/upload (opens new window)

# 可用参数

[Raw] [Json]

{
	"black_id": "265b66e7-9ca6-42a1-85b8-32687b0bc175", //需要上传的私有仓库的UUID
	"name": "TestPlayer", //玩家名字
	"xuid": "2533274792462486", //玩家XUID
	"info": "测试信息", //违规信息
	"server": "CatServer", //违规服务器
	"time": "2022-02-18", //作案时间
	"level": 1, //违规等级
	"qq": 1000000000, //玩家QQ号
	"area_code": "+86", //玩家手机号区号
	"phone": 10000000000 //玩家手机号
}

# 响应

{
    "success": true,
    "status": 2000,
    "message": "上传成功啦",
    "version": "v3.1",
    "codename": "Moriya Suwako",
    "time": 1645157404,
    "data": {
        "uuid": "ef775bdf-6fdb-4381-b79e-07bb1abebece" //本次上传条目的UUID
    }
}

# Status

Status Message 解释
2000 上传成功啦 上传成功
4001 无效的Token/无法解析Json 提交的参数有误
40321 上传的玩家信息重复了哦 上传的信息重复
40324 你不能上传不是自己的云黑库哦 没有被上传云黑库的权限
5000 内部错误 服务器出错

# [POST] /private/repositories/piece/delete 删除私有仓库条目

说明

删除一个私有仓库的条目

注意

此API必须提交有效的APIToken

ep:https://api.blackbe.work/openapi/v3/private/repositories/piece/delete (opens new window)

# 可用参数

[Raw] [Json]

{
	"piece_uuid": "d4a24289-b7b5-4292-a629-d53c2a75d85c" //需要被删除的条目的UUID
}

# 响应

{
    "success": true,
    "status": 2000,
    "message": "删除成功了",
    "version": "v3.1",
    "codename": "Moriya Suwako",
    "time": 1645157790,
    "data": []
}

# Status

Status Message 解释
2000 删除成功了 删除成功
4001 无效的Token/无法解析Json 提交的参数有误
40326 你不能删除不属于自己的云黑库的条目哦 没有条目所属云黑库的权限
4040 条目不存在 条目不存在
5000 内部错误 服务器出错

← 工具API →