MCBE(CN) OpenAPI

接口调用示例

概览

Base URL
https://hkapi.rufax.cn/api/open-api

查询服务器榜单列表榜单

请求方式
POST
请求 URL
/rental-server/query/available-by-sort-type
完整 URL
https://hkapi.rufax.cn/api/open-api/rental-server/query/available-by-sort-type

请求头

{
  "Content-Type": "application/json",
  "authorization": "string", // api-key
  "login-method": "pc" // "pc" 或 "pe"
}

请求体

{
  "sort_type": 0,  // 0-3:榜单类型
  "order_type": 0, // 正序或倒序
  "offset": 0      // 分页偏移量
}

响应示例

{
  "success": true,
  "data": {
    "total": "1", // 总数
    "entities": [
      {
        "status": 1, // 状态
        "pvp": true,
        "entity_id": "", //sid
        "player_count": 0, // 在线玩家
        "capacity": 10, // 人数容量
        "name": "", // 服号
        "world_id": "",
        "server_type": "docker_new_guian",
        "server_name": "", // 名称
        "mc_version": "", // 版本
        "min_level": 0, // 等级
        "visibility": 0,
        "icon_index": 3,
        "like_num": 0, // 点赞数
        "offset": 0,
        "image_url": "", //封面
        "has_pwd": "0", //是否有密码
        "owner_id":  //服主UID
      }
    ],
    "message": "正常返回",
    "code": 0,
    "details": ""
  }
}
请求示例(Python requests)
import requests, json

url = "https://hkapi.rufax.cn/api/open-api/rental-server/query/available-by-sort-type"
payload = {
    "sort_type":0,  #0-3,榜单类型
    "order_type":0, #正序或倒序
    "offset":0 #分页偏移量
}

