MOD:增加接口文档

ShilongLee · Jul 14, 2024 · e94f81a · e94f81a
1 parent 13d8705
commit e94f81a
Show file tree

Hide file tree

Showing 8 changed files with 203 additions and 0 deletions.
diff --git a/docs/api/bilibili/bilibili.md b/docs/api/bilibili/bilibili.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/bilibili/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/douyin/douyin.md b/docs/api/douyin/douyin.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/douyin/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/jd/jd.md b/docs/api/jd/jd.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/jd/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/kuaishou/kuaishou.md b/docs/api/kuaishou/kuaishou.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/kuaishou/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/taobao/taobao.md b/docs/api/taobao/taobao.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/taobao/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/weibo/weibo.md b/docs/api/weibo/weibo.md
@@ -31,6 +31,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/weibo/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/api/xhs/xhs.md b/docs/api/xhs/xhs.md
@@ -33,6 +33,34 @@
 | data | true | struct | 数据 |
 | msg | true | string | 请求说明(成功、参数错误、服务器错误) |
 
+### 过期账号
+
+- **功能说明**
+
+用于标记账号过期，之后不再使用该账号发送请求。
+
+- **URL**
+
+  `/xhs/expire_account`
+
+- **Method**
+
+  `POST`
+
+- **Data Params**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| id | true | string | 账户名(用于管理用户cookie) |
+
+- **Response**
+
+| 参数 | 必选 | 类型 | 说明 |
+|:---:|:---:|:---:|:---:|
+| code | true | int | 0: 成功 1: 参数错误 2: 服务器错误 |
+| data | true | struct | 数据 |
+| msg | true | string | 请求说明(成功、参数错误、服务器错误) |
+
 ### 获取账号列表
 
 - **URL**

diff --git a/docs/doc.md b/docs/doc.md
@@ -5,6 +5,7 @@
 目前支持以下接口：
 
 - 添加抖音账号
+- 过期抖音账号
 - 获取抖音账号列表
 - 抖音视频信息获取
 - 抖音视频评论获取
@@ -19,6 +20,7 @@
 目前支持以下接口：
 
 - 添加快手账号
+- 过期快手账号
 - 获取快手账号列表
 - 快手视频信息获取
 - 快手视频评论获取
@@ -33,6 +35,7 @@
 目前支持以下接口：
 
 - 添加哔哩哔哩账号
+- 过期哔哩哔哩账号
 - 获取哔哩哔哩账号列表
 - 哔哩哔哩视频信息获取
 - 哔哩哔哩视频评论获取
@@ -47,6 +50,7 @@
 目前支持以下接口：
 
 - 添加小红书账号
+- 过期小红书账号
 - 获取小红书账号列表
 - 小红书视频信息获取
 - 小红书视频评论获取
@@ -61,6 +65,7 @@
 目前支持以下接口：
 
 - 添加淘宝账号
+- 过期淘宝账号
 - 获取淘宝账号列表
 - 淘宝搜索结果获取
 
@@ -71,6 +76,7 @@
 目前支持以下接口：
 
 - 添加京东账号
+- 过期京东账号
 - 获取京东账号列表
 - 京东搜索结果获取
 
@@ -81,6 +87,7 @@
 目前支持以下接口：
 
 - 添加微博账号
+- 过期微博账号
 - 获取微博账号列表
 - 微博视频信息获取
 - 微博视频评论获取