mirror of
https://github.com/PaiGramTeam/mihoyo-api-collect.git
synced 2024-11-22 07:07:43 +00:00
docs: 增加验证码登录文档
This commit is contained in:
Ljzd PRO
GitHub
parent
4f2ae2fd89
commit
109308ebc6
257
hoyolab/login/sms.md
Normal file
257
hoyolab/login/sms.md
Normal file
@ -0,0 +1,257 @@
|
|||||||
|
# 米游社验证码登录
|
||||||
|
|
||||||
|
- [验证码登录](#验证码登录)
|
||||||
|
- [操作步骤](#sms-step)
|
||||||
|
- [申请人机验证任务](#申请人机验证任务)
|
||||||
|
- [发送短信验证码](#发送短信验证码)
|
||||||
|
- [获取login_ticket](#获取login_ticket)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 验证码登录
|
||||||
|
|
||||||
|
<h3 id="sms-step">操作步骤</h3>
|
||||||
|
|
||||||
|
1. [申请人机验证任务](#申请人机验证任务)，获取 `gt`，`mmt_key` 等任务数据
|
||||||
|
2. 使用任务数据完成人机验证，得到 `geetest_v4_data` 验证结果数据（参考：https://docs.geetest.com/gt4/apirefer/api/web ）
|
||||||
|
3. 使用验证结果数据 [发出短信验证码](#发送短信验证码)
|
||||||
|
4. 使用收到的短信验证码 [获取 `login_ticket`](#获取login_ticket)
|
||||||
|
5. 通过 `login_ticket` 进一步获取其余Cookies字段（参考 [用户Token](https://github.com/UIGF-org/mihoyo-api-collect/blob/main/hoyolab/user/token.md)）
|
||||||
|
9. 将以上步骤获取到的Cookies字段进行组合，即可用于其他需要登录的API。
|
||||||
|
|
||||||
|
### 申请人机验证任务
|
||||||
|
|
||||||
|
_请求方式：GET_
|
||||||
|
|
||||||
|
`https://webapi.account.mihoyo.com/Api/create_mmt`
|
||||||
|
|
||||||
|
**URL请求：**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| scene_type | num | 暂不知道具体含义，可直接使用值 `1` | 可参考 [米哈游通行证验证码登录页](https://user.mihoyo.com/#/login/captcha) 使用的值为 `1` |
|
||||||
|
| now | num | 当前的秒级时间戳 | |
|
||||||
|
| reason | str | 调用API的网页链接 | 可参考 [米哈游通行证验证码登录页](https://user.mihoyo.com/#/login/captcha) 使用的是 `user.mihoyo.com%2523%252Flogin%252Fcaptcha`（已进行URL编码）|
|
||||||
|
| action_type | str | 登陆方式 | 短信验证码登录为 `login_by_mobile_captcha` |
|
||||||
|
|
||||||
|
**JSON返回：**
|
||||||
|
|
||||||
|
根对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| code | num | HTTP状态码 | |
|
||||||
|
| data | obj | 返回数据 | |
|
||||||
|
|
||||||
|
`data`对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| mmt_data | obj | 极验验证任务数据 | |
|
||||||
|
| mmt_type | num | 暂不知道具体含义，无实际作用 | 一般为 `1` |
|
||||||
|
| msg | str | 返回消息 | |
|
||||||
|
| scene_type | num | 与URL请求参数中的 `scene_type` 相同 | |
|
||||||
|
| status | num | 返回码 | 返回码为 `1` 说明执行成功 |
|
||||||
|
|
||||||
|
`data`对象→`mmt_data`对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| mmt_key | str | 验证任务 | 当 `mmt_data` 对象仅包含该字段时，说明不需要进行人机验证，可直接使用该值发送短信验证码 |
|
||||||
|
| gt | obj | 验证ID | 验证ID，即极验文档中的`captchaId`，极验后台申请得到 |
|
||||||
|
| new_captcha | num | 宕机情况下使用 | 一般为 `1` |
|
||||||
|
| risk_type | str | 结合风控融合，指定验证形式 | 例如 `"slide"`，拖动滑块完成拼图 |
|
||||||
|
| success | num | 是否成功 | |
|
||||||
|
| use_v4 | bool | 是否使用极验第四代适应性验证 | 极验官网：https://www.geetest.com/adaptive-captcha |
|
||||||
|
|
||||||
|
**备注：**
|
||||||
|
|
||||||
|
- 通常首次申请验证任务只会返回 `mmt_key`，不会返回 `gt` 等其他字段，这说明不需要进行人机验证，可直接使用 `mmt_key` 字段值调用短信验证码发送API
|
||||||
|
- JSON返回数据的 `mmt_data` 对象中一些字段说明参考自 [极验官方文档](https://docs.geetest.com/gt4/apirefer/api/web)
|
||||||
|
- 在2023年5月左右[米哈游通行证验证码登录页](https://user.mihoyo.com/#/login/captcha)从极验GT3升级至GT4，目前 [短信验证码发送](#发送短信验证码) 接口不再支持GT3验证结果，因此文档不包含GT3验证结果的使用方法
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看示例</summary>
|
||||||
|
|
||||||
|
- 请求：`https://webapi.account.mihoyo.com/Api/create_mmt?scene_type=1&now=1691819005684&reason=user.mihoyo.com%2523%252Flogin%252Fcaptcha&action_type=login_by_mobile_captcha`
|
||||||
|
- 返回：
|
||||||
|
- 无需进行人机验证的情况：
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"data": {
|
||||||
|
"mmt_data": {
|
||||||
|
"mmt_key": "nAZzNc45p76J85nz3PRV6tjGp0SX9TDc"
|
||||||
|
},
|
||||||
|
"mmt_type": 0,
|
||||||
|
"msg": "成功",
|
||||||
|
"scene_type": 1,
|
||||||
|
"status": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
- 需要进行人机验证的情况：
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"data": {
|
||||||
|
"mmt_data": {
|
||||||
|
"gt": "0b3dbaab0ad3f8344ab45342c3f3d909",
|
||||||
|
"mmt_key": "3hfbcdJd5K9g23Fu0hRFA7DDDRRzKJdC",
|
||||||
|
"new_captcha": 1,
|
||||||
|
"risk_type": "slide",
|
||||||
|
"success": 1,
|
||||||
|
"use_v4": true
|
||||||
|
},
|
||||||
|
"mmt_type": 1,
|
||||||
|
"msg": "成功",
|
||||||
|
"scene_type": 1,
|
||||||
|
"status": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### 发送短信验证码
|
||||||
|
|
||||||
|
_请求方式：POST_
|
||||||
|
|
||||||
|
`https://webapi.account.mihoyo.com/Api/create_mobile_captcha`
|
||||||
|
|
||||||
|
**URL请求：**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| action_type | num | 操作类型 | 登录使用 `"login"`；注册使用 `"regist"` |
|
||||||
|
| mmt_key | str | 验证任务，与 [申请人机验证任务](#申请人机验证任务) 中的 `mmt_key` 相同 | |
|
||||||
|
| geetest_v4_data | obj | 验证结果数据 | 关于客户端部署人机验证界面等可参考 [极验文档](https://docs.geetest.com/gt4/deploy/client/web) |
|
||||||
|
| mobile | str | 目标手机号 | |
|
||||||
|
| t | num | 当前的秒级时间戳 | |
|
||||||
|
|
||||||
|
**JSON返回：**
|
||||||
|
|
||||||
|
根对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| code | num | HTTP状态码 | |
|
||||||
|
| data | obj | 返回数据 | |
|
||||||
|
|
||||||
|
`data`对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| info | str | 返回消息（通常为英文） | |
|
||||||
|
| msg | str | 返回消息 | |
|
||||||
|
| status | num | 返回码 | `1` - 执行成功<br>`-213` - 发送验证码过于频繁<br>`-302` - 图形验证码失败（可能是`geetest_v4_data`不正确） |
|
||||||
|
|
||||||
|
**备注：**
|
||||||
|
|
||||||
|
- 通常首次 [申请验证任务](#申请人机验证任务) 只会返回 `mmt_key`，不会返回 `gt` 等其他字段，这说明不需要进行人机验证，可只传入 `mmt_key` 参数，不传入 `geetest_v4_data`
|
||||||
|
- 需要注意请求参数为URL参数，且 `geetest_v4_data` 应为JSON格式，并进行URL编码。如果其他步骤正常执行，但仍然发送失败，可尝试将 `geetest_v4_data` 中的单引号 `'` 改为双引号 `"`
|
||||||
|
- 关于客户端部署人机验证界面等可参考 [极验文档](https://docs.geetest.com/gt4/deploy/client/web)
|
||||||
|
- 在2023年5月左右[米哈游通行证验证码登录页](https://user.mihoyo.com/#/login/captcha)从极验GT3升级至GT4，目前该接口不再支持GT3验证结果，因此文档不包含GT3验证结果的使用方法
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看示例</summary>
|
||||||
|
|
||||||
|
- 请求：`https://webapi.account.mihoyo.com/Api/create_mobile_captcha?action_type=regist&mmt_key=8KjlO8apdZQa3fMgf56lD46dfrxgXJkc&geetest_v4_data=%7B%22captcha_id%22%3A%220b2abaab0ad3f4744ab45342a2f3d409%22%2C%22lot_number%22%3A%2205c722c7ac684df08f37041454a821ff%22%2C%22pass_token%22%3A%227d7186d35076b50449b34d972e8c9b3a7cb3447c4ef13ffc5988c3ef87a2599b%22%2C%22gen_time%22%3A%221691824854%22%2C%22captcha_output%22%3A%22UTF1rryV60odgz6wGWtA5wb20ftQtRKnX1DewXnCreaF9rS3lfBx4XkGEciGrfSeUpwpxCmyZdYigGqBDZl3KHip_0Da5AYouE0Fts4C55RZG6pOx_XcWW34OZBlU677M1b-5wNitbzKbs9jyVu9qTTDR3umqo4ZWIidZf8catvtmY5zkWsOKbSpyKT2TbZm9W-yxDMCelvpGKAdXIpO8WK1HnfGzY8y8A7peNpwFEAGocKuchtDbyPSODbRuzZcoF-OXzShkDxLaBamHYk0kRpwbuvDzZC1MGduDB4ARm4LC8278xH2xji-NuNWKn1b-DuzpmsxIRuHQO_UrJHAwFvLgzCnqmj9Cwuamutj5TGCgADJWwv9WFBomqskQdWk%22%7D&mobile=18199998888&t=1691824865517`
|
||||||
|
- 返回：
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"data": {
|
||||||
|
"msg": "成功",
|
||||||
|
"status": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### 获取login_ticket
|
||||||
|
|
||||||
|
_请求方式：POST_
|
||||||
|
|
||||||
|
`https://webapi.account.mihoyo.com/Api/login_by_mobilecaptcha`
|
||||||
|
|
||||||
|
**URL请求：**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| mobile | str | 目标手机号 | |
|
||||||
|
| mobile_captcha | str | 短信验证码 | |
|
||||||
|
| source | str | 登录操作来源 | 可参考 [米哈游通行证验证码登录页](https://user.mihoyo.com/#/login/captcha) 使用的是 `"user.mihoyo.com"` |
|
||||||
|
| t | num | 当前的秒级时间戳 | |
|
||||||
|
|
||||||
|
**JSON返回：**
|
||||||
|
|
||||||
|
根对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| code | num | HTTP状态码 | |
|
||||||
|
| data | obj | 返回数据 | |
|
||||||
|
|
||||||
|
`data`对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| account_info | obj | 账号信息 | |
|
||||||
|
| msg | str | 返回消息 | |
|
||||||
|
| status | num | 返回码 | 返回码为 `1` 说明执行成功 |
|
||||||
|
|
||||||
|
`data`对象→`account_info`对象：
|
||||||
|
|
||||||
|
| 字段 | 类型 | 内容 | 备注 |
|
||||||
|
| ---- | ---- | ---- | ---- |
|
||||||
|
| account_id | num | 通行证ID | |
|
||||||
|
| area_code | str | 手机号区号 | 如 `"+86"` |
|
||||||
|
| create_time | num | 注册日期 | 格式为秒级时间戳 |
|
||||||
|
| email | str | 邮箱 | 将会打码显示 |
|
||||||
|
| identity_code | str | 身份证号 | 将会打码显示 |
|
||||||
|
| is_adult | num | 用户是否为成人 | 是 对应 `1` |
|
||||||
|
| is_email_verify | num | 是否已验证邮箱 | 是 对应 `1` |
|
||||||
|
| mobile | str | 手机号 | 将会打码显示 |
|
||||||
|
| real_name | str | 真实姓名 | 将会打码显示 |
|
||||||
|
| safe_area_code | str | 绑定手机的区号 | 如 `"+86"` |
|
||||||
|
| safe_level | num | 安全级别 | 高 对应 `3` |
|
||||||
|
| safe_mobile | str | 绑定手机 | 将会打码显示 |
|
||||||
|
| weblogin_token | str | 即Cookie中的 `login_ticket` 字段 | 该字段也将出现在响应Cookie中 |
|
||||||
|
|
||||||
|
**备注：**
|
||||||
|
|
||||||
|
- 可直接从响应Cookie中获取 `login_ticket`
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>查看示例</summary>
|
||||||
|
|
||||||
|
- 请求：`https://webapi.account.mihoyo.com/Api/create_mobile_captcha?mobile=18199998888&mobile_captcha=834265&source=user.mihoyo.com&t=1691827148574`
|
||||||
|
- 返回：
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 200,
|
||||||
|
"data": {
|
||||||
|
"account_info": {
|
||||||
|
"account_id": 123456789,
|
||||||
|
"area_code": "+86",
|
||||||
|
"create_time": 1614948789,
|
||||||
|
"email": "user****mail@mail.com",
|
||||||
|
"identity_code": "111************000",
|
||||||
|
"is_adult": 1,
|
||||||
|
"is_email_verify": 1,
|
||||||
|
"mobile": "181****8888",
|
||||||
|
"real_name": "**川",
|
||||||
|
"safe_area_code": "+86",
|
||||||
|
"safe_level": 3,
|
||||||
|
"safe_mobile": "181****8888",
|
||||||
|
"weblogin_token": "QDDFDSOykvnoXXXXXihEghhWDssd2efsdSDryCq"
|
||||||
|
},
|
||||||
|
"msg": "成功",
|
||||||
|
"status": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
Loading…
Reference in New Issue
Block a user