返回提交历史
Modified
README.md
+5
-1
Added
note/action.md
+131
-0
Added
note/readme.md
+71
-0
XFEstudio/bilibili-API-collect
添加笔记相关API (#100)
* note开始编写 * Update info.md * Update info.md * 更改文件名并且完善 * Delete a.json * 更新并修改【提交笔记】及【删除笔记】 Co-authored-by: SocialSisterYi <45892418+SocialSisterYi@users.noreply.github.com>
a92ffe2
代码差异
3 个文件
+207
-1
@@ -82,7 +82,11 @@ PS：所有http协议地址均可使用https，文档中为了统一写作`http`
82
82
- 高级弹幕
83
83
- 屏蔽管理
84
84
- 智能防挡弹幕
85
- [弹幕个人配置修改](danmaku/config.md)√
85
- [弹幕个人配置修改](danmaku/config.md)
86
- [视频笔记](note)×
87
- 笔记列表
88
- 笔记详细信息
89
- [笔记操作](note/action.md)√
86
90
- [专栏](article)
87
91
- 分区
88
92
- [基本信息](article/info.md)×
@@ -0,0 +1,131 @@
1
# 笔记操作
2
3
- [保存视频笔记](#保存视频笔记)
4
- [删除视频笔记](#删除视频笔记)
5
6
---
7
8
## 保存视频笔记
9
10
> http://api.bilibili.com/x/note/add
11
12
*请求方式：POST*
13
14
认证方式：Cookie（SESSDATA）
15
16
**正文参数（ application/x-www-form-urlencoded ）：**
17
18
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
19
| ------- | ---- | ------------------------ | ------ | ------------------------------------------------------------ |
20
| aid | num | 目标稿件avID | 必要 | |
21
| note_id | num | 笔记ID | 非必要 | 创建时无需此项 |
22
| title | str | 笔记标题 | 必要 | |
23
| summary | str | 笔记预览文本 | 必要 | |
24
| content | str | 笔记正文json序列 | 必要 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
25
| tags | str | | 非必要 | 作用尚不明确 |
26
| cls | num | 1 | 非必要 | 作用尚不明确 |
27
| from | str | 提交类型 | 非必要 | auto：自动提交<br />save：手动提交<br />close：关闭时自动提交 |
28
| csrf | str | CSRF Token（位于cookie） | 必要 | |
29
30
**json回复：**
31
32
根对象：
33
34
| 字段 | 类型 | 内容 | 备注 |
35
| ------- | ---- | -------- | ------------------------------------------------------------ |
36
| code | num | 返回值 | 0：成功 <br />-101：账号未登录<br />-111：csrf校验失败<br />-400：请求错误<br />-79508：该稿件已存在笔记，无法新增 |
37
| message | str | 错误信息 | 默认为0 |
38
| ttl | num | 1 | |
39
| data | obj | 数据本体 | |
40
41
`data`对象：
42
43
| 字段 | 类型 | 内容 | 备注 |
44
| ------- | ---- | ------------ | ---- |
45
| note_id | num | 笔记ID | |
46
47
**示例：**
48
49
保存内容为加粗的STRONG的笔记`3809605586518023`于`av970322090`
50
51
```shell
52
curl 'http://api.bilibili.com/x/note/add' \
53
--data-urlencode 'aid=970322090' \
54
--data-urlencode 'note_id=3809605586518023'
55
--data-urlencode 'title=周刊哔哩哔哩排行榜#543'
56
--data-urlencode 'summary=STRONG'
57
--data-urlencode 'content=[{"attributes":{"bold":true},"insert":"STRONG"},{"insert":"\n"}]'
58
--data-urlencode 'tags='
59
--data-urlencode 'cls=1'
60
--data-urlencode 'from=save'
61
--data-urlencode 'csrf=xxx'
62
-b 'SESSDATA=xxx'
63
```
64
65
<details>
66
<summary>查看响应示例：</summary>
67
68
```json
69
{
70
"code": 0,
71
"message": "0",
72
"ttl": 1,
73
"data": {
74
"note_id": 3809605586518023
75
}
76
}
77
```
78
79
</details>
80
81
## 删除视频笔记
82
83
> http://api.bilibili.com/x/note/del
84
85
*请求方式：POST*
86
87
认证方式：Cookie（SESSDATA）
88
89
**正文参数（ application/x-www-form-urlencoded ）：**
90
91
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
92
| ------- | ---- | ------------------------ | ------ | ---- |
93
| aid | num | 目标稿件avID | 必要 | |
94
| note_id | num | 笔记ID | 非必要 | |
95
| csrf | str | CSRF Token（位于cookie） | 必要 | |
96
97
**json回复：**
98
99
根对象：
100
101
| 字段 | 类型 | 内容 | 备注 |
102
| ------- | ---- | -------- | ------------------------------------------------------------ |
103
| code | num | 返回值 | 0：成功 <br />-101：账号未登录<br />-111：csrf校验失败<br />-400：请求错误 |
104
| message | str | 错误信息 | 默认为0 |
105
| ttl | num | 1 | |
106
107
**示例：**
108
109
删除稿件`av457253380`下的笔记`4075968478576647`
110
111
```shell
112
curl 'http://api.bilibili.com/x/note/add' \
113
--data-urlencode 'aid=457253380' \
114
--data-urlencode 'note_id=4075968478576647' \
115
--data-urlencode 'csrf=xxx'
116
-b 'SESSDATA=xxx'
117
```
118
119
<details>
120
<summary>查看响应示例：</summary>
121
122
123
```json
124
{
125
"code": 0,
126
"message": "0",
127
"ttl": 1
128
}
129
```
130
131
</details>
@@ -0,0 +1,71 @@
1
# 视频笔记
2
3
2020-11-16 B站推出了测试版的功能——"视频笔记"，与视频稿件关联，为富文本模式，可供记录观看视频时的感悟以及视频中的重要内容，目前只可在web端操作
4
5
---
6
7
继续查看：
8
9
- 笔记列表
10
- 笔记详细信息
11
- [笔记操作](action.md)√
12
13
---
14
15
## 附表-笔记正文序列格式
16
17
根数组：
18
19
| 项 | 类型 | 内容 | 备注 |
20
| ---- | ---- | ------------- | ---- |
21
| 0 | obj | 第1个元素 | |
22
| n | obj | 第(n+1)个元素 | |
23
| …… | obj | …… | …… |
24
25
根数组中的对象：
26
27
| 字段 | 类型 | 内容 | 备注 |
28
| ---------- | ---- | ------------ | ------------------- |
29
| attributes | obj | 元素属性 | 无属性无此项 |
30
| insert | str | 元素内容 | 为跳转/图片时无此项 |
31
| insert | obj | 元素跳转信息 | 非跳转/图片时无此项 |
32
33
对象中的`attributes`对象：
34
35
| 字段 | 类型 | 内容 | 备注 |
36
| ---------- | ---- | ---------- | ------------------------------ |
37
| bold | bool | 是否加粗 | |
38
| strike | bool | 是否删除线 | |
39
| underline | bool | 是否下划线 | |
40
| background | str | 背景颜色 | |
41
| color | str | 文字颜色 | |
42
| list | str | 列表属性 | ordered有序列表/bullet无序列表 |
43
| size | str | 文字字号 | |
44
45
对象中的`insert`对象：
46
47
| 字段 | 类型 | 内容 | 备注 |
48
| ----------- | ---- | -------- | ------ |
49
| tag | obj | 跳转标签 | 二选一 |
50
| imageUpload | obj | 笔记图片 | 二选一 |
51
52
`insert`中的`tag`对象：
53
54
| 字段 | 类型 | 内容 | 备注 |
55
| -------- | ---- | ----------------- | ------------ |
56
| cid | num | 视频cid | |
57
| status | num | 0 | 作用尚不明确 |
58
| index | num | 在稿件中的分P索引 | |
59
| seconds | num | 视频进度 | |
60
| cidCount | num | 稿件总分P数 | |
61
| key | str | 标签创建时间戳 | |
62
| title | str | output | 作用尚不明确 |
63
64
`insert`中的`imageUpload`对象：
65
66
| 字段 | 类型 | 内容 | 备注 |
67
| ------ | ---- | ---------- | ------------ |
68
| url | str | 图片链接 | |
69
| status | str | done | 作用尚不明确 |
70
| width | num | 图片宽度-2 | |
71