简介
本API接口由作者“空桑”开发提供,仅用于GTAOnline线上模式玩家角色数据信息查询,可用于对接QQ机器人,也可对接单独开发的应用程序。
温馨提示:对接此API接口请注明署名“数据来源于空桑的洛圣都Express”,谢谢合作。
站长对接制作成品展示
成品程序展示
API对接
获取玩家数据
路径:/api/status
请求方式:[GET]
参数
字段名 | 数据类型 | 默认值 | 说明 |
nickname | string | - | 玩家昵称 |
limit | number | 20 | 最大数据请求记录 |
可能存在的非预期返回
错误代号 | 错误代码 | 原因 |
BadRequset | 400 | 输入错误的昵称 |
如果不存在对应帐号的查询记录将不会返回数据。
响应数据[json]:
字段名 | 数据类型 | 默认值 | 说明 |
昵称 | string | - | 传入后经校验的昵称 |
Rockstar_ID | number | - | R星ID(帐号身份证) |
状态更新 | string | - | 玩家状态更新时间 |
最近游玩 | string | - | 最近游玩时间 |
简介 | string | - | 玩家个人中心简介 |
当前帮会 | string | - | 设置的当前活跃帮会名称 |
鲨鱼卡 | string | - | 已在空桑处登记的鲨鱼卡记录证明 |
不计入收入 | string | - | 黑钱(非正常来源或官方活动赠送的金币) |
所在地 | string | - | 翻译后的所在地 |
所在地代码 | string | - | 所在地代码 |
所在帮会 | string | - | 玩家加入的帮会记录 |
曾用昵称 | formerName | - | 查询依据R星ID记录匹配 |
拥有游戏 | gameOwn | - | 该玩家已购买Rockstar开发制作的相关游戏 |
绑定账户 | linkAccount | - | 该玩家所绑定的Steam或Epic平台账户信息 |
数据记录 | record | - | 查询数据的记录 |
响应示例[formerName]
["formername1", "formername2"]
响应示例[gameOwn]
[
{
"游戏昵称": "GTAV",
"游戏平台": "PC",
"上次游玩": "2019-1-1"
}
]
响应示例[linkAccount]
[
{
"平台": "Steam",
"昵称": "114514",
"编号": "1919810"
}
]
响应示例[record]
[
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
]
获取玩家有效内最新数据
路径:/api/recent
请求方式:[GET]
参数
字段名 | 数据类型 | 默认值 | 说明 |
nickname | string | - | 玩家昵称 |
expire | number | 7200 | 数据有效期(秒) |
platform | string | "default" | 游戏平台 |
type | string | "index" | 数据返回类型 |
可能存在的非预期返回:
错误代号 | 错误代码 | 原因 |
BadRequset | 400 | 输入了错误的昵称 |
SeeOther | 303 | 无法查询到有效期内的数据 |
响应数据[json]:
type=index
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
响应数据[string]:
type=text
昵称: xxxx
角色创建: 2024-01-01
帮会: 洛圣都居民网
等级: 1
在线时长: 1小时
... ...
平台: PC
规则版本: 3.0.0
索引: ACBDEF
响应数据[string]:
type=detail
比text更加详细的内容
对接提示
如果有效期内没有可有数据,那么会返回非 200 响应码
获取玩家数据快照
路径:/api/index
请求方式:[GET]
参数
字段名 | 数据类型 | 默认值 | 说明 |
index | string | - | 数据快照索引 |
type | string | "index"/"text"/"detail" | 返回数据类型 |
可能存在的非预期返回:
错误代号 | 错误代码 | 原因 |
BadRequset | 400 | 输入了错误的索引 |
响应数据[json/text]:
响应数据[json/text]:
申请更新玩家数据快照
路径:/api/post
请求方式:[GET]
参数
字段名 | 数据类型 | 默认值 | 说明 |
nickname | string | - | 玩家昵称 |
platform | string | "default" | 游戏平台 |
可能存在的非预期返回:
错误代号 | 错误代码 | 原因 |
BadRequset | 400 | 输入了错误的昵称 |
SeeOther | 303 | 上一条数据未过最短有效期 |
获取玩家数据查询记录
路径:/api/history
请求方式:[GET]
参数
字段名 | 数据类型 | 默认值 | 说明 |
nickname | string | - | 玩家昵称 |
offset | number | 0 | 返回数据起点 |
limit | number | 50 | 最大返回数据量 |
type | string | "text"/"json" | 返回类型 |
可能存在的非预期返回:
错误代号 | 错误代码 | 原因 |
BadRequset | 400 | 输入了错误的昵称 |
InternalServerError | 500 | 服务器数据处理出错 |
响应数据[json/text]:
字段名 | 数据类型 | 默认值 | 说明 |
数据记录 | record | - | 与玩家数据查询接口一致 |
响应示例[record
]
type=json
[
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
]
type=text
索引: 1919810
时间: 2021-01-01 01:01:01
状态: 可用
代号: 200
索引: 114514
时间: 2020-01-01 01:01:01
状态: 可用
代号: 200
API接口对接例子
API请求地址:https://hqshi.cn/
地址+路径+参数A=值A+参数B=值B
路径=“/foo/bar”
参数A=“a”
值A=“y”
参数B=“b”
值B=“x”
#最终结果:[GET] https://hqshi.cn/foo/bar?a=y&b=x
举例:https://hqshi.cn/api/status?nickname=YUHANY06 (最后的“YUHANY06”是一位玩家的游戏ID)
查询结果
{"code": 200, "payload": true, "message": "请求成功", "body": {"昵称": "yuhany06", "名称": "YUHANY06", "玩家标识": "NETKXF", "rockstar_id": 187777753, "状态更新": "2022-08-11 11:26:26", "最近游玩": "GTAV | PC", "简介": null, "当前帮会": "IGN Crew", "鲨鱼卡": null, "不计入统计收入": null, "所在地": "中国", "所在地代码": "CN", "所在帮会": null, "曾用昵称": null, "拥有游戏": [{"游戏名称": "GTAV", "游戏平台": "PC", "上次游玩": "2024-04-24"}, {"游戏名称": "RDR2", "游戏平台": "PC", "上次游玩": "2024-04-20"}], "绑定账户": null, "备注": null, "数据记录": [{"索引": "FPY2P7", "时间": "2024-05-23 10:12:15", "状态": "可用", "代号": 200}, {"索引": "A6AJWB", "时间": "2022-09-07 15:03:25", "状态": "可用", "代号": 200}, {"索引": "BKAWCG", "时间": "2022-08-11 11:26:25", "状态": "可用", "代号": 200}]}}
以上截图便是请求API查询的最终结果,具体如何设计程序由您来完成,我只负责分享接口和例子。
目前我所知对接了此API的成品程序只有我自己做的盒子里面加了这个查询,原本我是有想过做Q群机器人的,但又觉得Q群机器人给群友玩纯属就是闲着无聊乱刷屏,所以也就没有做,如果你需要也可以拿去对接个机器人玩玩。
接口分享:木果资源分享博客
接口来源:洛圣都Express(空桑提供)
友情提示:作者制作不易,一定要给作者加上来源署名。