ADMIN_API.md 2.6 KB

后台管理 API 文档

本文档描述了新增的后台管理相关接口,用于查看用户反馈、积分、订单等数据。

1. 全局说明

  • 基础路径: /v2
  • 响应格式: 统一使用 GlobalResponseWrapper
  • 通用查询参数:
    • page: 页码 (默认 1)
    • size: 每页大小 (默认 10)
    • userId: 用户ID (可选)
    • keyword: 搜索关键字 (可选,具体匹配字段见接口说明)
    • startTime: 开始时间 (yyyy-MM-dd HH:mm:ss)
    • endTime: 结束时间 (yyyy-MM-dd HH:mm:ss)

2. 接口列表

2.1 用户反馈列表

  • URL: /user/feedback/list
  • Method: GET
  • 描述: 分页查询用户反馈。
  • Keyword匹配: 标题 (title) 或 内容 (content)

2.2 用户邀请记录列表

  • URL: /user/invite/list
  • Method: GET
  • 描述: 分页查询邀请记录。
  • UserId说明: 匹配邀请人ID (userId) 或 被邀请人ID (inviteeId)

2.3 用户消息列表

  • URL: /user/message/list
  • Method: GET
  • 描述: 分页查询用户消息。
  • Keyword匹配: 消息内容 (content)

2.4 用户积分订单列表

  • URL: /user/points/order/list
  • Method: GET
  • 描述: 分页查询积分充值订单。
  • Keyword匹配: 交易ID (transactionId)

2.5 用户积分变动记录列表

  • URL: /user/points/record/list
  • Method: GET
  • 描述: 分页查询积分获取/消耗记录流水。

2.6 用户积分使用记录列表

  • URL: /user/points/usage/list
  • Method: GET
  • 描述: 分页查询积分具体使用情况(如兑换商品等)。
  • Keyword匹配: 标题 (title) 或 订单ID (orderId)

2.7 用户兑换记录列表

  • URL: /user/redemption/record/list
  • Method: GET
  • 描述: 分页查询兑换码兑换记录。
  • Keyword匹配: 兑换码 (redemptionCode)

2.8 用户订阅订单列表

  • URL: /user/subscribe/order/list
  • Method: GET
  • 描述: 分页查询会员订阅订单。
  • Keyword匹配: 交易ID (transactionId) / 原始交易ID (originalTransactionId) / 产品ID (productId)

2.9 用户问卷提交记录列表

  • URL: /user/survey/list
  • Method: GET
  • 描述: 分页查询用户提交的问卷答案。
  • Keyword匹配: 标题 (title)

2.10 问卷列表

  • URL: /survey/list
  • Method: GET
  • 描述: 分页查询问卷定义(题目)。
  • Keyword匹配: 标题 (title)