大积分首页和签到 (#527)

* 添加:大积分首页信息

* 添加:大积分签到

* fix format and add APIdoc 【大会员中心信息】

Co-authored-by: SocialSisterYi <1440239038@qq.com>
This commit is contained in:
7rikka 2022-11-04 02:13:07 +08:00 committed by GitHub
parent 228f7f51e1
commit fffb2dda40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 2243 additions and 169 deletions

View File

@ -69,7 +69,12 @@ PS所有 rest api 均可使用 https文档中为了统一写作`http` (除
- [ ] [个人空间](user/space.md)
- [x] [检查昵称是否可注册](user/check_nickname.md)
- [x] [用户注册](user/register.md)
- [x] [大会员福利兑换](user/vip.md)
- [ ] [大会员](vip)
- [ ] [大会员基本信息](vip/info.md)
- [ ] [大会员中心](vip/center.md)
- [ ] [大会员签到](vip/clockin.md)
- [ ] [大会员操作](vip/action.md)
- [ ] [视频](video)
- [x] [视频分区一览 (分区代码)](video/video_zone.md)
- [x] [基本信息](video/info.md)

View File

@ -1,168 +0,0 @@
# 大会员兑换福利
- [大会员兑换福利](#大会员兑换福利)
- [卡券状态查询](#卡券状态查询)
- [兑换卡券](#兑换卡券)
---
## 卡券状态查询
> http://api.bilibili.com/x/vip/privilege/my
*请求方式:GET*
认证方式CookieSESSDATA或APP
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|------|-------------------------------------|
| code | num | 返回值 | -101账号未登录<br />-400请求错误<br />0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
|-----------------|-------|--------|-----|
| list | array | 卡券信息列表 | |
| is_short_vip | bool | (?) | |
| is_freight_open | bool | (?) | |
`list`数组:
| 字段 | 类型 | 内容 | 备注 |
|-----|-----|-------------|-----|
| 0 | obj | B币兑换状态 | |
| 1 | obj | 会员购优惠券兑换状态 | |
| 2 | obj | 漫画福利券兑换状态 | |
| 3 | obj | 会员购包邮券兑换状态 | |
| 4 | obj | 漫画商城优惠券兑换状态 | |
`list`中的对象:
| 字段 | 类型 | 内容 | 备注 |
|-------------------|-----|------------|--------------------------------------------------------------|
| type | num | 卡券类型 | 1B币券<br />2会员购优惠券<br />3漫画福利券<br />4会员购包邮券<br/>5漫画商城优惠券 |
| state | num | 兑换状态 | 0当月未兑换<br />1已兑换 |
| expire_time | num | 本轮卡券过期时间戳 | 当月月底 |
| vip_type | num | | 2年度大会员可兑换 |
| next_receive_days | num | 距下一轮兑换剩余天数 | |
| period_end_unix | num | 下一轮兑换开始时间戳 | 秒级时间戳 |
**示例:**
```shell
curl -G 'http://api.bilibili.com/x/vip/privilege/my' \
-b "SESSDATA=xxx"
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"list": [
{
"type": 1,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 2,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 3,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 4,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 5,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
}
],
"is_short_vip": false,
"is_freight_open": true
}
}
```
</details>
## 兑换卡券
> http://api.bilibili.com/x/vip/privilege/receive
*请求方式:POST*
认证方式Cookie(SESSDATA)
**正文参数:**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
|------|-----|------------|-----|--------------------------------------------------------------|
| type | num | 兑换类型 | 必要 | 1B币券<br />2会员购优惠券<br />3漫画福利券<br />4会员购包邮券<br/>5漫画商城优惠券 |
| csrf | num | CSRF token | 必要 | Cookie bili_jct字段 |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|------|---------------------------------------------------------------------------------------------------|
| code | num | 返回值 | -101账号未登录<br />-111csrf 校验失败<br />-400请求错误<br />69800网络繁忙 请稍后再试<br />69801你已领取过该权益<br />0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
**示例:**
```shell
curl 'http://api.bilibili.com/x/vip/privilege/receive' \
-b 'SESSDATA=xxx' \
--data-urlencode 'type=1' \
--data-urlencode 'csrf=csrf_token'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1
}
```
</details>

52
vip/action.md Normal file
View File

@ -0,0 +1,52 @@
# 大会员操作
- [兑换卡券](#兑换卡券)
---
## 兑换卡券
> https://api.bilibili.com/x/vip/privilege/receive
*请求方式POST*
认证方式Cookie (SESSDATA)
**正文参数 (application/x-www-form-urlencoded)**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ----------------------- | --------------- | ------------------------------------------------------------ |
| type | num | 兑换类型 | 必要 | 1B币券<br />2会员购优惠券<br />3漫画福利券<br />4会员购包邮券<br/>5漫画商城优惠券 |
| csrf | str | CSRF Token (位于cookie) | Cookie 方式必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
|---------|-----|------|---------------------------------------------------------------------------------------------------|
| code | num | 返回值 | -101账号未登录<br />-111csrf 校验失败<br />-400请求错误<br />69800网络繁忙 请稍后再试<br />69801你已领取过该权益<br />0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
**示例:**
```shell
curl 'https://api.bilibili.com/x/vip/privilege/receive' \
-b 'SESSDATA=xxx' \
--data-urlencode 'type=1' \
--data-urlencode 'csrf=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1
}
```
</details>

1999
vip/center.md Normal file

File diff suppressed because it is too large Load Diff

66
vip/clockin.md Normal file
View File

@ -0,0 +1,66 @@
# 大会员签到
- [大积分签到](#大积分签到)
---
## 大积分签到
> https://api.bilibili.com/pgc/activity/score/task/sign
*请求方式POST*
认证方式Cookie (SESSDATA) / access_key
鉴权方式Cookie 方式下需要`Referer`在`*.bilibili.com`域名下
**正文参数( application/x-www-form-urlencoded **
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ---------- | ---- | ----------------------- | -------------- | ---- |
| access_key | str | APP登录Token | APP方式必要 | |
| csrf | str | CSRF Token (位于cookie) | Cookie方式必要 | |
**json回复**
根对象:
| 字段名 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 响应码 | 0成功<br />-101账号未登录<br/>-401非法访问<br/>-403访问权限不足 |
| message | str | 错误信息 | |
**示例:**
web 方式:
```shell
curl 'https://api.bilibili.com/pgc/activity/score/task/sign' \
--data-urlencode 'csrf=xxx' \
-b 'SESSDATA=xxx' \
--referer 'https://www.bilibili.com'
```
APP 方式:
```shell
curl 'https://api.bilibili.com/pgc/activity/score/task/sign' \
--data-urlencode 'access_key=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "success"
}
```
</details>

120
vip/info.md Normal file
View File

@ -0,0 +1,120 @@
# 大会员信息
- [卡券状态查询](#卡券状态查询)
---
## 卡券状态查询
> https://api.bilibili.com/x/vip/privilege/my
*请求方式GET*
认证方式Cookie (SESSDATA) / access_key
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------- |
| code | num | 返回值 | -101账号未登录<br />-400请求错误<br />0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| --------------- | ----- | ------------ | ---- |
| list | array | 卡券信息列表 | |
| is_short_vip | bool | (?) | |
| is_freight_open | bool | (?) | |
`list`数组:
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---------------------- | ---- |
| 0 | obj | B币兑换状态 | |
| 1 | obj | 会员购优惠券兑换状态 | |
| 2 | obj | 漫画福利券兑换状态 | |
| 3 | obj | 会员购包邮券兑换状态 | |
| 4 | obj | 漫画商城优惠券兑换状态 | |
`list`中的对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------------- | ---- | -------------------- | ------------------------------------------------------------ |
| type | num | 卡券类型 | 1B币券<br />2会员购优惠券<br />3漫画福利券<br />4会员购包邮券<br/>5漫画商城优惠券 |
| state | num | 兑换状态 | 0当月未兑换<br />1已兑换 |
| expire_time | num | 本轮卡券过期时间戳 | 当月月底 |
| vip_type | num | | 2年度大会员可兑换 |
| next_receive_days | num | 距下一轮兑换剩余天数 | |
| period_end_unix | num | 下一轮兑换开始时间戳 | 秒级时间戳 |
**示例:**
```shell
curl 'https://api.bilibili.com/x/vip/privilege/my' \
-b "SESSDATA=xxx"
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"list": [
{
"type": 1,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 2,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 3,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 4,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
},
{
"type": 5,
"state": 0,
"expire_time": 1667231999,
"vip_type": 2,
"next_receive_days": 29,
"period_end_unix": 1667491200
}
],
"is_short_vip": false,
"is_freight_open": true
}
}
```
</details>