headers = {
  'Content-Type': 'application/json',
  'authorization': '', #apikey
  'login-method': 'pc', #'pc' or 'pe'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload)).text
print(response)

按关键词或组件码搜索组件组件

请求方式
POST
请求 URL
/pe-item/query/search-by-keyword/
完整 URL
https://hkapi.rufax.cn/api/open-api/pe-item/query/search-by-keyword/

请求头

{
  "Content-Type": "application/json",
  "authorization": "string", // api-key
  "login-method": "pc" // "pc" 或 "pe"
}

请求体

{
  "second_type": [],               // 二级分类(数组),-1:本地地图,-2-本地材质,0-全部,1-闯关解谜,2-角色扮演,3-策略对战,4-建筑大观,5-其他地图,6-玩法拓展,7-原创道具,8-生物改造,9-其他功能,11-精美材质,12-炫酷光影,13-原版风格,14-科幻风格,15-神话风格,16-其他皮肤,17-,18-4D皮肤,19-特色组件,20-特色生物,22-一键生成
  "official_skin": 0,
  "filter_domain_server_item": 0,
  "sort_type": 0,
  "first_type": 0,                 // 0-全部,1-游戏地图,2-功能玩法,3-材质光影,4-皮肤,5-春节礼包,6-联机地图,7-persona,8-组合包,101-persona套装,999-联动内容
  "offset": 0,                     // 分页偏移量
  "keyword": "宝可梦",             // 搜索关键词或组件码
  "price_type": 0,
  "init": 0,
  "channel_id": 5,
  "length": 15                     // 每页长度
}

响应示例

{
  "success": true,
  "data": {
    "total": "1",
    "entities": [
      {
        "developer_urs": "", // 邮箱
        "special_discount_activity": 0,
        "lottery_id": "0",
        "pay_channel": "",
        "remark_num": 0,
        "res_md5": "",
        "is_lottery_reward": "0",
        "rebate_max_num": 0,
        "week_download_num": "0",
        "source": "low",
        "mod_version": "",
        "effect_stypeid": 0,
        "buy_state": 0,
        "item_remain_time": 0,
        "is_top": 1,
        "first_type": 0, //0-全部,1-游戏地图,2-功能玩法,3-材质光影,4-皮肤,5-春节礼包,6-联机地图,7-persona,8-组合包,101-persona套装,999-联动内容
        "discount_end_time": 0,
        "refund_info": {},
        "performance_distribution": null,
        "demo_id": "0",
        "is_joint": 0,
        "effect_mtypeid": 0,
        "is_vip_benefit": 0,
        "activity_only": 0,
        "dyeing": "",
        "vip_discount": 0,
        "score_player_num": 0,
        "behavior_packs_version": "",
        "perf_params": null,
        "pvp": true,
        "mod_second_type": 0,
        "is_competitive": 0,
        "skin_body_type": 0,
        "rebate_activity_id": "0",
        "performance_score": 0,
        "tExpire": 0,
        "tBuy": 0,
        "score_trend_json": null,
        "is_item_time_limit": 0,
        "normal_number": "",
        "title_image_url": "", // 封面
        "adv_obtain_num": 0,
        "discount": 0,
        "vanity_number": "",
        "rel_iid": "0",
        "item_id": "",
        "product_id": "",
        "item_pack_iids": [],
        "suit_id": "0",
        "rebate_discount_num": 0,
        "creativity_score": 0,
        "creativity_distribution": null,
        "entity_id": "",
        "resource_packs_version": "",
        "visual_distribution": null,
        "season_begin": "0",
        "label_type_list": null,
        "is_ea": 0,
        "download_num": "", // 下载量
        "stars": 0,
        "jelly_id": "",
        "is_persona": "0",
        "second_type": 0, // -1:本地地图,-2-本地材质,0-全部,1-闯关解谜,2-角色扮演,3-策略对战,4-建筑大观,5-其他地图,6-玩法拓展,7-原创道具,8-生物改造,9-其他功能,11-精美材质,12-炫酷光影,13-原版风格,14-科幻风格,15-神话风格,16-其他皮肤,17-,18-4D皮肤,19-特色组件,20-特色生物,22-一键生成
        "diamond": 0,
        "playability_score": 0,
        "is_domain_server_item": 0,
        "goods_state": 1,
        "rec_info": [],
        "playing_uuid": "",
        "rarity": "0",
        "is_official_item": 0,
        "season_mod_id": "0",
        "res_size": "",
        "cur_num": 0,
        "sell_tags": [],
        "is_recommend": 0,
        "res_name": "", // 组件名称
        "playability_distribution": null,
        "vip_only": false,
        "behaviour_uuid": "",
        "rebate_tag": 0,
        "last_opr_time": 0,
        "non_support_mod_versions": "",
        "developer_name": "", // 开发者
        "res_version": "19",
        "visual_score": 0,
        "pic_tag_state": "0",
        "status": 1,
        "title_image_version": 2,
        "is_sync": 0,
        "persona_stypeid": "0",
        "persona_mtypeid": "0",
        "exchange_type": 0,
        "is_vertical_item": 0,
        "points": 0,
        "is_wish": 0,
        "lobby_tag": []
      }
    ],
    "message": "正常返回",
    "code": 0,
    "details": ""
  }
}
请求示例(Python requests)
import requests, json

url = "https://hkapi.rufax.cn/api/open-api/pe-item/query/search-by-keyword/"
payload = {
    "second_type": [],
    "official_skin": 0,
    "filter_domain_server_item": 0,
    "sort_type": 0,
    "first_type": 0, # 0-全部,1-游戏地图,2-功能玩法,3-材质光影,4-皮肤,5-春节礼包,6-联机地图,7-persona,8-组合包,101-persona套装,999-联动内容
    "offset": 0,
    "keyword": "宝可梦", #搜索关键词或组件码
    "price_type": 0,
    "init": 0,
    "channel_id": 5,
    "length": 15 #每页长度
}
headers = {
  'Content-Type': 'application/json',
  'authorization': '', #apikey
  'login-method': 'pc', #'pc' or 'pe'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload)).text
print(response)

按关键词搜索开发者开发者

请求方式
POST
请求 URL
/pe-developer-homepage/search_developer_by_keyword
完整 URL
https://hkapi.rufax.cn/api/open-api/pe-developer-homepage/search_developer_by_keyword

请求头

{
  "Content-Type": "application/json",
  "authorization": "string", // api-key
  "login-method": "pc" // "pc" 或 "pe"
}

请求体

{
  "length": 15,   // 每页长度
  "keyword": "",  // 搜索关键词
  "offset": 0     // 分页偏移量
}

响应示例

{
  "success": true,
  "data": {
    "total": 1,
    "entities": [
      {
        "developer_urs": "", // 邮箱
        "author_info": "",
        "level": "0", // 等级
        "credit_score": "0",
        "current_level": 1,
        "current_class": 1,
        "developer_type": "other_individual",
        "developer_name": "", //开发者名称
        "headimg": "", // 开发者头像
        "official_level": "0",
        "recommend_reason": "",
        "back_image": "",
        "official_recommend": "0",
        "_id": "", // 开发者ID
        "class_name": "元气新星",
        "fellow_num": "0"
      }
    ],
    "message": "正常返回",
    "code": 0,
    "details": ""
  }
}
请求示例(Python requests)
import requests, json

url = "https://hkapi.rufax.cn/api/open-api/pe-developer-homepage/search_developer_by_keyword"
payload = {
    "length": 15, #每页长度
    "keyword": "", #搜索关键词
    "offset": 0 #分页偏移量
}

headers = {
  'Content-Type': 'application/json',
  'authorization': '', #apikey
  'login-method': 'pc', #'pc' or 'pe'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload)).text
print(response)