彩虹六号战绩查询开发文档

  • 此文档为彩虹六号战绩查询开发版文档 第一版 仅适用于项目维护开发人员
  • 更新时间 2019年3月11日

API 说明

目前此项目的API分为三类分别是用户信息类 , 游戏数据类 , 数据更新类

用户信息

当前API可实现 根据用户名获取ID , 查询用户的彩虹六号启动信息 , 查询用户的其他平台

根据用户名获取ID

请求地址:

https://api.forgiveher.cn/rainbow/user/get/id

支持格式:

JSON

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
name true string 需要查询的用户名
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
6
7
8
9
10
11
12
{
"profiles": [
{
"profileId": "6499575f-44f1-4d34-a521-8572c7ad6a19",
"userId": "6499575f-44f1-4d34-a521-8572c7ad6a19",
"platformType": "uplay",
"idOnPlatform": "6499575f-44f1-4d34-a521-8572c7ad6a19",
"nameOnPlatform": "Python.org"
}
],
"success": true
}

返回字段说明:

类型 说明
profiles json 用户平台的数组信息
prorfileId string 用户的 profileId 与 userId 一致
userId string 用户的 userId 与 profileId 一致
platformType string 查询的用户所在的平台
idOnPlatform string 用户在平台上的 ID
nameOnPlatform string 用户在平台上的用户名
success bool 查询请求是否成功

查询用户的彩虹六号启动信息

请求地址:

https://api.forgiveher.cn/rainbow/user/get/application

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
6
{
"success": true,
"first": "2018-08-02 04:02:40",
"last": "2018-08-10 20:05:18",
"count": 29
}

返回字段说明:

类型 说明
success bool 查询请求是否成功
first string 用户第一次启动彩虹六号的时间
last string 用户最后一次启动彩虹六号的时间
count int 用户启动彩虹六号的次数

查询用户其他平台账号

请求地址:

https://api.forgiveher.cn/rainbow/user/get/platform

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)

返回示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"profiles": [
{
"profileId": "bc5c03a4-2327-4f7a-a791-04c12debe3dd",
"userId": "bc5c03a4-2327-4f7a-a791-04c12debe3dd",
"platformType": "uplay",
"idOnPlatform": "bc5c03a4-2327-4f7a-a791-04c12debe3dd",
"nameOnPlatform": "GoLang.org"
},
{
"profileId": "cee54733-05d2-4d5b-bec9-b6e4db8a586c",
"userId": "bc5c03a4-2327-4f7a-a791-04c12debe3dd",
"platformType": "steam",
"idOnPlatform": "76561198864553797",
"nameOnPlatform": "76561198864553797"
}
],
"success": true
}

返回字段说明:

类型 说明
profiles json 用户平台的数组信息
prorfileId string 用户的 profileId 与 userId 一致
userId string 用户的 userId 与 profileId 一致
platformType string 查询的用户所在的平台
idOnPlatform string 用户在平台上的 ID
nameOnPlatform string 用户在平台上的用户名
success bool 查询请求是否成功

游戏数据

当前API可实现 获取用户的 PVE 最高得分信息 , 获取用户的 PVP 最高得分信息

获取用户 PVE 最高得分

请求地址:

https://api.forgiveher.cn/rainbow/pve/score

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
6
7
8
9
10
{
"success": true,
"userID": "d065fc0e-0d1b-45de-8267-0ab87bfaec56",
"nzgl": 943,
"kngl": 0,
"ptgl": 20000,
"nzhz": 2680,
"knhz": 2818,
"pthz": 2649
}

返回字段说明:

类型 说明
success bool 查询请求是否成功
userID string 所查询用户的userId
nzgl int 用户拟真孤狼模式的得分
kngl int 用户困难孤狼模式的得分
ptgl int 用户普通孤狼模式的得分
nzhz int 用户拟真合作模式的得分
knhz int 用户困难合作模式的得分
pthz int 用户普通合作模式的得分

获取用户 PVP 最高得分

请求地址:

https://api.forgiveher.cn/rainbow/pvp/score

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
6
7
{
"success": true,
"userID": "d065fc0e-0d1b-45de-8267-0ab87bfaec56",
"boom": 7492,
"secure": 5880,
"hostage": 8194
}

返回字段说明:

类型 说明
success bool 查询请求是否成功
userID string 所查询用户的userId
boom int 用户炸弹模式的得分
secure int 用户肃清威胁的得分
hostage int 用户保护人质的得分

数据更新

当前API可实现 更新用户的 PVP 数据 , 更新用户的 PVE 数据 , 更新用户的 Rank 数据

更新用户的 Rank 数据

请求地址:

https://api.forgiveher.cn/rainbow/rank/update

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
6
7
{
"results": {
"ncsa": "{\"success\": true, \"region\": \"ncsa\", \"msg\": \"[Update] d065fc0e-0d1b-45de-8267-0ab87bfaec56 ncsa rank data.\", \"time\": 1552306603.9727173}",
"emea": "{\"success\": true, \"region\": \"emea\", \"msg\": \"[Update] d065fc0e-0d1b-45de-8267-0ab87bfaec56 emea rank data.\", \"time\": 1552306605.8566387}",
"apac": "{\"success\": true, \"region\": \"apac\", \"msg\": \"[Update] d065fc0e-0d1b-45de-8267-0ab87bfaec56 apac rank data.\", \"time\": 1552306608.2685604}"
}
}

返回字段说明:

类型 说明
results json 用户排位信息更新结果数组
ncsa json 用户美服排位更新结果信息
emea json 用户欧服排位更新结果信息
apac json 用户亚服排位更新结果信息
success bool 数据更新请求是否成功
region string 用户所在的游戏区服
msg string 查询的结果信息
time float 查询数据的时间

更新用户的 PVP 数据

请求地址:

https://api.forgiveher.cn/rainbow/pvp/update

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
{
"success": true,
"msg": "[Update] bdd408df-c8fc-4304-a3cf-f070c988b610 pvp data.",
"time": 1552389757.41531
}

返回字段说明:

类型 说明
success bool 数据更新请求是否成功
msg string 查询的结果信息
time float 查询数据的时间

更新用户的 PVE 数据

请求地址:

https://api.forgiveher.cn/rainbow/pve/update

支持格式:

json

HTTP 请求方式:

GET

请求参数:

必选 范围及类型 说明
profile true string 需要查询的用户的profile(userId)
platform true string 查询所指定的平台范围 , 当前平台有 Uplay , Psn, Xbl

返回示例:

1
2
3
4
5
{
"success": true,
"msg": "[Update] bdd408df-c8fc-4304-a3cf-f070c988b610 pve data.",
"time": 1552389894.4672287
}

返回字段说明:

类型 说明
success bool 数据更新请求是否成功
msg string 查询的结果信息
time float 查询数据的时间