PaiGramTeam/mihoyo-api-collect
3
0
Fork 0
mirror of https://github.com/PaiGramTeam/mihoyo-api-collect.git synced 2024-11-21 22:58:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/Kamisato-Ayaka-233/mihoyo-api-collect

Browse Source
This commit is contained in:
Kamisato-Ayaka-233 2023-08-25 21:10:55 +08:00
commit 71cd6c0854
1 changed files with 161 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

320
other/launcher.md
View File

@ -18,105 +18,105 @@ _请求方式：GET_
**参数：**
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
| language | str | 返回文本语言的国家代码 | 国服仅支持中文（zh-cn） |
| filter_adv | bool | 是否不获取资讯信息 | 留空则返回所有信息，即`false` |
| 字段 | 类型 | 内容 | 备注 |
|-------------|------|-------------|--------------------|
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
| language | str | 返回文本语言的国家代码 | 国服仅支持中文（zh-cn） |
| filter_adv | bool | 是否不获取资讯信息 | 留空则返回所有信息，即`false` |
**JSON返回：**
根对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| retcode | num | 返回码<br>-204 请求参数`launcher_id`的值无效<br>-205 请求参数`key`的值无效 | |
| message | str | 返回消息 | |
| data | obj | 推荐信息 | 若请求参数中的`language`为不支持的语言，则所有数据均为空与空数组 |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|---------------------------------------------------------|---------------------------------------|
| retcode | num | 返回码<br>-204 请求参数`launcher_id`的值无效<br>-205 请求参数`key`的值无效 | |
| message | str | 返回消息 | |
| data | obj | 推荐信息 | 若请求参数中的`language`为不支持的语言，则所有数据均为空与空数组 |
`data`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| adv | obj | 背景图片信息 | |
| banner | arr | 游戏资讯 | |
| icon | arr | 启动器侧边栏图标及其信息 | |
| post | arr | 最近的官方资讯文章信息 | |
| qq | obj | 官方QQ群信息 | |
| more | obj | 待调查 | |
| links | obj | 常见问题页面的URL | |
| 字段 | 类型 | 内容 | 备注 |
|--------|-----|--------------|----|
| adv | obj | 背景图片信息 | |
| banner | arr | 游戏资讯 | |
| icon | arr | 启动器侧边栏图标及其信息 | |
| post | arr | 最近的官方资讯文章信息 | |
| qq | obj | 官方QQ群信息 | |
| more | obj | 待调查 | |
| links | obj | 常见问题页面的URL | |
`data`对象→`adv`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| background | str | 背景图片的URL | 文件名中“_”字符前为该图片的MD5校验码 |
| icon | str | 版本热点按钮图片的URL | |
| url | str | 版本专题内容页面的URL | |
| version | str | 背景图版本 | |
| bg_checksum | str | 待调查 | 疑似为背景图片的校验码，但经过比对后，发现其与MD5和任何哈希散列算法通过图片内容生成的值无法匹配 |
| 字段 | 类型 | 内容 | 备注 |
|-------------|-----|--------------|---------------------------------------------------|
| background | str | 背景图片的URL | 文件名中“_”字符前为该图片的MD5校验码 |
| icon | str | 版本热点按钮图片的URL | |
| url | str | 版本专题内容页面的URL | |
| version | str | 背景图版本 | |
| bg_checksum | str | 待调查 | 疑似为背景图片的校验码，但经过比对后，发现其与MD5和任何哈希散列算法通过图片内容生成的值无法匹配 |
`data`对象→`banner`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| banner_id | str | 待调查 | |
| name | str | 待调查 | 似乎总是为空字符串 |
| img | str | 文章封面图片的URL | |
| url | str | 文章页面的URL | |
| order | str | 文章滚动的排序值 | 范围为1-10 |
| 字段 | 类型 | 内容 | 备注 |
|-----------|-----|------------|-----------|
| banner_id | str | 待调查 | |
| name | str | 待调查 | 似乎总是为空字符串 |
| img | str | 文章封面图片的URL | |
| url | str | 文章页面的URL | |
| order | str | 文章滚动的排序值 | 范围为1-10 |
`data`对象→`icon`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| icon_id | str | 待调查 | |
| img | str | 图标URL | |
| url | str | 该图标将会跳转至的URL | |
| title | str | 二维码下方按钮的文本 | |
| tittle | str | 与`title`字段的内容相同 | |
| qr_img | str | 二维码图片URL | |
| qr_desc | str | 二维码下方描述的文本 | |
| img_hover | str | 鼠标悬停时显示图标的URL | |
| other_links | arr | 待调查 | 似乎总是为空数组 |
| links | arr | 二维码下方按钮的跳转URL | |
| icon_link | str | 待调查 | 总是为空字符串 |
| 字段 | 类型 | 内容 | 备注 |
|-------------|-----|-----------------|----------|
| icon_id | str | 待调查 | |
| img | str | 图标URL | |
| url | str | 该图标将会跳转至的URL | |
| title | str | 二维码下方按钮的文本 | |
| tittle | str | 与`title`字段的内容相同 | |
| qr_img | str | 二维码图片URL | |
| qr_desc | str | 二维码下方描述的文本 | |
| img_hover | str | 鼠标悬停时显示图标的URL | |
| other_links | arr | 待调查 | 似乎总是为空数组 |
| links | arr | 二维码下方按钮的跳转URL | |
| icon_link | str | 待调查 | 总是为空字符串 |
`data`对象→`icon`数组→对象→`links`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| title | str | 按钮内文本 | |
| url | str | 按钮将跳转的URL | |
| 字段 | 类型 | 内容 | 备注 |
|-------|-----|-----------|----|
| title | str | 按钮内文本 | |
| url | str | 按钮将跳转的URL | |
`data`对象→`post`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| post_id | str | 待调查 | |
| type | str | 米游社文章类型 | |
| title | str | 文章标题 | |
| show_time | str | 文章发布的时间 | 格式为“月/日” |
| url | str | 文章链接 | |
| tittle | str | 与`title`字段的内容相同 | |
| order | str | 列表排序值 | 范围为1-12 |
| 字段 | 类型 | 内容 | 备注 |
|-----------|-----|-----------------|----------|
| post_id | str | 待调查 | |
| type | str | 米游社文章类型 | |
| title | str | 文章标题 | |
| show_time | str | 文章发布的时间 | 格式为“月/日” |
| url | str | 文章链接 | |
| tittle | str | 与`title`字段的内容相同 | |
| order | str | 列表排序值 | 范围为1-12 |
`data`对象→`qq`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| qq_id | str | 待调查 | |
| number | str | QQ群号 | |
| name | str | QQ群名称 | |
| code | str | QQ群URL | URL经过Unicode转义 |
| 字段 | 类型 | 内容 | 备注 |
|--------|-----|--------|----------------|
| qq_id | str | 待调查 | |
| number | str | QQ群号 | |
| name | str | QQ群名称 | |
| code | str | QQ群URL | URL经过Unicode转义 |
`data`对象→`links`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| faq | str | 常见问题页面的URL | |
| version | str | 待调查 | 总是为1 |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|------------|------|
| faq | str | 常见问题页面的URL | |
| version | str | 待调查 | 总是为1 |
<details>
<summary>查看示例</summary>
@ -217,87 +217,87 @@ _请求方式：GET_
**参数：**
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
| 字段 | 类型 | 内容 | 备注 |
|-------------|-----|--------|----|
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
**JSON返回：**
根对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| retcode | num | 返回码 | |
| message | str | 返回消息 | |
| data | obj | 资源信息 | |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|------|----|
| retcode | num | 返回码 | |
| message | str | 返回消息 | |
| data | obj | 资源信息 | |
`data`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| game | obj | 游戏主要资源信息 | |
| plugin | obj | 游戏运行库信息 | |
| web_url | str | 启动器下载页面URL | |
| force_update | | 待调查 | |
| pre_download_game | | 待调查 |
| sdk | | 待调查 |
| deprecated_packages | arr | 已弃用游戏资源文件的文件名与MD5值 | |
| deprecated_files | arr | 已弃用游戏文件的文件名与MD5值 | |
| 字段 | 类型 | 内容 | 备注 |
|---------------------|-----|--------------------|----|
| game | obj | 游戏主要资源信息 | |
| plugin | obj | 游戏运行库信息 | |
| web_url | str | 启动器下载页面URL | |
| force_update | | 待调查 | |
| pre_download_game | | 待调查 |
| sdk | | 待调查 |
| deprecated_packages | arr | 已弃用游戏资源文件的文件名与MD5值 | |
| deprecated_files | arr | 已弃用游戏文件的文件名与MD5值 | |
`data`对象→`game`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| latest | obj | 最新版本文件信息 | |
| diffs | arr | 一些旧版本至当前版本的增量文件信息 | |
| 字段 | 类型 | 内容 | 备注 |
|--------|-----|-------------------|----|
| latest | obj | 最新版本文件信息 | |
| diffs | arr | 一些旧版本至当前版本的增量文件信息 | |
`data`对象→`game`对象→`latest`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| version | str | 最新游戏版本 | |
| name | str | 文件名称 | 总是为空字符串 |
| path | str | 空字符串 | 根据`diffs`数组→对象→`path`字段的规律，本应为文件URL，但是被`segments`字段取代 |
| size | str | 文件解压后的大小 | |
| md5 | str | 该文件的MD5值 | |
| voice_packs | arr | 所有语音包信息 | 《崩坏：星穹铁道》为空数组 |
| decompressed_path | str | 待调查 | |
| segments | arr | 游戏资源压缩文件各分卷的信息 | 《崩坏：星穹铁道》为空数组 |
| package_size | str | 压缩包文件大小 | |
| entry | str | 游戏启动程序的文件名 | |
| 字段 | 类型 | 内容 | 备注 |
|-------------------|-----|----------------|-------------------------------------------------------|
| version | str | 最新游戏版本 | |
| name | str | 文件名称 | 总是为空字符串 |
| path | str | 空字符串 | 根据`diffs`数组→对象→`path`字段的规律，本应为文件URL，但是被`segments`字段取代 |
| size | str | 文件解压后的大小 | |
| md5 | str | 该文件的MD5值 | |
| voice_packs | arr | 所有语音包信息 | 《崩坏：星穹铁道》为空数组 |
| decompressed_path | str | 待调查 | |
| segments | arr | 游戏资源压缩文件各分卷的信息 | 《崩坏：星穹铁道》为空数组 |
| package_size | str | 压缩包文件大小 | |
| entry | str | 游戏启动程序的文件名 | |
`data`对象→`game`对象→`latest`对象→`voice_packs`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| language | str | 语音资源对应的语言代码 | |
| path | str | 该资源文件的URL | |
| name | str | 语音包文件名称 | 总是为空字符串 |
| size | str | 文件解压后的大小 | |
| package_size | str | 压缩包文件大小 | |
| md5 | str | 文件的MD5值 | |
| 字段 | 类型 | 内容 | 备注 |
|--------------|-----|-------------|---------|
| language | str | 语音资源对应的语言代码 | |
| path | str | 该资源文件的URL | |
| name | str | 语音包文件名称 | 总是为空字符串 |
| size | str | 文件解压后的大小 | |
| package_size | str | 压缩包文件大小 | |
| md5 | str | 文件的MD5值 | |
`data`对象→`game`对象→`latest`对象→`segments`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| path | str | 该资源文件的URL | |
| md5 | str | 文件的MD5值 | |
| package_size | str | 压缩包文件大小 | |
| 字段 | 类型 | 内容 | 备注 |
|--------------|-----|-----------|----|
| path | str | 该资源文件的URL | |
| md5 | str | 文件的MD5值 | |
| package_size | str | 压缩包文件大小 | |
`data`对象→`game`对象→`diffs`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| name | str | 文件名 | |
| version | str | 该增量包修补的旧版本 | |
| path | str | 该增量包的URL | |
| size | str | 文件解压后的大小 | |
| md5 | str | 文件的MD5值 | |
| package_size | str | 压缩包文件大小 | |
| is_recommended_update | bool | 待调查 | |
| voice_packs | obj | 所有语音增量包信息 | 《崩坏：星穹铁道》为空 |
| 字段 | 类型 | 内容 | 备注 |
|-----------------------|------|------------|-------------|
| name | str | 文件名 | |
| version | str | 该增量包修补的旧版本 | |
| path | str | 该增量包的URL | |
| size | str | 文件解压后的大小 | |
| md5 | str | 文件的MD5值 | |
| package_size | str | 压缩包文件大小 | |
| is_recommended_update | bool | 待调查 | |
| voice_packs | obj | 所有语音增量包信息 | 《崩坏：星穹铁道》为空 |
`data`对象→`game`对象→`diffs`数组→`voice_packs`数组→对象：
@ -305,28 +305,28 @@ _请求方式：GET_
`data`对象→`plugin`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| plugins | arr | 运行库信息 | |
| version | str | 运行库版本 | |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|-------|----|
| plugins | arr | 运行库信息 | |
| version | str | 运行库版本 | |
`data`对象→`plugin`对象→`plugins`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| name | str | 运行库文件名 | |
| path | str | 运行库文件URL | |
| md5 | str | 文件的MD5值 | |
| version | str | 该文件的版本 | 总是为空字符串 |
| size | str | 文件大小 | |
| entry | str | 运行库安装程序的文件名 | 可能为空字符串 |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|-------------|---------|
| name | str | 运行库文件名 | |
| path | str | 运行库文件URL | |
| md5 | str | 文件的MD5值 | |
| version | str | 该文件的版本 | 总是为空字符串 |
| size | str | 文件大小 | |
| entry | str | 运行库安装程序的文件名 | 可能为空字符串 |
`data`对象→`game`对象→`deprecated_packages`数组→对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| name | str | 文件名 | |
| md5 | str | 文件的MD5值 | |
| 字段 | 类型 | 内容 | 备注 |
|------|-----|---------|----|
| name | str | 文件名 | |
| md5 | str | 文件的MD5值 | |
`data`对象→`game`对象→`deprecated_files`数组→对象：
@ -444,31 +444,33 @@ _请求方式：GET_
**参数：**
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
| language | str | 返回文本语言的国家代码 | 国服仅支持中文（zh-cn） |
| 字段 | 类型 | 内容 | 备注 |
|-------------|-----|-------------|----------------|
| key | str | 启动器Key | |
| launcher_id | num | 启动器ID | |
| language | str | 返回文本语言的国家代码 | 国服仅支持中文（zh-cn） |
**JSON返回：**
根对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| retcode | num | 返回码 | |
| message | str | 返回消息 | |
| data | obj | 用户协议以及用户协议版本 | 若请求参数中的`language`为不支持的语言，则所有数据均为空与空数组 |
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|--------------|---------------------------------------|
| retcode | num | 返回码 | |
| message | str | 返回消息 | |
| data | obj | 用户协议以及用户协议版本 | 若请求参数中的`language`为不支持的语言，则所有数据均为空与空数组 |
`data`对象：
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| protocol | str | 用户协议 | 为HTML |
| title | str | 用户协议标题 | |
| 字段 | 类型 | 内容 | 备注 |
|-------------------|-----|--------|-----------|
| protocol | str | 用户协议 | 为HTML |
| title | str | 用户协议标题 | |
| agreement_version | str | 用户协议版本 | 一般为当前游戏版本 |
<details>
<summary>查看示例</summary>
```json
{
"retcode": 0,