From dba7650e970218d88318ecdab35983b526cfa9c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=9F=BF=E4=BA=95=E5=B0=8F=E5=B8=95=E7=9A=84=E8=A1=80?= =?UTF-8?q?=E5=B0=8F=E6=9D=BF?= <61276297+MineCreeper86@users.noreply.github.com> Date: Wed, 3 Feb 2021 00:26:27 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84note=E4=B8=8B=E6=89=80?= =?UTF-8?q?=E6=9C=89api=EF=BC=8C=E5=8C=85=E6=8B=AC=E5=88=97=E8=A1=A8?= =?UTF-8?q?=E4=BB=A5=E5=8F=8A=E5=86=85=E5=AE=B9=E6=9F=A5=E8=AF=A2=20(#142)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 增加笔记列表（note/list.md） 链接加了，但是现在是打×的，如果确认没问题就改成√ * Update list.md * note最后一环施工 note\info.md (55%) user\relation.md 纠错 * 更新 note\action.md (补充) note\info.md (65%) * 修改纠错 感谢线程（bushi）程序撕裂者 @ProgramRipper * 更新info.md 更新note\info.md (75%) * note最后更新 note\info.md 完成 note系列存疑： http://api.bilibili.com/x/note/is_gray * 修改【视频笔记】相关api * 漏写了一个对号，加上(QAQ) Co-authored-by: SocialSisterYi <45892418+SocialSisterYi@users.noreply.github.com> --- README.md | 6 +- note/action.md | 2 +- note/info.md | 195 +++++++++++++++++++++++++++++++++++++++++++++++ note/list.md | 135 ++++++++++++++++++++++++++++++++ note/readme.md | 94 ++++++++++++++++++++++- user/relation.md | 2 +- 6 files changed, 425 insertions(+), 9 deletions(-) create mode 100644 note/info.md create mode 100644 note/list.md diff --git a/README.md b/README.md index 71ad38b..fe976e6 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,9 @@ PS：所有http协议地址均可使用https，文档中为了统一写作`http` - 屏蔽管理 - 智能防挡弹幕 - [弹幕个人配置修改](danmaku/config.md)√ -- [视频笔记](note)× - - 笔记列表 - - 笔记详细信息 +- [视频笔记](note)√ + - [笔记列表](note/list.md)√ + - [笔记详细信息](note/info.md)√ - [笔记操作](note/action.md)√ - [专栏](article) - 分区 diff --git a/note/action.md b/note/action.md index e4236c0..4e6ba7c 100644 --- a/note/action.md +++ b/note/action.md @@ -22,7 +22,7 @@ | title | str | 笔记标题 | 必要 | | | summary | str | 笔记预览文本 | 必要 | | | content | str | 笔记正文json序列 | 必要 | 格式见[附表](readme.md#附表-笔记正文序列格式) | -| tags | str | | 非必要 | 作用尚不明确 | +| tags | str | 笔记跳转标签列表 | 非必要 | | | cls | num | 1 | 非必要 | 作用尚不明确 | | from | str | 提交类型 | 非必要 | auto：自动提交
save：手动提交
close：关闭时自动提交 | | csrf | str | CSRF Token（位于cookie） | 必要 | | diff --git a/note/info.md b/note/info.md new file mode 100644 index 0000000..d62d913 --- /dev/null +++ b/note/info.md @@ -0,0 +1,195 @@ +# 笔记详细信息 + +- [查询视频笔记](#查询视频笔记) +- [查询笔记内容](#查询笔记内容) + +--- + +## 查询视频笔记 + +> http://api.bilibili.com/x/note/list/archive + +*请求方式：GET* + +认证方式：Cookie（SESSDATA） + +**url参数：** + +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ------- | ---- | ------------ | ----------- | -------- | +| aid | num | 稿件avID | 必要（可选） | avID与bvID任选一个 | +| bvid | str | 稿件bvID | 必要（可选） | avID与bvID任选一个 | +| csrf | str | CSRF Token（位于cookie） | 非必要 | | + +**json回复：** + +根对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------- | ---- | -------- | --------------------------------------------------- | +| code | num | 返回值 | 0：成功
-400：请求错误
-101：账号未登录 | +| message | str | 错误信息 | 默认为0 | +| ttl | num | 1 | | +| data | obj | 信息本体 | | + +`data`对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------- | ----- | -------- | -------------------------------------------------- | +| noteIds | array | 笔记列表 | 无笔记则无此项
可能后续会允许视频添加多个笔记 | + +`data`中的`noteIds`数组： + +| 项 | 类型 | 内容 | 备注 | +| ---- | ---- | ----------- | ---------------- | +| 0 | num | 笔记ID | | + +**示例：** + +查询视频`av970322090`/`BV1op4y167Uo`的笔记ID + +avID方式： + +```shell +curl 'http://api.bilibili.com/x/note/list/archive' \ +--data-urlencode 'aid=970322090' \ +-b 'SESSDATA=xxx' +``` + +bvID方式： + +```shell +curl 'http://api.bilibili.com/x/note/list/archive' \ +--data-urlencode 'bvid=BV1op4y167Uo' \ +-b 'SESSDATA=xxx' +``` + +
+查看响应示例： + +```json +{ + "code":0, + "message":"0", + "ttl":1, + "data":{ + "noteIds":[ + 3809605586518023 + ] + } +} +``` + +
+ +## 查询笔记内容 + +> http://api.bilibili.com/x/note/info + +*请求方式：GET* + +认证方式：Cookie（SESSDATA） + +**url参数：** + +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ------- | ---- | ---------- | ----------- | -------- | +| aid | num | 稿件avID | 必要（可选）| avID与bvID任选一个，不与笔记所属稿件avID相同不影响返回 | +| bvid | str | 稿件bvID | 必要（可选）| avID与bvID任选一个，不与笔记所属稿件bvID相同不影响返回 | +| note_id | num | 笔记ID | 必要 | | + +**json回复：** + +根对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------- | ---- | -------- | --------------------------------------------------- | +| code | num | 返回值 | 0：成功
-400：请求错误
-101：账号未登录
79502：笔记详情未找到| +| message | str | 错误信息 | 默认为0 | +| ttl | num | 1 | | +| data | obj | 信息本体 | | + +`data`对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------------ | ----- | ---------------- | -------------- | +| title | str | 笔记标题 | | +| summary | str | 笔记预览文本 | | +| content | str | 笔记正文json序列 | 格式见[附表](readme.md#附表-笔记正文序列格式) | +| tags | array | 笔记跳转标签列表 | | +| cid_count | num | 视频分P数 | | +| audit_status | num | 0 | 作用暂不明确 | +| aid | num | 稿件avID | | + +`data`中的`tags`数组： + +| 项 | 类型 | 内容 | 备注 | +| ---- | ---- | ----------- | ---------------- | +| 0 | obj | 标签1 | | +| n | obj | 标签（n+1） | 按照笔记中位置排列 | +| …… | obj | …… | …… | + +`tags`中的对象： + +| 字段 | 类型 | 内容 | 备注 | +| -------- | ---- | ----------------- | ------------ | +| cid | num | 视频cid | | +| status | num | 0 | 作用尚不明确 | +| index | num | 在稿件中的分P索引 | | +| seconds | num | 视频进度 | | +| pos | num | 笔记中位置 | | + +**示例：** + +查询视频`av583785685`/`BV1kz4y1X7XP`中笔记`7165769906913287`的内容 + +avID方式： + +```shell +curl 'http://api.bilibili.com/x/note/info' \ +--data-urlencode 'aid=583785685' \ +--data-urlencode 'note_id=7165769906913287' \ +-b 'SESSDATA=xxx' +``` + +bvID方式： + +```shell +curl 'http://api.bilibili.com/x/note/info' \ +--data-urlencode 'bvid=BV1kz4y1X7XP' \ +--data-urlencode 'note_id=7165769906913287' \ +-b 'SESSDATA=xxx' +``` + +
+查看响应示例： + +```json +{ + "code":0, + "message":"0", + "ttl":1, + "data":{ + "title":"【cmd】访问api 命令行也能上B站", + "summary":"项目介绍 才324个star？哦7月4日没事了 二维码登录流程介绍 正式开", + "content":"{ + "insert":{ + "tag":{ + "cid":209620774, + "status":0, + "index":1, + "seconds":5, + "cidCount":1, + "key":"1611921905204", + "title":"【cmd】访问api 命令行也能上B站_x264" + } + } + }..." + "cid_count":1, + "audit_status":0, + "aid":583785685 + } +} +``` + +
\ No newline at end of file diff --git a/note/list.md b/note/list.md new file mode 100644 index 0000000..bf198f6 --- /dev/null +++ b/note/list.md @@ -0,0 +1,135 @@ +# 笔记列表 + +- [查询所有笔记列表](#查询笔记列表) + +## 查询所有笔记列表 + +> http://api.bilibili.com/x/note/list + +*请求方式：GET* + +认证方式：Cookie（SESSDATA） + +**url参数：** + +| 参数名 | 类型 | 内容 | 必要性 | 备注 | +| ------- | ---- | ------------ | ----------- | ------------------------------------------------------- | +| ps | num | 每页项数 | 必要 | | +| pn | num | 页码 | 必要 | | +| csrf | str | CSRF Token（位于cookie） | 非必要 | | + +**json回复：** + +根对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------- | ---- | -------- | --------------------------------------------------- | +| code | num | 返回值 | 0：成功
-400：请求错误
-101：账号未登录 | +| message | str | 错误信息 | 默认为0 | +| ttl | num | 1 | | +| data | obj | 信息本体 | | + +`data`对象： + +| 字段 | 类型 | 内容 | 备注 | +| ---------- | ----- | -------- | ------------ | +| list | array | 明细列表 | | +| page | obj | 页面信息 | | + +`data`中的`list`数组： + +| 项 | 类型 | 内容 | 备注 | +| ---- | ---- | ----------- | ---------------- | +| 0 | obj | 笔记1 | | +| n | obj | 笔记（n+1） | 按照创建顺序排列 | +| …… | obj | …… | …… | + +`list`中的对象： + +| 字段 | 类型 | 内容 | 备注 | +| --------------- | ---- | ------------ | ---------------------- | +| title | str | 笔记标题 | | +| summary | str | 笔记预览文本 | | +| mtime | str | 提交时间 | | +| arc | obj | 视频信息 | | +| note_id | num | 笔记ID | | +| audit_status | num | 0 | 作用尚不明确 | + +`list`中的`arc`中的对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------ | ---- | ------------ | ---------------------- | +| aid | num | 稿件avID | | +| bvid | str | 稿件bvID | | +| pic | str | 稿件封面图片url | | +| desc | str | 视频简介 | | +| status | num | 0 | | + +`data`中的`page`对象： + +| 字段 | 类型 | 内容 | 备注 | +| ------ | ---- | ------------ | -------------------- | +| total | num | 笔记总数 | | +| size | num | 每页项数 | | +| num | num | 页码 | | + +**示例：** + +获取笔记列表 + +```shell +curl 'http://api.bilibili.com/x/note/list' \ +--data-urlencode 'ps=10' \ +--data-urlencode 'pn=1' +-b 'SESSDATA=xxx' +``` + +
+查看响应示例： + +```json +{ + "code":0, + "message":"0", + "ttl":1, + "data":{ + "list":[ + { + "title":"周刊哔哩哔哩排行榜#543", + "summary":"test", + "mtime":"2020-11-23 17:45", + "arc":{ + "aid":970322090, + "bvid":"BV1op4y167Uo", + "pic":"http://i1.hdslb.com/bfs/archive/cc67f9c9b70d6eb97f00e726517c8c3da540ee05.jpg", + "desc":"20年11月第3周 | 【PICK UP】栏目欢迎继续推荐，私信@周刊娘 ，附上推荐投稿的av/bv号与理由。请勿刷屏、引战", + "status":0 + }, + "note_id":3809605586518023, + "audit_status":0 + }, + { + "title":"【MV】保加利亚妖王AZIS视频合辑", + "summary":"test2", + "mtime":"2020-11-20 16:44", + "arc":{ + "aid":170001, + "bvid":"BV17x411w7KC", + "pic":"http://i2.hdslb.com/bfs/archive/1ada8c32a9d168e4b2ee3e010f24789ba3353785.jpg", + "desc":"sina 保加利亚超级天王 Azis1999年出道。他的音乐融合保加利亚名族曲风chalga和pop、rap等元素，不过他惊艳的易装秀与浮夸的角色诠释才是他最为出名的地方 Azis与众多保加利亚天王天后级歌手都有过合作.06年，他作为Mariana Popova的伴唱，在欧洲半决赛上演唱了他们的参赛曲Let Me Cry 06年他被Velikite Balgari评为保加利亚有史以来最伟大的名人之一", + "status":0 + }, + "note_id":3988570796195843, + "audit_status":0 + } + ], + "page":{ + "total":2, + "size":10, + "num":1 + } + } +} +``` + +
diff --git a/note/readme.md b/note/readme.md index b68941f..767a5a0 100644 --- a/note/readme.md +++ b/note/readme.md @@ -2,13 +2,15 @@ 2020-11-16 B站推出了测试版的功能——"视频笔记"，与视频稿件关联，为富文本模式，可供记录观看视频时的感悟以及视频中的重要内容，目前只可在web端操作 +目前单个稿件只能添加一篇笔记（与分P无关） + --- -继续查看： +**继续查看：** -- 笔记列表 -- 笔记详细信息 -- [笔记操作](action.md)√ +- [笔记列表](list.md) +- [笔记详细信息](info.md) +- [笔记操作](action.md) --- @@ -69,3 +71,87 @@ | status | str | done | 作用尚不明确 | | width | num | 图片宽度-2 | | +示例： + +以下笔记正文序列包含`字号`、`加粗`、`高亮`、`普通文本`格式 + +```json +[ + { + "attributes": { + "size": "24px", + "bold": true + }, + "insert": "关掉" + }, + { + "attributes": { + "size": "24px" + }, + "insert": "，" + }, + { + "attributes": { + "size": "24px", + "bold": true + }, + "insert": "关掉" + }, + { + "insert": "，" + }, + { + "attributes": { + "background": "#fff359" + }, + "insert": "一定要" + }, + { + "attributes": { + "background": "#fff359", + "bold": true + }, + "insert": "关掉" + }, + { + "insert": "\n再不关掉那些" + }, + { + "attributes": { + "bold": true + }, + "insert": "网络游戏" + }, + { + "insert": "，小孩哪有" + }, + { + "attributes": { + "bold": true + }, + "insert": "美好的未来" + }, + { + "insert": "，哪有" + }, + { + "attributes": { + "bold": true + }, + "insert": "美好的前程" + }, + { + "insert": "，祖国哪有" + }, + { + "attributes": { + "bold": true + }, + "insert": "栋梁之才" + }, + { + "insert": "\n" + } +] +``` + diff --git a/user/relation.md b/user/relation.md index 9494e74..6ad58c3 100644 --- a/user/relation.md +++ b/user/relation.md @@ -34,7 +34,7 @@ 认证方式：Cookie（SESSDATA）或APP -登录可看自己全部，其他用户仅可查看前5页 +登录可看自己前1000名，其他用户仅可查看前100名 **url参数：**