# MuuCmf-T6 公共API文档 > 基于api目录控制器自动生成 ## 目录 - [认证相关 (Authentication)](#认证相关-authentication) - [地址管理 (Address)](#地址管理-address) - [评价相关 (Evaluate)](#评价相关-evaluate) - [搜索关键字 (Keywords)](#搜索关键字-keywords) - [消息相关 (Message)](#消息相关-message) - [应用模块 (Module)](#应用模块-module) - [反馈相关 (Feedback)](#反馈相关-feedback) - [系统配置 (Config)](#系统配置-config) - [微信小程序 (WechatMiniProgram)](#微信小程序-wechatminiprogram) - [微信公众号 (WechatOfficialAccount)](#微信公众号-wechatofficialaccount) - [企业微信 (WechatWork)](#企业微信-wechatwork) - [抖音小程序 (DouyinMiniProgram)](#抖音小程序-douyinminiprogram) - [支付相关 (Pay)](#支付相关-pay) - [提现相关 (Withdraw)](#提现相关-withdraw) - [公告相关 (Announce)](#公告相关-announce) - [作者/创作者 (Author)](#作者创作者-author) - [角色管理 (Role)](#角色管理-role) - [资金流水 (Capital)](#资金流水-capital) - [收藏相关 (Favorites)](#收藏相关-favorites) - [文件上传 (File)](#文件上传-file) - [历史记录 (History)](#历史记录-history) - [订单相关 (Orders)](#订单相关-orders) - [积分相关 (Score)](#积分相关-score) - [分享相关 (Share)](#分享相关-share) - [会员卡 (VipCard)](#会员卡-vipcard) - [验证码 (Verify)](#验证码-verify) - [代理服务 (Proxy)](#代理服务-proxy) - [二维码 (Qrcode)](#二维码-qrcode) - [点播服务 (Vod)](#点播服务-vod) - [定时任务 (Crontab)](#定时任务-crontab) --- ## 认证相关 Authentication ### 提交/编辑认证资料 - **接口路径**: `/api/authentication/edit` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 否 | 认证记录ID，编辑时传入 | | name | string | 是 | 真实姓名 | | card_no | string | 是 | 证件号码 | | card_type | int | 是 | 证件类型 | | front | string | 是 | 证件正面图片 | | back | string | 是 | 证件背面图片 | **返回示例:** ```json { "code": 200, "msg": "提交成功！", "data": {} } ``` ### 获取认证详情 - **接口路径**: `/api/authentication/detail` - **请求方法**: GET - **需要登录**: 是 **返回示例:** ```json { "code": 200, "msg": "提交成功！", "data": { "id": 1, "name": "张三", "card_type": 0, "card_no": "身份证号", "front": "图片URL", "back": "图片URL" } } ``` --- ## 地址管理 Address ### 获取默认地址 - **接口路径**: `/api/address/default` - **请求方法**: GET - **需要登录**: 是 **返回示例:** ```json { "code": 200, "msg": "获取成功！", "data": { "id": 1, "name": "张三", "phone": "13800138000", "pos_province": "北京市", "pos_city": "北京市", "pos_district": "朝阳区", "address": "详细地址", "first": 1 } } ``` ### 获取地址详情 - **接口路径**: `/api/address/detail` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 地址ID | ### 获取地址列表 - **接口路径**: `/api/address/lists` - **请求方法**: GET - **需要登录**: 是 ### 新增/编辑地址 - **接口路径**: `/api/address/edit` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 否 | 地址ID，编辑时传入 | | name | string | 是 | 收货人姓名 | | phone | string | 是 | 手机号码 | | pos_province | string | 是 | 省份 | | pos_city | string | 是 | 城市 | | pos_district | string | 是 | 区/县 | | address | string | 是 | 详细地址 | | first | int | 否 | 是否默认地址 1是 0否 | ### 设为默认地址 - **接口路径**: `/api/address/setDefault` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 地址ID | ### 删除地址 - **接口路径**: `/api/address/del` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 地址ID | --- ## 评价相关 Evaluate ### 获取评价统计 - **接口路径**: `/api/evaluate/statistical` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 是 | 应用名称 | | type | string | 是 | 类型 | | type_id | int | 是 | 类型ID | ### 获取评价列表 - **接口路径**: `/api/evaluate/lists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 是 | 应用名称 | | type | string | 是 | 类型 | | type_id | int | 是 | 类型ID | ### 提交/修改评价 - **接口路径**: `/api/evaluate/edit` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | | type | string | 是 | 类型 | | type_id | int | 是 | 类型ID | | content | string | 是 | 评价内容 | | images | string | 否 | 评价图片，逗号分隔 | | value | float | 是 | 评分值 | ### 获取评价详情 - **接口路径**: `/api/evaluate/detail` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | --- ## 搜索关键字 Keywords ### 用户搜索历史 - **接口路径**: `/api/keywords/history` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | shopid | int | 是 | 店铺ID | | rows | int | 否 | 每页数量，默认15 | ### 热门搜索关键字 - **接口路径**: `/api/keywords/hot` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | shopid | int | 是 | 店铺ID | | rows | int | 否 | 每页数量，默认15 | ### 新增搜索关键字 - **接口路径**: `/api/keywords/add` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | keyword | string | 是 | 搜索关键字 | | shopid | int | 是 | 店铺ID | --- ## 消息相关 Message ### 获取消息类型列表 - **接口路径**: `/api/message/type` - **请求方法**: GET - **需要登录**: 是 **返回示例:** ```json { "code": 200, "msg": "success", "data": [ { "id": 1, "title": "系统消息", "unread": 5 } ] } ``` ### 获取消息列表 - **接口路径**: `/api/message/lists` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | type_id | int | 否 | 消息类型ID | | keyword | string | 否 | 搜索关键字 | | rows | int | 否 | 每页数量，默认20 | ### 获取消息详情 - **接口路径**: `/api/message/detail` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 消息ID | ### 获取未读消息数量 - **接口路径**: `/api/message/unread` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | type_id | int | 否 | 消息类型ID，不传则返回所有未读数量 | ### 标记全部已读 - **接口路径**: `/api/message/isread` - **请求方法**: GET - **需要登录**: 是 --- ## 应用模块 Module ### 获取已安装应用列表 - **接口路径**: `/api/module/lists` - **请求方法**: GET - **需要登录**: 否 **返回示例:** ```json { "code": 200, "msg": "success", "data": ["vod", "article", "mall"] } ``` ### 查询应用是否启用 - **接口路径**: `/api/module/enable` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | name | string | 是 | 应用名称 | --- ## 反馈相关 Feedback ### 提交反馈 - **接口路径**: `/api/feedback/add` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | content | string | 是 | 反馈内容 | | type | string | 否 | 反馈类型，默认other | | images | string | 否 | 图片，逗号分隔 | --- ## 系统配置 Config ### 获取前台系统配置 - **接口路径**: `/api/config/system` - **请求方法**: GET - **需要登录**: 否 --- ## 微信小程序 WechatMiniProgram ### 获取小程序配置 - **接口路径**: `/api/wechatMiniProgram/config` - **请求方法**: GET - **需要登录**: 否 ### Code换取用户信息 - **接口路径**: `/api/wechatMiniProgram/code` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 微信登录code | **返回示例:** ```json { "code": 200, "msg": "success", "data": { "token": "Bearer xxx" } } ``` ### 小程序授权登录 - **接口路径**: `/api/wechatMiniProgram/login` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 微信登录code | | iv | string | 是 | 加密算法初始向量 | | encrypted_data | string | 是 | 加密数据 | | shopid | int | 是 | 店铺ID | ### 获取小程序码 - **接口路径**: `/api/wechatMiniProgram/unlimitQrcode` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | path | string | 是 | 小程序页面路径 | | scene | string | 否 | 场景值 | | width | string | 否 | 二维码宽度，默认500 | ### 绑定手机号 - **接口路径**: `/api/wechatMiniProgram/bindMobile` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 微信code | | iv | string | 是 | 加密算法初始向量 | | encrypted | string | 是 | 加密数据 | ### 获取跳转小程序列表 - **接口路径**: `/api/wechatMiniProgram/toMiniProgramLists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | rows | int | 否 | 每页数量，默认10 | ### 获取跳转小程序详情 - **接口路径**: `/api/wechatMiniProgram/toMiniProgramDetail` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 记录ID | --- ## 微信公众号 WechatOfficialAccount ### 获取公众号配置 - **接口路径**: `/api/wechatOfficialAccount/config` - **请求方法**: GET - **需要登录**: 否 ### 微信回调 - **接口路径**: `/api/wechatOfficialAccount/callback` - **请求方法**: GET/POST - **需要登录**: 否 ### 生成微信二维码 - **接口路径**: `/api/wechatOfficialAccount/qrcode` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | scene_key | string | 是 | 场景值 | ### 扫码登录 - **接口路径**: `/api/wechatOfficialAccount/scanLogin` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | openid | string | 是 | 用户openid | | scene_key | string | 是 | 场景值 | ### 检查是否已扫码 - **接口路径**: `/api/wechatOfficialAccount/hasScan` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | scene_key | string | 是 | 场景值 | ### 网页授权 - **接口路径**: `/api/wechatOfficialAccount/oauth` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | target_url | string | 否 | 授权后跳转地址 | ### 网页授权回调 - **接口路径**: `/api/wechatOfficialAccount/oauthCallback` - **请求方法**: GET - **需要登录**: 否 ### 生成JSSDK配置 - **接口路径**: `/api/wechatOfficialAccount/jssdk` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | url | string | 否 | 当前页面URL | | apis | array | 否 | 需要使用的JS接口列表 | --- ## 企业微信 WechatWork ### 获取企业微信配置 - **接口路径**: `/api/wechatWork/config` - **请求方法**: GET - **需要登录**: 否 ### 企业微信回调 - **接口路径**: `/api/wechatWork/callback` - **请求方法**: GET/POST - **需要登录**: 否 ### 网页授权 - **接口路径**: `/api/wechatWork/oauth` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | target_url | string | 否 | 授权后跳转地址 | ### 网页授权回调 - **接口路径**: `/api/wechatWork/oauthCallback` - **请求方法**: GET - **需要登录**: 否 ### 生成JSSDK配置 - **接口路径**: `/api/wechatWork/jssdk` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | url | string | 是 | 当前页面URL | | apis | array | 否 | 需要使用的JS接口列表 | --- ## 抖音小程序 DouyinMiniProgram ### 回调处理 - **接口路径**: `/api/douyinMiniProgram/callback` - **请求方法**: POST - **需要登录**: 否 ### Code换取用户信息 - **接口路径**: `/api/douyinMiniProgram/code` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 抖音登录code | | anonymous_code | string | 是 | 匿名code | ### 抖音小程序登录 - **接口路径**: `/api/douyinMiniProgram/login` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 抖音登录code | | anonymous_code | string | 是 | 匿名code | | userInfo | string | 否 | 用户信息JSON | | shopid | int | 是 | 店铺ID | ### 生成小程序码 - **接口路径**: `/api/douyinMiniProgram/createQrcode` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | path | string | 是 | 小程序页面路径 | ### 绑定手机号 - **接口路径**: `/api/douyinMiniProgram/bindMobile` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | code | string | 是 | 抖音code | | iv | string | 是 | 加密算法初始向量 | | encrypted | string | 是 | 加密数据 | --- ## 支付相关 Pay ### 发起支付 - **接口路径**: `/api/pay/pay` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | | channel | string | 否 | 渠道类型 | | pay_channel | string | 是 | 支付渠道 weixin | | notify_url | string | 否 | 自定义回调地址 | ### 查询支付订单 - **接口路径**: `/api/pay/query` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | | pay_channel | string | 是 | 支付渠道 | ### 退款 - **接口路径**: `/api/pay/refund` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | | refund | int | 是 | 退款类型 | | refund_to | int | 否 | 退款至 0余额 1原支付账户 | ### 支付回调 - **接口路径**: `/api/pay/callback/channel/{channel}/pay_channel/{pay_channel}/shopid/{shopid}/app/{app}` - **请求方法**: POST - **需要登录**: 否 --- ## 提现相关 Withdraw ### 发起提现 - **接口路径**: `/api/withdraw/withdraw` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | price | float | 是 | 提现金额(元) | | channel | string | 否 | 渠道类型，默认weixin_h5 | | pay_channel | string | 否 | 支付渠道，默认weixin | ### 提现回调 - **接口路径**: `/api/withdraw/notify` - **请求方法**: POST - **需要登录**: 否 --- ## 公告相关 Announce ### 获取公告详情 - **接口路径**: `/api/announce/detail` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 公告ID | ### 获取公告列表 - **接口路径**: `/api/announce/lists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | teminal | string | 否 | 终端标识 | | rows | int | 否 | 每页数量，默认3，最大10 | ### 获取公告分页列表 - **接口路径**: `/api/announce/pageLists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | teminal | string | 否 | 终端标识 | | rows | int | 否 | 每页数量，默认10，最大10 | --- ## 作者/创作者 Author ### 作者列表 - **接口路径**: `/api/author/lists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | keyword | string | 否 | 搜索关键字 | | rows | int | 否 | 每页数量，默认20 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 asc/desc | ### 作者详情 - **接口路径**: `/api/author/detail` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 作者ID | ### 关注/取消关注 - **接口路径**: `/api/author/follow` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | author_id | int | 是 | 作者ID | ### 检查是否已关注 - **接口路径**: `/api/author/isfollow` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | author_id | int | 是 | 作者ID | ### 关注列表 - **接口路径**: `/api/author/followList` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | rows | int | 否 | 每页数量，默认20 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | --- ## 角色管理 Role ### 角色列表 - **接口路径**: `/api/role/lists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | group_id | int | 否 | 分组ID | | keyword | string | 否 | 搜索关键字 | | rows | int | 否 | 每页数量，默认20，最大100 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 角色详情 - **接口路径**: `/api/role/detail` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 角色ID | ### 关注/取消关注角色 - **接口路径**: `/api/role/follow` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | author_id | int | 是 | 角色ID | ### 检查是否已关注角色 - **接口路径**: `/api/role/isfollow` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | author_id | int | 是 | 角色ID | ### 关注角色列表 - **接口路径**: `/api/role/followList` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | rows | int | 否 | 每页数量，默认20 | ### 角色分组列表 - **接口路径**: `/api/role/group` - **请求方法**: GET - **需要登录**: 否 --- ## 资金流水 Capital ### 获取资金流水 - **接口路径**: `/api/capital/flow` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | --- ## 收藏相关 Favorites ### 收藏列表 - **接口路径**: `/api/favorites/lists` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 收藏数量 - **接口路径**: `/api/favorites/count` - **请求方法**: GET - **需要登录**: 是 --- ## 文件上传 File ### 通用文件上传 - **接口路径**: `/api/file/upload` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | file | file | 是 | 上传的文件 | | shopid | int | 是 | 店铺ID | | enforce | string | 否 | 强制上传方法 auto/local/oss/cos | | filename | string | 否 | 自定义文件名 | ### 用户头像上传 - **接口路径**: `/api/file/avatar` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | file | file | 是 | 头像图片 | | shopid | int | 是 | 店铺ID | ### 编辑器文件上传 - **接口路径**: `/api/file/ueditor` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | action | string | 是 | 操作类型 uploadimage/uploadvideo/uploadfile | | file | file | 是 | 上传的文件 | | shopid | int | 是 | 店铺ID | ### 获取文件列表 - **接口路径**: `/api/file/lists` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | keyword | string | 否 | 搜索关键字 | | driver | string | 否 | 存储驱动类型 | | type | string | 否 | 文件类型 | | rows | int | 否 | 每页数量，默认20 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 写入附件数据 - **接口路径**: `/api/file/attachment` - **请求方法**: POST - **需要登录**: 是 --- ## 历史记录 History ### 历史记录列表 - **接口路径**: `/api/history/lists` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 历史记录数量 - **接口路径**: `/api/history/count` - **请求方法**: GET - **需要登录**: 是 --- ## 订单相关 Orders ### 创建订单 - **接口路径**: `/api/orders/create` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 是 | 应用名称 | | order_info_type | string | 是 | 订单信息类型 | | order_info_id | int | 是 | 订单信息ID | | formId | string | 否 | 表单ID(小程序消息) | | ... | ... | ... | 其他应用特定参数 | ### 订单列表 - **接口路径**: `/api/orders/list` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | status | string | 是 | 订单状态：all全部/0已取消/1待付款/2待发货/3待收货/4已完成/5已评价 | | rows | int | 否 | 每页数量，默认15 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 订单详情 - **接口路径**: `/api/orders/detail` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_no | string | 是 | 订单号 | ### 取消订单 - **接口路径**: `/api/orders/cancel` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 否 | 订单ID | | order_no | string | 否 | 订单号 | ### 删除订单 - **接口路径**: `/api/orders/delete` - **请求方法**: POST - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 否 | 订单ID | | order_no | string | 否 | 订单号 | --- ## 积分相关 Score ### 积分日志 - **接口路径**: `/api/score/log` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | rows | int | 否 | 每页数量，默认10 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | --- ## 分享相关 Share ### 分享列表 - **接口路径**: `/api/share/lists` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 分享数量 - **接口路径**: `/api/share/count` - **请求方法**: GET - **需要登录**: 是 --- ## 会员卡 VipCard ### 会员卡列表 - **接口路径**: `/api/vipCard/lists` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 否 | 应用名称 | | rows | int | 否 | 每页数量，默认20 | | order_field | string | 否 | 排序字段 | | order_type | string | 否 | 排序方式 | ### 会员卡详情 - **接口路径**: `/api/vipCard/detail` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | id | int | 是 | 会员卡ID | ### 查询商品可用会员卡 - **接口路径**: `/api/vipCard/productAble` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 是 | 应用名称 | | product_id | int | 是 | 商品ID | | product_type | string | 是 | 商品类型 | ### 获取用户最优惠会员卡 - **接口路径**: `/api/vipCard/userAble` - **请求方法**: GET - **需要登录**: 是 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | app | string | 是 | 应用名称 | | product_id | int | 是 | 商品ID | | product_type | string | 是 | 商品类型 | --- ## 验证码 Verify ### 发送验证码 - **接口路径**: `/api/verify/send` - **请求方法**: POST - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | account | string | 是 | 账号(手机号或邮箱) | | type | string | 是 | 类型 mobile/email | | send_verify_captcha | string | 否 | 图形验证码(高频请求时需要) | --- ## 代理服务 Proxy ### 图片代理 - **接口路径**: `/api/proxy/image` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | imageUrl | string | 是 | 图片URL | **返回示例:** ```json { "code": 200, "msg": "success", "data": "data:image/png;base64,..." } ``` --- ## 二维码 Qrcode ### 生成二维码 - **接口路径**: `/api/qrcode/create` - **请求方法**: GET - **需要登录**: 否 **请求参数:** | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | url | string | 是 | 需要生成二维码的URL | **返回:** 直接输出二维码图片 --- ## 点播服务 Vod ### 获取点播签名 - **接口路径**: `/api/vod/sign` - **请求方法**: GET - **需要登录**: 否 **返回示例:** ```json { "code": 200, "msg": "success", "data": { "signature": "签名字符串", "subAppId": "子应用ID" } } ``` --- ## 定时任务 Crontab ### 自动取消超时订单 - **接口路径**: `/api/crontab/ordersCancel` - **请求方法**: GET - **需要登录**: 否 **说明:** 自动取消24小时前创建且未支付的订单 ### 自动评价订单 - **接口路径**: `/api/crontab/ordersEvaluate` - **请求方法**: GET - **需要登录**: 否 **说明:** 自动评价超过7天未评价的已完成订单 --- ## 通用说明 ### 请求头 | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | Authorization | string | 视接口 | 用户token，格式: Bearer {token} | | shopid | int | 是 | 店铺ID | ### 返回格式 ```json { "code": 200, // 状态码 200成功 0失败 "msg": "success", // 提示信息 "data": {} // 返回数据 } ``` ### 分页数据格式 ```json { "code": 200, "msg": "success", "data": { "total": 100, "per_page": 20, "current_page": 1, "last_page": 5, "data": [] } } ``` ### 订单状态说明 | 状态值 | 说明 | |--------|------| | -1 | 已删除 | | 0 | 已取消 | | 1 | 待付款 | | 2 | 待发货 | | 3 | 待收货 | | 4 | 已完成 | | 5 | 已评价 | --- *文档生成时间: 2026年4月14日*