API 文档

使用 API 文档，您可以轻松地集成乐知付加密平台，完成资源的管理、支付处理、订单管理以及相关数据的查看功能。

重要提示

所有接口调用都需要在 HTTP 请求头中设置密钥：X-API-Key: [your-secret-key]
对于 POST 请求，除指定content-type外，其余接口请设置请求体格式：Content-Type: application/json

资源管理 API

资源管理 API 提供了完整的资源操作能力，包括资源的创建、查询、更新等操作。

查询资源详情

获取指定资源的详细信息

请求说明

Method: POST

URL: /api/v1/resource/query_resource_info

请求参数

参数名	类型	必填	说明
`user_id`	int	是	用户ID
`resource_id`	int	是	资源ID

响应示例

{
    "data": {
        "create_time": "2025-08-10 16:54:00",
        "payment_id": "709",
        "resource_type": 3,
        "payment_url": "http://lezhifu.cc/admin/pay_info?xxxxxxxxx",
        "resource_description": "这里是资源描述",
        "resource_id": 700,
        "resource_price": 0.01,
        "resource_name": "资源标题",
        "resource_qrcode_path": "https://www.lezhifu.cc/xxxxxxx.png",
        "resource_status": 0,
        "update_time": "2025-08-12 23:00:19",
        "user_id": "18"
    },
    "message": "读取资源详情成功",
    "status_code": 200
}

响应字段说明

字段名	类型	说明
`resource_id`	integer	资源ID
`user_id`	integer	用户ID
`resource_name`	string	资源标题
`resource_description`	string	资源描述
`resource_type`	integer	资源类型 (1: 简洁资源, 3: 长文本资源)
`resource_price`	number	资源价格
`resource_status`	integer	资源状态 (0-创建 1-审核通过 2-审核不通过 3-用户删除 4-下架)
`payment_id`	integer	支付ID
`resource_qrcode_path`	string	资源二维码图片路径
`payment_url`	string	支付链接
`create_time`	string	创建时间
`update_time`	string	更新时间

更新资源类型

修改指定资源的类型

请求说明

Method: POST

URL: /api/v1/resource/update_resource_type

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_type`	integer	是	资源类型 (1: 简洁资源, 3: 长文本资源（支持富文本编辑资源描述和隐藏内容）)

响应示例

{
  "status_code": 200,
  "message": "更新资源类型成功"
}

更新资源名称

修改指定资源的标题名称

请求说明

Method: POST

URL: /api/v1/resource/update_resource_name

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_name`	string	是	资源名称 (最大500字符)

响应示例

{
  "status_code": 200,
  "message": "更新资源名称成功"
}

更新资源价格

修改指定资源的价格

请求说明

Method: POST

URL: /api/v1/resource/update_resource_price

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_price`	number	是	资源价格 (0.1-300)

响应示例

{
  "status_code": 200,
  "message": "更新资源价格成功"
}

更新资源隐藏内容

修改指定资源的隐藏内容

请求说明

Method: POST

URL: /api/v1/resource/update_resource_hidden_content

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_hidden_content`	string	是	资源隐藏内容

响应示例

{
  "status_code": 200,
  "message": "更新资源隐藏内容成功"
}

更新资源描述

修改指定资源的描述信息

请求说明

Method: POST

URL: /api/v1/resource/update_resource_description

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_description`	string	是	资源描述

响应示例

{
  "status_code": 200,
  "message": "更新资源描述成功"
}

更新资源状态

修改指定资源的状态

请求说明

Method: POST

URL: /api/v1/resource/update_resource_status

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`resource_status`	integer	是	资源状态 (3: 删除, 4: 下架)

响应示例

{
  "status_code": 200,
  "message": "更新资源状态成功"
}

新增资源

创建一个新的资源

请求说明

Method: POST

URL: /api/v1/resource/add_resource

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_type`	integer	是	资源类型 (1: 简洁资源, 3: 长文本资源（支持富文本编辑资源描述和隐藏内容）)
`resource_name`	string	是	资源名称
`resource_description`	string	是	资源描述
`resource_hidden_content`	string	是	资源隐藏内容
`resource_price`	number	是	资源价格 (0.1-300)

