修正大会员兑换 api (#294)

* 修正大会员兑换 api

* 修正大会员兑换 api (#293)
* 补完 api 示例

* 统一写作 http

* 修正【大会员权益】文档格式

Co-authored-by: 社会易姐QwQ <45892418+SocialSisterYi@users.noreply.github.com>
This commit is contained in:
topkie 2021-12-17 22:03:31 +08:00 committed by GitHub
parent 44c965e08f
commit d1f6b217fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,7 +6,7 @@
---
## 兑换状态查询
## 卡券状态查询
> http://api.bilibili.com/x/vip/privilege/my
@ -20,15 +20,16 @@
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------- |
| code | num | 状态码 | -400请求错误<br />0成功 |
| message | str | 错误详情 | |
| code | num | 返回值 | -101账号未登录<br />-400请求错误<br />0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----- | -------|----------------|------ |
| list | 数组 | 信息本体 | |
| list | array | 卡券列表 | |
`list`数组:
@ -37,19 +38,21 @@
| 0 | obj | B币兑换状态 | |
| 1 | obj | 会员购优惠券兑换状态 | |
`list`对象:
`list`中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------------- | -----|------------------|------ |
| type | num | 1 或 2 | 1B币</br>2会员购优惠券 |
| status | num | 兑换状态 | 0当月未兑换</br>1已兑换 |
| type | num | 卡券类型 | 1B币<br />2会员购优惠券<br />3漫画福利券 |
| state | num | 兑换状态 | 0当月未兑换<br />1已兑换 |
| expire_time | num | 当月过期时间 | 当月月底 |
| vip_type | num | (?) | |
**示例:**
```shell
curl -G 'https://api.bilibili.com/x/vip/privilege/my' \
curl -G 'http://api.bilibili.com/x/vip/privilege/my' \
-b "SESSDATA=xxx"
```
<details>
@ -57,15 +60,31 @@ curl -G 'https://api.bilibili.com/x/vip/privilege/my' \
```json
{
"code":0,
"message":"0",
"ttl":1,
"data":{
"list":[
{"type":1,"state":1,"expire_time":1638287999},
{"type":2,"state":1,"expire_time":1638287999}
]
}
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"list": [
{
"type": 1,
"state": 1,
"expire_time": 1640966399,
"vip_type": 2
},
{
"type": 2,
"state": 1,
"expire_time": 1640966399,
"vip_type": 2
},
{
"type": 3,
"state": 0,
"expire_time": 1640966399,
"vip_type": 2
}
]
}
}
```
@ -73,28 +92,47 @@ curl -G 'https://api.bilibili.com/x/vip/privilege/my' \
## 兑换
> http://api.bilibili.com/x/vip/privilege/my
> http://api.bilibili.com/x/vip/privilege/receive
*请求方式:POST*
认证方式CookieSESSDATA
注意请求头中的Origin字段必须为"https://www.bilibili.com/"
认证方式Cookie(SESSDATA)
**正文参数:**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ---------- | ---- | ---------- | -------- | ---------------------- |
| type | num | 1 或 2 | 必要 | 1B币</br>2会员购优惠券 |
| type | num | 兑换类型 | 必要 | 1B币<br />2会员购优惠券<br />3漫画福利券 |
| 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 -G 'https://api.bilibili.com/x/vip/privilege/my' \
-H "Origin: https://www.bilibili.com/" \
-d "{\"type\": 1, \"csrf\": csrf_token}"
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>