Skip to content

基础接口

1. 获取网站配置

接口地址POST /home/index/siteConfig

认证:不需要

请求参数:无

响应示例

json
{
  "code": 1,
  "msg": "获取成功",
  "data": {
    "site_name": "演示站", // 网站名称
    "site_subtitle": "演示站,请勿下单支付", // 网站副标题
    "site_logo": "https://demo.qqss.net/upload/admin/1/image/20240505/66372afd23d6.png", // 网站 Logo 图片 URL
    "site_status": 1, // 网站状态(1-正常运行)前端实现网站页面的开启与关闭
    "site_close_tips": "", // 网站关闭提示语(site_status=0 时显示)
    "site_domain": "https://fast.qqss.net", // 网站域名
    "site_info_qq": 990504246, // 客服 QQ 号
    "site_info_email": "123456@163.com", // 客服邮箱
    "site_info_qq_desc": "每日(10:00-24:00)", // 客服服务时间描述
    "site_info_copyright": "<p>Copyright &copy; <strong>2025</strong> RolaSoft All Rights Reserved</p>", // 网站版权信息(HTML 格式)
    "site_shop_copyright": "<p>为了您的安全,请勿脱离本站进行私下交易。交易后对订单有任何异议,请在买家服务中对订单进行投诉</p>", // 店铺页面版权/提示信息(HTML 格式)
    "site_info_icp": "豫ICP备xxxxx号", // ICP 备案号
    "merchant_logo": "https://demo.qqss.net/upload/admin/1/image/20240505/66372afd23d6.png",
    "merchant_logo_sm": "https://demo.qqss.net/upload/admin/1/image/20240715/4d0bbbba507fe3f2eca89c69d5369a7b_66948bd24f493.png",
    "spread_switch": 0 // 推广功能开关(0-关闭,1-开启,必填,2-开启,非必填)
  }
}

2. 通用文件下载

接口地址GET /home/download/export

认证:根据具体业务场景决定

请求参数

参数名类型必填说明
keyString文件下载密钥(由导出接口返回)

响应

  • 成功:返回文件下载(自动触发浏览器下载)
  • 失败:返回错误页面

错误响应示例

  • 参数错误:未提供 key 参数
  • 文件不存在:key 无效或已过期(超过 5 分钟)

使用流程

  1. 调用导出接口(如订单导出、卡密导出等)
  2. 导出接口返回包含 key 参数的下载 URL
  3. 使用该 URL 直接下载文件
  4. 下载链接有效期为 5 分钟,使用后自动失效

示例

javascript
// 1. 调用导出接口
const res = await exportOrders(params);
// 返回: { code: 1, msg: "导出成功", data: { url: "/home/download/export?key=abc123..." } }

// 2. 使用返回的URL下载文件
window.location.href = res.data.url;
// 或使用 downloadFile 工具函数
downloadFile(res.data.url);

说明

  • 这是一个通用的文件下载接口,用于各种导出功能
  • 文件路径通过缓存存储,key 作为缓存键
  • 每个下载链接只能使用一次,下载后自动清除缓存
  • 下载链接有效期为 5 分钟(300 秒)
  • 适用场景:订单导出、卡密导出、统计数据导出等

3. 搜索店铺

接口地址/home/search/index

登录权限: 需要登录

请求参数

参数名类型必填说明
shop_noString店铺号(纯数字)

成功响应示例

json
{
    "code": 1,
    "msg": "获取成功",
    "data": {
        "id": 4,
        "user_id": 1004, // 卖家用户ID
        "shop_name": "ovo小店", // 店铺名
        "create_at": "2025-11-22 15:12:43", // 店铺创建时间
        "shop_contact": { // 联系方式
            "qq": "QQ:5111121254844544",
            "wechat": "<span style=\"font-weight: 500;\">446545415784</span>",
            "mobile": "<a href=\"tel:21321313546121\" style=\"text-decoration: none;\">21321313546121</a>",
            "site_link": "<a href=\"https://56421684464\" target=\"_blank\" style=\"text-decoration: none;\">641546514421</a>"
        },
        "show_contact": 1, // 是否展示联系方式,0=否 1=是
        "shop_close": 0, // 店铺是否打烊,0=否 1=是
        "shop_close_notice": "", // 店铺打烊通知
        "shop_logo": "https://fast.qqss.net/upload/image/20251122/76a99779d8bd480e4e45208c4dda5f5b_692164eae77d8.png", // 店铺logo
        "shop_notice_show": 1, // 店铺公告是否显示 0=否 1=是
        "shop_notice": "", // 店铺公告(Html)
        "username": "test1004", // 卖家用户名
        "url": "https://fast.qqss.net/link/1111" // 店铺地址
    }
}

错误响应示例

  • 下面内容及说明,无需关注,后端来处理逻辑。前端需在code为0时返回给用户提示即可。

1. 店铺号格式错误

json
{
  "code": 0,
  "msg": "店铺不存在"
}

2. 店铺已歇业

json
{
  "code": 0,
  "msg": "店铺歇业公告内容"
}

注:实际消息内容为店铺设置的歇业公告

3. 搜索频率过高(首次触发)

json
{
  "code": 0,
  "msg": "搜索过于频繁,请1分钟后再试"
}

4. 搜索频率过高(多次触发)

json
{
  "code": 0,
  "msg": "您因搜索频率过高已被限制,请在 30 分钟后再试"
}

搜索限流说明

  • 搜索功能有频率限制,系统可配置限流参数
  • 默认配置:10分钟内最多搜索10次
  • 触发限制后会被临时封禁,封禁时长渐进式增加:
    • 第1次触发:封禁1分钟
    • 第2次触发:封禁5分钟
    • 第3次触发:封禁30分钟
    • 第4次及以后:封禁2小时
  • 限流基于用户ID(已登录)
  • 如果店铺已歇业(shop_close=1),会返回错误响应,消息内容为店铺设置的歇业公告

说明

  • shop_no 必须为纯数字格式
  • 只能搜索状态正常且未歇业的店铺
  • 店铺链接格式由系统配置决定
  • shop_contact 为对象类型,包含多种联系方式
  • show_contact=0 时,前端不应显示联系方式信息
  • shop_close=1 时,接口会返回错误,消息为 shop_close_notice 的内容