Cookies 管理 API 文档

简介

此 API 提供了 Cookies 管理的功能，包括导入、添加、更新、删除、批量删除和分配 Cookies。此文档将详细列出各个 API 接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 标准响应结构
  • 身份认证
• 接口列表
  • 导入 Cookies 数据
  • 添加单个 Cookie
  • 更新单个 Cookie
  • 列出 Cookies
  • 查看特定 Cookie
  • 批量删除 Cookies
  • 删除单个 Cookie
  • 批量开启或关闭 Cookies
  • 批量分配 Cookies

通用方法

标准响应结构

所有接口的响应都遵循标准的 JSON 结构：

{
  "code": int,          // 状态码：0 表示成功，其他表示错误
  "message": string,    // 消息描述
  "data": array/object  // 数据，可能是数组或对象，默认为空数组
}

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

导入 Cookies 数据

• URL: /import_excel

• 方法: POST

• 权限: 需要认证

• 请求参数:

  • file: 上传的 Excel 文件

• 响应示例:

{
  "code": 0,
  "message": "Cookies 数据成功导入",
  "data": []
}

添加单个 Cookie

• URL: /add
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "cookie": string,        // 要添加的 Cookie 值
  "user_id": int,          // 关联的用户 ID
  "cookie_name": string    // Cookie 名称
}

• 响应示例:

{
  "code": 0,
  "message": "Cookie 添加成功",
  "data": []
}

更新单个 Cookie

• URL: /update/<int:cookie_id>
• 方法: PUT
• 权限: 需要认证
• 请求参数:

{
  "cookie": string,                 // Cookie 值
  "cookie_name": string,            // Cookie 名称
  "cookie_remain_message": int,     // Cookie 剩余消息数
  "cookie_avtar": string,           // Cookie 头像 URL
  "cookie_status": int,             // Cookie 状态
  "close_reason": string            // 关闭原因
}

• 响应示例:

{
  "code": 0,
  "message": "Cookie 记录修改成功",
  "data": []
}

列出 Cookies

• URL: /list

• 方法: GET

• 权限: 需要认证

• 请求参数（查询参数）:

  • cookie_id: （可选）按 Cookie ID 过滤
  • user_id: （可选）按用户 ID 过滤
  • cookie_name: （可选）按 Cookie 名称过滤
  • page: 页码，默认值为 1
  • limit: 每页的记录数，默认值为 15

• 响应示例:

{
  "code": 0,
  "msg": "",
  "count": int,     // 总记录数
  "data": [
    {
      "cookie_id": int,              // Cookie ID
      "cookie": string,              // Cookie 值
      "cookie_name": string,         // Cookie 名称
      "cookie_remain_message": int,  // Cookie 剩余消息数
      "cookie_avtar": string,        // Cookie 头像 URL
      "cookie_status": int,          // Cookie 状态
      "close_reason": string         // 关闭原因
    }
  ]
}

查看特定 Cookie

• URL: /view/<int:cookie_id>

• 方法: GET

• 权限: 需要认证

• 响应示例:

{
  "code": 0,
  "message": "Cookie 记录获取成功",
  "data": {
    "cookie_id": int,              // Cookie ID
    "cookie": string,              // Cookie 值
    "user_id": int,                // 关联的用户 ID
    "cookie_name": string,         // Cookie 名称
    "cookie_remain_message": int,  // Cookie 剩余消息数
    "cookie_avtar": string,        // Cookie 头像 URL
    "cookie_status": int,          // Cookie 状态
    "close_reason": string         // 关闭原因
  }
}

批量删除 Cookies

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "cookie_ids": [int]  // 要删除的 Cookie ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "成功删除 Cookie 记录",
  "data": []
}

删除单个 Cookie

• URL: /delete/<int:cookie_id>

• 方法: DELETE

• 权限: 需要认证

• 响应示例:

{
  "code": 0,
  "message": "Cookie 记录删除成功",
  "data": []
}

批量开启或关闭 Cookies

• URL: /toggle_batch_status
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "cookie_ids": [int],  // 要更新状态的 Cookie ID 列表
  "status": int         // 新的状态值
}

• 响应示例:

{
  "code": 0,
  "message": "成功批量更新 Cookie 状态",
  "data": []
}

批量分配 Cookies

• URL: /assign_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "cookie_ids": [int],  // 要分配的 Cookie ID 列表
  "user_id": int        // 分配到的用户 ID
}

• 响应示例:

{
  "code": 0,
  "message": "成功将 Cookies 分配给用户",
  "data": []
}

---

Material 管理 API 文档

简介

此 API 提供了素材管理的功能，包括添加、更新、列出、删除、审核和查看素材。文档将详细列出每个接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 标准响应结构
  • 身份认证