响应示例

{
  "status_code": 200,
  "message": "新增资源成功"
}

上传资源附件

为指定资源上传附件文件

请求说明

Method: POST

URL: /api/v1/resource/upload_resource_attachment_files

Content-Type: multipart/form-data

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`is_public`	integer	是	是否公开 (0: 私有, 1: 公开)
`attachment_file`	file	是	附件文件

响应示例

{
  "status_code": 200,
  "message": "上传附件成功"
}

查询资源附件

获取指定资源的所有附件信息

请求说明

Method: POST

URL: /api/v1/resource/query_resource_attachment_files

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID

响应示例

{
  "status_code": 200,
  "message": "查询资源附件成功",
  "data": [
    "/static/files/attachment/18/700/file1.pdf",
    "/static/files/attachment/18/700/file2.docx"
  ]
}

响应字段说明

字段名	类型	说明
`data`	array	附件文件路径数组

查询订单列表

获取指定用户的订单列表信息

请求说明

Method: POST

URL: /api/v1/order/query_order_list

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`status`	string	否	订单状态过滤 (paid:已支付, failed:失败, paying:支付中, scaned:已扫码, recharging:充值中, recharged:已充值)
`page`	integer	否	页码，默认为1
`page_size`	integer	否	每页数量，默认为10，最大100

响应示例

