排行榜
baseUrl :https://www.oauthapp.com
榜单需要使用oauthapp发布工具创建。
榜单集合
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppRank/:appId/Tables | :appId 部分需要替换为实际应用的 ID |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 数据表集合的数组,每个数组元素代表1个榜单名称 |
err | 错误信息 |
榜单统计
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppRank/:appId/:table/Report | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际的榜单名称 |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 具体包含count、totalScore、maxScore、minScore 和 avgScore |
err | 错误信息 |
{
"code": 200,
"data": {
// 总数据条数
"count": 4,
// 总分数
"totalScore": 48,
// 最高分
"maxScore": 22,
// 最低分
"minScore": 3,
// 平均分
"avgScore": 12
},
"err": ""
}
榜单数据
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppRank/:appId/:table?pltform=&unionId&nickName&tag&skip=0&take= | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际的榜单名称 |
登陆凭证 | Bearer Token | |
参数说明 |
||
platform | 字符串类型,可选,第三方平台标识字符串, | 如"web"、"weibo"、"wexin"、"qq"等。如果不传递该参数,则默认为"web",表示当前应用的网站平台。 |
unionId | 字符串类型,可选,第三方平台的用户ID。 | 如果不传递该参数,则默认为当前登录用户的ID。 |
nickName | 字符串类型,可选,用户昵称。 | |
tag | 字符串类型,可选,自定义标签。 | |
skip | 数字类型,可选,表示要跳过的记录数 | 默认为0 |
take | 数字类型,可选,表示要获取的记录数 | 默认为10 |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 具体包含 total 、data、take和skip |
err | 错误信息 |
{
"code": 200,
"data": {
"total": 4,
"data": [
{
"id": 2,
"userID": 1,
"tags": "",
"data": "",
"remark": "",
"unionID": "15f51ff96acb3f85cdcf4383e879d8d6",
"platform": "web",
"avatar": "https://2.fs.oauthapp.com/__ranks/user.png",
"nickName": "",
"score": 22,
"maximumScore": 22,
"showIndex": 0,
"createDate": "2022-11-25 14:00:56",
"lastUpdate": "2022-12-09 15:35:23"
},
{
"id": 4,
"userID": 2,
"tags": "",
"data": "",
"remark": "",
"unionID": "15f51ff96acb3f85cdcf4383e879d8d6",
"platform": "web",
"avatar": "https://2.fs.oauthapp.com/__ranks/user.png",
"nickName": "",
"score": 22,
"maximumScore": 22,
"showIndex": 0,
"createDate": "2022-11-25 14:00:56",
"lastUpdate": "2022-12-09 15:35:23"
}
],
"take": 30,
"skip": 0
},
"err": ""
}
提交分数
描述 | ||
---|---|---|
请求方式 | PUT | |
请求地址 | {{baseUrl}}/api/AppRank/:appId/:table | :appId 部分需要替换为实际应用的 ID |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | true 或 false |
err | 错误信息 |
用户排名
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppRank/:appId/:table/UserRank?platform=&unionID= | :appId 部分需要替换为实际应用的 ID |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 具体包含unionID、avatar、nickName、data、score、maximumScore、betterRankIndex、rankIndex、rankTotalCount 和 beyoundPercent |
err | 错误信息 |