• 接口列表
  • 上传图片
  • 添加素材
  • 列出所有素材
  • 更新素材
  • 删除素材
  • 批量删除素材
  • 审核素材
  • 查看特定素材

通用方法

标准响应结构

所有接口的响应都遵循标准的 JSON 结构：

{
  "code": int,          // 状态码：0 表示成功，其他表示错误
  "message": string,    // 消息描述
  "data": array/object  // 数据，可能是数组或对象，默认为空数组
}

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

上传图片

• URL: /upload_image

• 方法: POST

• 权限: 需要认证

• 请求参数:

  • image: 要上传的图片文件

• 响应示例:

{
  "code": 0,
  "message": "Image uploaded successfully",
  "data": {
    "image_path": string  // 图片的相对路径
  }
}

添加素材

• URL: /add
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "user_id": int,           // 用户 ID
  "material_name": string,  // 素材名称
  "text": string            // 素材文本
}

• 响应示例:

{
  "code": 0,
  "message": "Material added successfully",
  "data": []
}

列出所有素材

• URL: /list/<int:user_id>

• 方法: GET

• 权限: 需要认证

• 请求参数（查询参数）:

  • text: （可选）按素材文本过滤
  • review_status: （可选）按审核状态过滤

• 响应示例:

{
  "code": 0,
  "message": "Materials retrieved successfully",
  "data": [
    {
      "material_id": int,        // 素材 ID
      "image_path": string,      // 图片路径
      "text": string,            // 素材文本
      "material_name": string,   // 素材名称
      "review_status": int       // 审核状态
    }
  ]
}

更新素材

• URL: /update/<int:material_id>
• 方法: PUT
• 权限: 需要认证
• 请求参数:

{
  "image_path": string,        // 图片路径
  "text": string,              // 素材文本
  "material_name": string,     // 素材名称
  "review_status": int         // 审核状态（0 - 未审核，1 - 通过，2 - 拒绝）
}

• 响应示例:

{
  "code": 0,
  "message": "Material updated successfully",
  "data": []
}

删除素材

• URL: /delete/<int:material_id>

• 方法: DELETE

• 权限: 需要认证

• 响应示例:

{
  "code": 0,
  "message": "Material deleted successfully",
  "data": []
}

批量删除素材

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "material_ids": [int]  // 要删除的素材 ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "成功删除素材记录",
  "data": []
}

审核素材

• URL: /review/<int:material_id>
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "review_status": int  // 审核状态（0 - 未审核，1 - 通过，2 - 拒绝）
}

• 响应示例:

{
  "code": 0,
  "message": "Material review status updated successfully",
  "data": []
}

查看特定素材

• URL: /view/<int:material_id>

• 方法: GET

• 权限: 需要认证

• 响应示例:

{
  "code": 0,
  "message": "Material retrieved successfully",
  "data": [
    {
      "material_id": int,      // 素材 ID
      "user_id": int,          // 用户 ID
      "image_path": string,    // 图片路径
      "text"
}
]}

---

Task 管理 API 文档

简介

此 API 提供了管理 Task（任务）的功能，包括添加、列出、删除、批量删除任务，以及分配 UID 和执行任务。此文档将详细列出各个 API 接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 标准响应结构
  • 身份认证
• 接口列表
  • 列出所有任务
  • 分配 UID
  • 添加任务
  • 删除任务
  • 批量删除任务

通用方法

标准响应结构

所有接口的响应都遵循标准的 JSON 结构：

{
  "code": int,          // 状态码：0 表示成功，其他表示错误
  "message": string,    // 消息描述
  "data": array/object  // 数据，可能是数组或对象，默认为空数组
}

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

列出所有任务

• URL: /list

• 方法: GET

• 权限: 需要认证

• 请求参数（查询参数）:

  • task_name: （可选）按任务名称过滤
  • status: （可选）按任务状态过滤

• 响应示例:

{
  "code": 0,
  "message": "Tasks retrieved successfully",
  "data": [
    {
      "task_id": int,
      "task_name": string,
      "status": string,
      "cookie_id": int,
      "cookie_name": string,
      "material_id": int,
      "material_name": string,
      "success_num": int,   // 成功发送的数量
      "failed_num": int,    // 失败的数量
      "all": int            // 总任务数
    }
  ]
}

分配 UID

• URL: /assign_uid
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "task_id": int,       // 要分配的任务 ID
  "record_ids": [int]   // 要分配的 UID 记录 ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "UID 分配已启动",
  "data": []
}

添加任务

• URL: /add
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "cookie_id": int,     // 要使用的 Cookie ID
  "material_id": int,   // 要使用的素材 ID
  "task_name": string,  // 任务名称
  "user_id": int        // 用户 ID
}

• 响应示例:

{
  "code": 0,
  "message": "任务添加成功",
  "data": []
}

删除任务

• URL: /delete/<int:task_id>

