Appearance
开放接口
目前不需要申请权限!
为什么只开放了这些接口?有些接口只返回本文数据?
现有接口已满足数据查询所需,有更多需求可以联系作者咨询。查询程序的最终目的是为了数据审核,为了尽量保证输出数据的有效性,因此只提供预处理好的文本化数据
默认主机地址是 https://hqshi.cn(接口升级、暂时废弃),调用接口需要组合使用主机地址与下文给出的终结点和参数
python
# 这是个例子,实际无法访问
主机地址 = "https://hqshi.test"
终结点 = "/foo/bar"
参数甲 = "a"
值甲 = "x"
参数乙 = "b"
值乙 = "z"
最终地址 = f"{主机地址}{终结点}?{参数甲}={值甲}&{参数乙}={值乙}"
# 最终拼接得到的网址 => [GET] https://hqshi.test/foo/bar?a=x&b=y
简介
接口展示模板
终结点:/foo/bar
请求方法:[GET/POST]
参数:
GET 入参方式为 params,POST 入参方式为 form
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
a | string | - | a prama |
b | number | - | a prama |
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
HTTP 状态码 | 三位数字 | 原因 |
响应数据[json/text]:
当参数某某为某某时
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
a | string | - | a prama |
b | number | - | a prama |
响应示例[默认响应模板
]
json
{
"code": 200, # 自定义状态码
"payload": false, # 存在body参数时为 true
"message": "请求成功", # 提示信息
"body": {"k":"v"}, # 存在响应数据时才显示,响应数据的默认存储位置!!!
}
提示
API 一定不返回有意义的数据,请求可能是异步的
权限令牌细节
令牌有效期为 1 天,超期请求会自动跳转至重新授权页面通过设置Cookies
的方式对权限进行续期。请注意,续期后只有GET
请求会重定向至原有请求页面再次请求数据
速度限制方式为 IP + 用户名混合去重后进行计算,具体请参见接口限速
如何申请口令
终结点:/authorize
请求方法:[POST]
参数:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
user | string | - | 用户名,需申请 |
password | string | - | 密码 |
响应示例[默认响应模板
]
json
{
"code": 200,
"payload": true
"message": "请求成功",
"body": "ATokenExample.HashSign"
}
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
BasRequest | 400 | 未提供合适的参数 |
Unauthorized | 401 | 缺少所需的口令或口令不正确 |
Forbidden | 403 | 口令续期被拒绝 |
TooManyRequests | 429 | 请求次数超过限制 |
提示
请求成功后会在响应头的 Set-Cookies 字段中设置名为
Token
的 Cookie,也会在返回的 body 中返回 Token 的值
账号申请方式
目前不做强制校验,匿名访问也可,未来将会在关键接口添加强制校验。有具体意向可点击页面下方的邮件细聊
API
部分接口可能需要申请权限。在 Cookies 或者 Headers 中附带键为"Token"、值为口令的键值对即可
匿名用户和小程序使用者具有相同的权限,限速也是相同的配置。申请授权和请求服务器查询新玩家数据的速度限制目前都是一小时 10 次,未特殊标注的接口共享 10 分钟 60 次请求的限速
获取玩家数据记录
终结点:/api/status
请求方法:[GET]
参数:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
nickname | string | - | 玩家昵称 |
limit | number | 20 | 最大数据请求记录 |
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
BadRequset | 400 | 输入了错误的的昵称 |
如果不存在对应账号的查询记录,将不会返回数据
响应数据[json]:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
昵称 | string | - | 传入后经校验的昵称 |
rockstar_id | number | - | 即 rid |
状态更新 | string | - | 玩家状态更新时间 |
最近游玩 | string | - | 最近游玩时间 |
简介 | string | - | 玩家个人简介 |
当前帮会 | string | - | 当前加入帮会 |
鲨鱼卡 | string | - | 登记的鲨鱼卡 |
不计入统计收入 | string | - | 登记的黑钱 |
所在地 | string | - | 翻译后的所在地 |
所在地代码 | string | - | 所在地代码 |
所在帮会 | string | - | 加入的帮会记录 |
曾用昵称 | formerName | - | 查询程序依据 rid 和记录匹配 |
拥有游戏 | gameOwn | - | - |
绑定账户 | linkAccount | - | - |
数据记录 | record | - | - |
响应示例[formerName
]
json
["formername1", "formername2"]
响应示例[gameOwn
]
json
[
{
"游戏昵称": "GTAV",
"游戏平台": "PC",
"上次游玩": "2019-1-1"
}
]
响应示例[linkAccount
]
json
[
{
"平台": "Steam",
"昵称": "114514",
"编号": "1919810"
}
]
响应示例[record
]
json
[
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
]
提示
该 API 只能使用 GET 请求
获取玩家有效内最新数据
终结点:/api/recent
请求方法:[GET]
参数:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
nickname | string | - | 玩家昵称 |
expire | number | 7200 | 数据有效期(秒) |
platform | string | "default" | 游戏平台,暂时没有意义 |
type | string | "index" | 返回数据类型 |
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
BadRequset | 400 | 输入了错误的的昵称 |
SeeOther | 303 | 无法查询到指定有效期内的数据 |
响应数据[json]:
type=index
json
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
响应数据[string]:
type=text
text
昵称: xxxx
角色创建: 2020-01-01
帮会: 佩恩杀手
等级: 1
在线时长: 1小时
... ...
平台: PC
规则版本: 3.0.0
索引: ACBDEF
响应数据[string]:
type=detail
text
比text更加详细的内容
提示
如果有效期内没有可有数据,那么会返回非 200 响应码
获取玩家数据快照
终结点:/api/index
请求方法:[GET]
参数:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
index | string | - | 数据快照索引 |
type | string | "index"/"text"/"detail" | 返回数据类型 |
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
BadRequset | 400 | 输入了错误的的索引 |
响应数据[json/text]:
请求玩家最新数据
与 查询玩家数据快照接口
所使用的内部数据处理接口一致,因此返回数据也也一致
提示
该 API 不返回有意义数据
申请更新玩家数据快照
终结点:/api/post
请求方法:[GET]
参数:
字段名 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
nickname | string | - | 玩家昵称 |
platform | string | "default" | 游戏平台,暂时无法指定 |
可能存在的非预期返回:
错误代号 | 错误代码 | 可能的原因 |
---|---|---|
BadRequset | 400 | 输入了错误的的昵称 |
SeeOther | 303 | 上一条有效数据未过最短有效期 |
提示
该 API 不会同步返回数据!在未来可能需要强制校验口令
获取玩家数据查询记录
终结点:/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
json
[
{
"索引": "114514",
"时间": "2021-01-01 01:01:01",
"状态": "可用",
"代号": "200"
}
]
type=text
text
索引: 1919810
时间: 2021-01-01 01:01:01
状态: 可用
代号: 200
索引: 114514
时间: 2020-01-01 01:01:01
状态: 可用
代号: 200
提示
该接口仅用来查询玩家历史数据查询记录