{
  "status_code": 200,
  "message": "查询订单列表成功",
  "data": {
    "orders": [
      {
        "order_id": "1220fefc03c2f4bc65dd3415ca457793",
        "resource_id": 557,
        "resource_name": "test附件上传",
        "trade_no": "4200002789202507194154826589",
        "trade_status": "paid",
        "payment_id": 565,
        "payment_amount": 0.1,
        "payment_channel": "wechatpay",
        "create_time": "2025-07-19 00:36:34",
        "update_time": "2025-07-19 00:38:01"
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 10,
      "total": 4,
      "total_pages": 1
    }
  }
}

响应字段说明

字段名	类型	说明
`orders`	array	订单列表
`order_id`	string	订单ID
`resource_id`	integer	资源ID
`resource_name`	string	资源名称
`trade_no`	string	支付平台交易号
`trade_status`	string	交易状态 (paid:已支付, failed:失败, paying:支付中, scaned:已扫码, recharging:充值中, recharged:已充值)
`payment_id`	integer	支付ID
`payment_amount`	number	支付金额
`payment_channel`	string	支付渠道 (alipay:支付宝, wechatpay:微信支付)
`create_time`	string	创建时间
`update_time`	string	更新时间
pagination 分页信息:
`page`	integer	当前页码
`page_size`	integer	每页数量
`total`	integer	总记录数
`total_pages`	integer	总页数

查询订单详情

获取指定订单的详细信息

请求说明

Method: POST

URL: /api/v1/order/query_order_info

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`resource_id`	integer	是	资源ID
`order_id`	string	是	订单ID

响应示例

{
  "status_code": 200,
  "message": "查询订单详情成功",
  "data": {
    "order_id": "20230810165400001",
    "resource_id": 700,
    "resource_name": "资源标题",
    "trade_no": "2023081022001234567890",
    "trade_status": "paid",
    "payment_id": 709,
    "payment_amount": 2.0,
    "payment_channel": "alipay",
    "create_time": "2023-08-10 16:54:00",
    "update_time": "2023-08-10 16:55:30"
  }
}

响应字段说明

字段名	类型	说明
`order_id`	string	订单ID
`resource_id`	integer	资源ID
`resource_name`	string	资源名称
`trade_no`	string	支付平台交易号
`trade_status`	string	交易状态 (paid:已支付, failed:失败, paying:支付中, scaned:已扫码, recharging:充值中, recharged:已充值)
`payment_id`	integer	支付ID
`payment_amount`	number	支付金额
`payment_channel`	string	支付渠道 (alipay:支付宝, wechatpay:微信支付)
`create_time`	string	创建时间
`update_time`	string	更新时间

查询账户余额

获取指定用户的账户余额信息

请求说明

Method: POST

URL: /api/v1/account/query_balance

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID

响应示例

{
  "status_code": 200,
  "message": "查询账户余额成功",
  "data": 39.86
}

响应字段说明

字段名	类型	说明
`data`	number	账户余额（单位：元）

查询账户提现中金额

获取指定用户正在提现中的金额

请求说明

Method: POST

URL: /api/v1/account/query_withdrawing_balance

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID

响应示例

{
  "status_code": 200,
  "message": "查询账户提现中金额成功",
  "data": 0.0
}

响应字段说明

字段名	类型	说明
`data`	number	账户提现中金额（单位：元）

查询账户已提现总额

获取指定用户已提现的总金额

请求说明

Method: POST

URL: /api/v1/account/query_withdrawed_balance

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID

响应示例

{
  "status_code": 200,
  "message": "查询账户已提现总金额成功",
  "data": 0.0
}

查询订阅用户列表

获取指定用户的订阅者列表

请求说明

Method: POST

URL: /api/v1/subscribe/subscribe_list

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID

响应示例

{
    "data": [
        {
            "create_time": "2025-08-10 16:29:39",
            "status": 0,
            "subscribe_type": "email",
            "subscriber_name": "25***17",
            "user_id": "18"
        },
        {
            "create_time": "2025-08-10 14:35:19",
            "status": 1,
            "subscribe_type": "email",
            "subscriber_name": "22***98",
            "user_id": "18"
        },
        {
            "create_time": "2025-08-09 22:05:03",
            "status": 1,
            "subscribe_type": "email",
            "subscriber_name": "ch***09",
            "user_id": "18"
        }
    ],
    "message": "获取订阅用户列表成功",
    "status_code": 200
}

响应字段说明

字段名	类型	说明
`data`	array	订阅者信息数组
`user_id`	string	用户ID
`subscriber_name`	string	订阅者标识（根据订阅类型可能是邮箱、手机号、微信号等）
`subscribe_type`	string	订阅类型 (wechat: 微信, email: 邮箱, sms: 短信, alipay: 支付宝)
`status`	integer	订阅状态 (0: 取消订阅, 1: 订阅中)
`create_time`	string	创建时间

查询微信服务号OpenID

查询商家是否关注微信服务号（乐小密）并获取OpenID

请求说明

Method: POST

URL: /api/v1/wechat_service/query_wechat_openid

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID

响应示例

{
  "data": "ovmuevitxxxxxKX0PW4",
  "message": "查询商家是否关注微信服务号（乐小密）成功",
  "status_code": 200
}

响应字段说明

字段名	类型	说明
`data`	string	微信OpenID（如果用户未关注服务号则不返回此字段）
`message`	string	响应消息
`status_code`	integer	状态码 (200: 成功, 1201: 未绑定微信)

错误码说明

状态码	说明
`200`	查询成功
`1201`	未关注微信服务号（乐小密）
`500`	未知错误

发送微信消息

向已关注微信服务号的用户发送预定义的微信消息

请求说明

Method: POST

URL: /api/v1/wechat_service/wechat_message_send

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`open_id`	string	是	微信OpenID
`message`	string	是	消息内容标识: "1" - 昨日交易统计 "2" - 近7日交易统计 "3" - 上月（1号到昨日）交易统计 "4" - 本年交易统计

响应示例

{
  "message": "发送微信消息成功",
  "status_code": 200
}

错误码说明

状态码	说明
`200`	发送成功
`1201`	未关注微信服务号（乐小密）
`1202`	微信消息内容为空
`1203`	无效的微信消息内容
`1204`	缺少微信OpenID
`500`	未知错误

查询微信订阅设置

查询指定微信用户的订阅内容设置

请求说明

Method: POST

URL: /api/v1/wechat_service/query_wechat_subscribe_setting

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`open_id`	string	是	微信OpenID
`subscribe_content_type`	string	是	订阅内容类型: "EVERY_TRANSACTION" - 每笔交易 "TRANSACTION_DAILY" - 每日交易汇总 "TRANSACTION_WEEKLY" - 每周交易汇总 "TRANSACTION_MONTHLY" - 每月交易汇总 "TRANSACTION_YEARLY" - 每年交易汇总 "BALANCE_DAILY" - 每日账户余额通知 "BALANCE_WEEKLY" - 每周账户余额通知 "BALANCE_MONTHLY" - 每月账户余额通知 "BALANCE_YEARLY" - 每年账户余额通知 "WITHDRAW_SUCCESS" - 提现成功 "RECHARGE_SUCCESS" - 充值成功

响应示例

{
  "data": {
    "create_time": "2025-08-23 23:30:01",
    "open_id": "ovmuevitVASG9iVaRYZc4DKX0PW4",
    "status": 1,
    "subscribe_content_name": "每笔交易",
    "subscribe_content_type": "EVERY_TRANSACTION",
    "user_id": 18
  },
  "message": "查询微信订阅内容设置成功",
  "status_code": 200
}

响应字段说明

字段名	类型	说明
`open_id`	string	微信OpenID
`user_id`	integer	用户ID
`subscribe_content_type`	string	订阅内容类型
`subscribe_content_name`	string	订阅内容名称
`status`	integer	订阅状态 (1: 订阅, 0: 取消订阅)
`create_time`	string	创建时间

错误码说明

状态码	说明
`200`	查询成功
`1204`	缺少微信OpenID
`1205`	无效的微信订阅内容类型
`1206`	未查询到微信订阅内容设置
`500`	未知错误

更新微信订阅设置

更新指定微信用户的订阅内容设置

请求说明

Method: POST

URL: /api/v1/wechat_service/update_wechat_subscribe_setting

请求参数

参数名	类型	必填	说明
`user_id`	integer	是	用户ID
`open_id`	string	是	微信OpenID
`subscribe_content_type`	string	是	订阅内容类型: "EVERY_TRANSACTION" - 每笔交易 "TRANSACTION_DAILY" - 每日交易汇总 "TRANSACTION_WEEKLY" - 每周交易汇总 "TRANSACTION_MONTHLY" - 每月交易汇总 "TRANSACTION_YEARLY" - 每年交易汇总 "BALANCE_DAILY" - 每日账户余额通知 "BALANCE_WEEKLY" - 每周账户余额通知 "BALANCE_MONTHLY" - 每月账户余额通知 "BALANCE_YEARLY" - 每年账户余额通知 "WITHDRAW_SUCCESS" - 提现成功 "RECHARGE_SUCCESS" - 充值成功
`status`	integer	是	订阅状态 (1: 订阅, 0: 取消订阅)

响应示例

{
  "data": {
    "create_time": "2025-08-23 23:30:01",
    "open_id": "ovmuevxxxxxxxxxxxxKX0PW4",
    "status": 0,
    "subscribe_content_name": "每笔交易",
    "subscribe_content_type": "EVERY_TRANSACTION",
    "user_id": 18
  },
  "message": "修改微信订阅内容设置成功",
  "status_code": 200
}

响应字段说明

字段名	类型	说明
`open_id`	string	微信OpenID
`user_id`	integer	用户ID
`subscribe_content_type`	string	订阅内容类型
`subscribe_content_name`	string	订阅内容名称
`status`	integer	订阅状态 (1: 订阅, 0: 取消订阅)
`create_time`	string	创建时间

错误码说明

状态码	说明
`200`	更新成功
`1204`	缺少微信OpenID
`1205`	无效的微信订阅内容类型
`1207`	无效的微信订阅状态
`500`	未知错误