• 方法: DELETE

• 权限: 需要认证

• 响应示例:

{
  "code": 0,
  "message": "任务删除成功",
  "data": []
}

批量删除任务

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "task_ids": [int]  // 要删除的任务 ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "成功删除任务",
  "data": []
}

---

TaskUID 管理 API 文档

简介

此 API 提供了 TaskUID 管理的功能，包括列出、删除单条或批量删除 TaskUID 记录。此文档将详细列出各个 API 接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 标准响应结构
  • 身份认证
• 接口列表
  • 列出 TaskUID 记录
  • 删除单条 TaskUID
  • 批量删除 TaskUID 记录

通用方法

标准响应结构

所有接口的响应都遵循标准的 JSON 结构： ;;; { "code": int, // 状态码：0 表示成功，其他表示错误 "message": string, // 消息描述 "data": array/object // 数据，可能是数组或对象，默认为空数组 } ;;;

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

列出 TaskUID 记录

• URL: /list

• 方法: GET

• 权限: 需要认证

• 请求参数（查询参数）:

  • task_id: （可选）过滤条件，按任务 ID 过滤
  • success_flag: （可选）过滤条件，按成功标志过滤

• 响应示例: ;;; { "code": 0, "message": "TaskUIDs retrieved successfully", "data": [ { "task_uid_id": int, // TaskUID ID "task_id": int, // 任务 ID "record_id": int, // UID 记录 ID "success_flag": int, // 成功标志 "status": string, // 当前状态 "task_name": string, // 任务名称 "material_name": string, // 素材名称 "uid_name": string // UID 名称 } ] } ;;;

删除单条 TaskUID

• URL: /delete/<int:task_uid_id>

• 方法: DELETE

• 权限: 需要认证

• 响应示例: ;;; { "code": 0, "message": "TaskUID 删除成功", "data": [] } ;;;

批量删除 TaskUID 记录

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数: ;;; { "task_uid_ids": [int] // 要删除的 TaskUID ID 列表 } ;;;
• 响应示例: ;;; { "code": 0, "message": "成功批量删除 TaskUID 记录", "data": [] } ;;;

---

UID 管理 API 文档

简介

此 API 提供了管理 UID 记录的功能，包括导入、添加、更新、删除和查看 UID 记录。此文档将详细列出各个 API 接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 文件上传设置
  • 标准响应结构
  • 身份认证
• 接口列表
  • 导入 UID .txt 文件
  • 添加 UID
  • 更新 UID
  • 查看特定 UID
  • 列出所有 UID
  • 删除单条 UID
  • 批量删除 UID

通用方法

文件上传设置

• 上传文件目录:

  • Windows: D:\txt
  • 其他系统: /txt

• 允许的扩展名: txt

标准响应结构

所有接口的响应都遵循标准的 JSON 结构：

{
  "code": int,          // 状态码：0 表示成功，其他表示错误
  "message": string,    // 消息描述
  "data": array/object  // 数据，可能是数组或对象，默认为空数组
}

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

导入 UID .txt 文件

• URL: /import_txt

• 方法: POST

• 权限: 需要认证

• 请求参数:

  • file: 上传的 .txt 文件

• 响应示例:

{
  "code": 0,
  "message": "UID 数据正在导入",
  "data": []
}

添加 UID

• URL: /add
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "uid": "string"  // 要添加的 UID
}

• 响应示例:

{
  "code": 0,
  "message": "UID 正在后台导入",
  "data": []
}

更新 UID

• URL: /update/<int:record_id>
• 方法: PUT
• 权限: 需要认证
• 请求参数:

{
  "uid": "string",          // UID
  "uid_name": "string",     // UID 昵称
  "uid_avtar": "string",    // UID 头像 URL
  "xhs_id": "string",       // 小红书 ID
  "message_success": int    // 消息发送成功状态
}

• 响应示例:

{
  "code": 0,
  "message": "UID 记录修改成功",
  "data": []
}

查看特定 UID

• URL: /view/<int:uid_id>
• 方法: GET
• 权限: 需要认证
• 响应示例:

{
  "code": 0,
  "message": "UID 记录获取成功",
  "data": {
    "record_id": int,
    "uid": "string",
    "user_id": int,
    "uid_name": "string",
    "uid_avtar": "string",
    "xhs_id": "string",
    "message_success": int
  }
}

列出所有 UID

• URL: /list

• 方法: GET

• 权限: 需要认证

• 请求参数（查询参数）:

  • uid_name: （可选）按 UID 昵称过滤
  • message_success: （可选）按消息发送成功状态过滤
  • page: 页码，默认值为 1
  • limit: 每页的记录数，默认值为 15

• 响应示例:

{
  "code": 0,
  "msg": "",
  "count": int,     // 总记录数
  "data": [
    {
      "record_id": int,
      "uid": "string",
      "user_id": int,
      "uid_name": "string",
      "uid_avtar": "string",
      "xhs_id": "string",
      "message_success": int
    }
  ]
}

删除单条 UID

• URL: /delete/<int:record_id>
• 方法: DELETE
• 权限: 需要认证
• 响应示例:

{
  "code": 0,
  "message": "UID 记录删除成功",
  "data": []
}

批量删除 UID

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "record_ids": [int]  // 要删除的 UID 记录 ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "成功删除 UID 记录",
  "data": []
}

---

用户管理 API 文档

简介

此 API 提供了用户管理的功能，包括创建用户、更新用户信息、删除用户以及用户的登录验证等操作。此文档将详细列出各个 API 接口的请求方法、请求参数、响应结果等信息。

目录

• 通用方法
  • 标准响应结构
  • 身份认证
• 接口列表
  • 添加用户
  • 更新用户信息
  • 查看用户信息
  • 列出所有用户
  • 更新密码
  • 删除用户
  • 批量删除用户
  • 登录

通用方法

标准响应结构

所有接口的响应都遵循标准的 JSON 结构：

{
  "code": int,          // 状态码：0 表示成功，其他表示错误
  "message": string,    // 消息描述
  "data": array/object  // 数据，可能是数组或对象，默认为空数组
}

身份认证

大多数接口都需要提供 Authorization 标头携带 Bearer Token 以进行身份认证。未提供或令牌无效会导致接口返回 401 错误。

接口列表

添加用户

• URL: /add
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "username": "string",  // 用户名
  "password": "string",  // 密码
  "role": "string",      // 角色，默认 "1"
  "balance": "float",    // 余额，默认 "0.00"
  "yesterday_send": int, // 昨日发送数
  "today_send": int,     // 今日发送数
  "sum_send": int,       // 总发送数
  "send_date": "string"  // 发送日期，格式：'YYYY-MM-DD'
}

• 响应示例:

{
  "code": 0,
  "message": "用户添加成功",
  "data": []
}

更新用户信息

• URL: /update/<int:user_id>
• 方法: PUT
• 权限: 需要认证
• 请求参数:

{
  "username": "string",  // 用户名
  "role": "string",      // 角色
  "balance": "float",    // 余额
  "yesterday_send": int, // 昨日发送数
  "today_send": int,     // 今日发送数
  "sum_send": int,       // 总发送数
  "send_date": "string"  // 发送日期，格式：'YYYY-MM-DD'
}

• 响应示例:

{
  "code": 0,
  "message": "用户更新成功",
  "data": []
}

查看用户信息

• URL: /view/<int:user_id>
• 方法: GET
• 权限: 需要认证
• 响应示例:

{
  "code": 0,
  "message": "用户信息检索成功",
  "data": [
    {
      "user_id": int,
      "username": "string",
      "role": "string",
      "balance": "float",
      "yesterday_send": int,
      "today_send": int,
      "sum_send": int,
      "status": int,
      "send_date": "string"  // 格式：'YYYY-MM-DD'
    }
  ]
}

列出所有用户

• URL: /list
• 方法: GET
• 权限: 需要认证
• 请求参数（查询参数）:
  • username: （可选）按用户名过滤
  • role: （可选）按角色过滤
  • page: 页码，默认值为 1
  • limit: 每页的记录数，默认值为 15
• 响应示例:

{
  "code": 0,
  "message": "用户检索成功",
  "count": int,     // 总记录数
  "data": [
    {
      "user_id": int,
      "username": "string",
      "role": "string",
      "balance": "float",
      "yesterday_send": int,
      "today_send": int,
      "sum_send": int,
      "status": int,
      "send_date": "string"  // 格式：'YYYY-MM-DD'
    }
  ]
}

更新密码

• URL: /update_password/<int:user_id>
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "password": "string"  // 新密码
}

• 响应示例:

{
  "code": 0,
  "message": "密码更新成功",
  "data": []
}

删除用户

• URL: /delete/<int:user_id>
• 方法: DELETE
• 权限: 需要认证
• 响应示例:

{
  "code": 0,
  "message": "用户删除成功",
  "data": []
}

批量删除用户

• URL: /delete_batch
• 方法: POST
• 权限: 需要认证
• 请求参数:

{
  "user_ids": [int]  // 要删除的用户 ID 列表
}

• 响应示例:

{
  "code": 0,
  "message": "批量删除用户成功",
  "data": []
}

登录

• URL: /login
• 方法: POST
• 请求参数:

{
  "username": "string",  // 用户名
  "password": "string"   // 密码
}

• 响应示例:

{
  "code": 0,
  "message": "登录成功",
  "data": [
    {
      "user_id": int,
      "token": "string"  // 登录成功后生成的用户令牌
    }
  ]
}