小储云官网

# 开放接口

# 对接开发须知

声明

由于部分接口以前标注不全，无法标注出从什么版本开始加入，故一律按照v1.9版本来算！后续若添加新接口会详细标注最低可用版本！

# 相关术语与需要注意的地方(必看)

  1. 域名：代表需要调用接口的网站域名
  2. 密钥：代表网站对接密钥，可在网站设置处获取！
  3. 下单信息：代表用户提交的商品购买信息如下

GET 传值方式为：

 0=第一行输入框&1=第二行输入框&2=第三行输入框
1

POST 传递的下单信息数组格式为：

[
    "第一行输入框",
    "第二行输入框",
    "第三行输入框"
]
1
2
3
4
5

  1. CK: 代表Cookie的简称

  2. 此处所有 API 均支持 GET POST 传值方式，若进行接口测试推荐使用 Postman 🎉

  3. 若站点开启了首页数据缓存周期，可能会造成无法实时预览！
    可在站长后台 / 网站编辑 / 首页数据缓存周期 处将值设置为0来去除缓存！ 😃

网站CK名称相关说明，以及注意事项
  1. THEKEY 此CK是用户登陆后生成，里面存储的是用户的user_idu字段参数，用于区分用户！
  2. CartKey 此CK存储的是数据库内sky_cart表的cookie字段，未登录用户添加商品到购物车才会出现,登陆后会直接消失！，并且购物车里面的商品会继承到登陆用户的购物车内！
  3. 调用购物车api须携带判断用户登陆状态的THEKEY CK，如果未登录，则需要携带名为：CartKey的CK用于绑定临时购物车，如果在未登录状态下没有携带CartKey CK 则会自动生成一个新的CartKey！
  4. QUERYORDER 此CK 仅在用户未登陆状态下生成，用于绑定游客订单，登陆后会消失，用户登陆后如果里面存在已付款订单，则会继承到登陆的账户内,并且清除此CK！
  5. QUEUEORDER 此CK 仅在用户未登陆状态下生成，用于绑定游客队列订单，登陆后会消失，用户登陆后会继承到登陆的账户内，并且清除CK！

# 取出商品分类

http(s)://域名/main.php?act=class

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 V1.9+
num number 是 取出数量 V1.9+

# act的合法值

属性 说明 最低版本
class 判断参数 V1.9+

# num的合法值

属性 说明 最低版本
1+n 取出分类的数量，根据排序取出 1.9+

# 返回值

{
    "code": 1,
    "msg": "商品分类数据获取成功",
    "data": [
        {
            "cid": "1",
            "sort": "1",
            "name": "测试分类",
            "image": "图片链接",
            "content": "分类公告",
            "state": "1",
            "date": "创建时间"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 取出商品列表

http(s)://域名/main.php?act=GoodsList

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
cid number 是 分类ID 1.9+
page number 是 页码 1.9+

# act的合法值

属性 说明 最低版本
GoodsList 判断参数 1.9+

# cid的合法值

属性 说明 最低版本
1+n 分类ID 1.9+

# page的合法值

属性 说明 最低版本
1+n 页码，每页6条商品数据 1.9+

# 返回值

{
    "code": 1,
    "msg": "商品列表获取成功",
    "data": [
        {
            "gid": "1",
            "cid": "1",
            "name": "商品名称",
            "image": "商品图片",
            "custom": "自定义价格规则,无视即可",
            "freight": "运费模板规则",
            "method": "支持的付款方式", //1=支持余额+积分，2=支持余额不支持积分，3=不支持余额支持积分
            "quantity": "每份的数量",
            "quota": "剩余库存",
            "label": [ //标签数组
                {
                    "name": "标签",
                    "color": "red"
                }
            ],
            "price": "售价",
            "points": "兑换价格",
            "level": "当前用户等级名称",
            "state":"商品对接类型", //1=自营，2=API，3=发卡，4=对接
            "currency": "货币名称",
            "sales": "商品销量"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

可携带用户CK访问，CK名称：THEKEY，会返回该用户所在等级的商品价格！

# 获取商品详情

http(s)://域名//main.php?act=Goods

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+

# act的合法值

属性 说明 最低版本
Goods 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID

# 返回值

{
    "code": 1,
    "msg": "商品详情获取成功",
    "data": {
        "gid": "商品ID",
        "name": "商品名称",
        "image": [
            "商品图片1",
            "商品详情图1",
            "商品详情图2"
        ],
        "method": "支持的付款方式", //1=支持余额+积分，2=支持余额不支持积分，3=不支持余额支持积分
        "state":"商品对接类型", //1=自营，2=API，3=发卡，4=对接
        "input": [  //商品输入框规则，请看下方详解
            {
                "state": 1,
                "Data": "下单账号"
            }
        ],
        "quantity": "没份数量",
        "docs": "商品说明",
        "alert": "商品弹窗提示",
        "min": "最少购买数量",
        "max": "最多购买数量",
        "currency": "货币名称",
        "price": "商品售价",
        "points": "兑换价格",
        "level": "等级名称",
        "level_arr": { //可升级的自定义等级售价列表
            "7": {
                "name": "领袖站长",
                "price": 0.022272,
                "points": 31
            }
        },
        "freight": "运费规则",
        "cart_count":"购物车商品数量",
        "sales": "商品销量",
        "count_quota": "今日剩余库存",
        "quota": "每日商品库存",
        "Push": [ //同分类的商品ID,用于同类推荐，已排除当前商品ID
            {
                "image": "商品图片",
                "gid": "商品ID",
                "name": "商品名称"
            }
        ],
        "CartState": "购物车开关", //1开，其他关
        "label": [ //商品标签规则列表
            {
                "name": "标签名称",
                "color": "red"
            }
        ],
        "User": "=1则无需提示登陆，=-1，则需要提示登陆才可购买商品！"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

下单输入框规则详解：
字段名称：input
输入框类型：state = 1,普通输入框，2,接口输入框，3,收货地址输入框，4,下拉多选框
参数详解

[
    {
        "state": 1, //普通输入框
        "Data": "输入框名称"
    },
    {
        "state": 2, //接口输入框
        "Data": [
            "输入框名称",
            {
                "name": "按钮名称",
                "type": -1, //-1普通远程接口，1收货地址
                "url": "API接口地址",
                "way": 1, //1获取当前输入框内容，并且发送到接口，2获取全部输入框内容，并且发送到接口
                "placeholder": "输入提示文字"
            }
        ]
    },
    {
        "state": 3, //收货地址，如果类型为3的话，需要自行编写输入地址多级选择器！
        "Data": "按钮名称"
    },
    {
        "state": 4, //下拉多选框
        "Data": [
            "输入框名称",
            [
                "选项1",
                "选项2"
            ]
        ]
    }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

可携带用户CK访问，CK名称：THEKEY，会返回该用户所在等级的商品价格！

# 订单相关操作

http(s)://域名/main.php?act=OrderList

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
type number 是 操作类型 1.9+

# act的合法值

属性 说明 最低版本
OrderList 判断参数

# type的合法值

# 1、OrderAll 订单列表

# 相关参数
属性 类型 默认值 必填 说明 最低版本
id number false 否 订单ID(留空不筛选) 1.9+
seek string 否 搜索内容 1.9+
state number 1 否 类型，1全部，2未完成，3待收货，4已完成，5已取消 1.9+
page number 1 否 页码，一页6条数据 1.9+
# 返回参数
{
    "code": 1,
    "msg": "订单列表获取成功",
    "data": [
        {
            "id": "订单ID",
            "order": "订单号",
            "ip": "购买者IP地址",
            "input": [
                "商品购买信息1",
                "商品购买信息2"
            ],
            "num": "购买份数",
            "gid": "商品ID",
            "payment": "付款方式",
            "price": "订单金额",
            "take": "1已收货，2未收货",
            "quantity": "购买数量",
            "addtime": "订单创建时间",
            "endtime": "订单完成时间",
            "state": "订单状态 类型：1成功，2待处理，3异常，4正在处理，5退款,6售后维权,7已评价",
            "remark": "订单备注信息",
            "name": "商品名称",
            "image": "商品主图",
            "value": [
                "订单对应商品输入框标题1",
                "订单对应商品输入框标题2"
            ],
            "content": "订单评论内容",
            "markaddtime": "订单评论时间",
            "RemarkType": "1有订单备注，-1无订单备注",
            "Token": "卡密列表,数组形式",
            "currency": "货币名称"
        }
    ],
    "Tracking": "物流实时跟踪接口，需配合订单备注信息，订单备注会自动匹配物流单号"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# 2、QueryList 查询未绑定用户的订单

# 相关参数
属性 类型 默认值 必填 说明 最低版本
msg number 是 需要搜索的订单下单信息(第一行!) 1.9+
# 返回参数
{
    "code": 1,
    "msg": "订单查询成功",
    "data": [
        {
            "id": "订单ID",
            "input": [
                "商品购买信息1",
                "商品购买信息2"
            ],
            "state": "订单状态 类型：1成功，2待处理，3异常，4正在处理，5退款,6售后维权,7已评价",
            "num": "购买份数",
            "payment": "付款方式",
            "price": "订单金额",
            "addtitm": "订单创建时间",
            "gid": "商品ID",
            "name": "商品名称",
            "image": "商品图片",
            "value": [
                "订单对应商品输入框标题1",
                "订单对应商品输入框标题2"
            ],
            "addtime": "购买时间(已经转换为xx秒前~)"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 3、QueryMark 提交商品评价

# 相关参数
属性 类型 默认值 必填 说明 最低版本
grade number 是 评分，1-5 1.9+
id number 是 订单ID 1.9+
content string 是 评论内容 1.9+
# 返回参数
{
    "code": 1,
    "msg": "评价成功,为防止政治敏感等不当言论<br>您的评价内容需要主站审核!"
}
1
2
3
4

# 4、QueryTake 订单确认收货

# 相关参数
属性 类型 默认值 必填 说明 最低版本
id number 是 订单ID 1.9+
# 返回参数
{
    "code": 1,
    "msg": "返回状态信息!"
}
1
2
3
4

# 5、QueryDelete 删除待付款队列订单

# 相关参数
属性 类型 默认值 必填 说明 最低版本
id number 是 队列订单ID 1.9+
# 返回参数
{
    "code": 1,
    "msg": "返回状态信息!"
}
1
2
3
4

# 6、QueryDetails 查询订单进度(详细)

# 相关参数
属性 类型 默认值 必填 说明 最低版本
id number 是 订单ID 1.9+
# 返回参数
{
    "code": 1,
    "msg": "订单查询成功",
    "data": {
        "ApiType": "实时订单类型,1有实时状态，2无实时状态",
        "ApiNum": "实时购买数量",
        "ApiTime": "货源订单创建时间",
        "ApiInitial": "初始数量",
        "ApiPresent": "当前数量",
        "ApiState": "订单状态",
        "ApiError": "反馈信息",
        "gid": "商品ID",
        "order": "订单ID",
        "order_id": "货源订单ID",
        "ip": "购买者IP",
        "name": "商品名称",
        "price": "商品售价",
        "addtiem": "订单创建时间",
        "input": [
            "输入框标题：商品购买信息"
        ],
        "state": "订单状态",
        "docs": "商品说明",
        "type": "付款方式",
        "remark": "订单备注",
        "num": "购买数量",
        "token_arr":"订单相关卡密数组,卡密商品才有" ,
        "ApiSn": "和ApiType功能相似，如果无实时订单=-1"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 7、Queue 查询订单队列内的订单，未完成+待付款订单

# 返回参数
{
    "code": 1,
    "msg": "未完成订单列表获取成功！",
    "data": [
        {
            "id": "队列订单ID",
            "type": "2=已付款待提交，3=未付款可删除",
            "order": "队列订单ID",
            "ip": "购买者IP",
            "input": [
                "购买信息1",
                "购买信息2"
            ],
            "num": "购买份数",
            "payment": "付款方式",
            "price": "支付金额",
            "remark": "备注信息",
            "addtime": "2小时1分钟11秒，购买时间",
            "name": "商品名称",
            "image": "商品主图",
            "gid": "商品ID",
            "value": [
                "输入框标题1",
                "输入框标题2"
            ],
            "state": "订单超时判断，1未超时，-1，已超时",
            "currency": "货币名称"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

注意：此处所有请求均可携带用户登陆CK，如果未携带，则只拥有游客权限，无法查询和操作某些订单

# 查询支付状态

http(s)://域名/main.php?act=OrderState

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
pid number 是 订单ID 1.9+
type number 是 查询类型 1.9+

# act的合法值

属性 说明 最低版本
OrderState 判断参数

# pid的合法值

属性 说明 最低版本
1+n / 1+n 商品订单ID或充值订单ID 1.9+

# type的合法值

属性 说明 最低版本
1 根据Pid查询充值订单 1.9+
2 根据Pid查询商品订单 1.9+

# 返回值

{
    "code": 1,
    "msg": "返回信息"
}
1
2
3
4

# 推荐商品列表

http(s)://域名/main.php?act=GuessYouLike

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 被排除的商品ID 1.9+
page number 是 页码 1.9+

# act的合法值

属性 说明 最低版本
GuessYouLike 判断参数

# gid的合法值

属性 说明 最低版本
-1 / 1+n 被排除的商品ID,显示全部填-1 1.9+

# page的合法值

属性 说明 最低版本
1+n 页码，每页6条数据！ 1.9+

# 返回值

{
    "code": 1,
    "msg": "推荐商品列表获取成功！",
    "data": [
        {
            "name": "商品名称",
            "image": "商品图片",
            "custom": "自定义价格规则,无视即可",
            "freight": "运费模板规则",
            "method": "支持的付款方式", //1=支持余额+积分，2=支持余额不支持积分，3=不支持余额支持积分
            "quantity": "每份的数量",
            "quota": "剩余库存",
            "label": [ //标签规则
                {
                    "name": "标签",
                    "color": "red"
                }
            ],
            "price": "售价",
            "points": "兑换价",
            "level": "当前用户等级名称",
            "state":"商品对接类型", //1=自营，2=API，3=发卡，4=对接
            "currency": "货币名称",
            "sales": "销量"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

可携带用户CK访问，CK名称：THEKEY，会返回该用户所在等级的商品价格！

# 商城动态通知

http(s)://域名/main.php?act=OrdeTips

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 否 商品ID 1.9+

# act的合法值

属性 说明 最低版本
OrdeTips 判断参数

# gid的合法值

属性 说明 最低版本
-1 / 1+n 商品ID,可填可不填，如果填了会取出此商品的订单购买列表(简) 1.9+

# 返回值

{
    "code": 1,
    "msg": "数据获取成功",
    "data": [
        {
            "title": "动态通知内容",
            "img": "触发通知的用户头像"
        },
        {
            "title": "XXX于2天2小时38分钟2秒前购买了此商品",
            "img": "触发通知的用户头像"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

可携带用户CK访问，CK名称：THEKEY，会返回该用户所在等级的商品价格！

# 商品价格监控

http(s)://域名/main.php?act=GoodsMonitoring

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 否 商品ID 1.9+

# act的合法值

属性 说明 最低版本
GoodsMonitoring 判断参数

# gid的合法值

属性 说明 最低版本
-1 / 1+n 需要监控价格的商品ID 1.9+

# 返回值

{
    "code": 1, //如果是-1,则需要重新获取商品数据，价格已经调整
    "msg": "返回说明"
}
1
2
3
4

# 订单队列补款

http(s)://域名/main.php?act=OrderPay

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
id string 是 队列订单ID

# act的合法值

属性 说明 最低版本
OrderPay 判断参数 1.9+

# id的合法值

属性 说明 最低版本
1-10 队列订单的ID

# 返回值

{
    "code": 1,
    "msg": "返回相关状态"
}
1
2
3
4

# 提交队列订单

http(s)://域名/main.php?act=SubmitOrder

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数
id string 是 队列订单ID

# act的合法值

属性 说明 最低版本
SubmitOrder 判断参数

# id的合法值

属性 说明 最低版本
1-10 队列订单的ID

# 返回值

{
    "code": 1,
    "msg": "返回订单队列监控结果"
}
1
2
3
4

# 网站基础数据

http(s)://域名/api.php?act=WebsiteData

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数

# act的合法值

属性 说明 最低版本
WebsiteData 判断参数

# 返回值

{
    "code": 1,
    "msg": "数据获取成功",
    "data": {
        "sitename": "站点名称",
        "kfqq": "客服QQ",
        "notice_top": "首页公告",
        "notice_check": "首页查单公告",
        "notice_bottom": "全局底部公告",
        "notice_user": "分站后台公告",
        "PopupNotice": "首页弹窗公告",
        "currency": "货币名称"
    },
    "time": "获取站点的当前时间戳"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 查询支付通道

http(s)://域名/main.php?act=PaymentWay

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+
type number 是 获取类型 1.9+

# act的合法值

属性 说明 最低版本
PaymentWay 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID，当前type=1时有效 1.9+

# type的合法值

属性 说明 最低版本
1 根据gid参数获取商品的支付通道状态 1.9+
2 获取购物车支付通道状态,此时gid提交-1 1.9+

# 返回值（type=1）单商品支付通道

{
    "code": 1,
    "msg": "数据获取成功",
    "data": [
        {
            "type": 1 //QQ支付通道状态,1开启，其他关闭
        },
        {
            "type": 1 //微信支付通道状态,1开启，其他关闭
        },
        {
            "type": 1 //支付宝支付通道状态,1开启，其他关闭
        },
        {
            "type": 1, //余额付款通道状态，1已登陆，2未登录
            "surplus": "显示余额数量"
        },
        {
            "type": 1, //积分兑换通道状态，1已登陆，2未登录
            "surplus": "显示积分数量"
        }
    ],
    "state": 1 //登陆状态,1登陆,2未登录
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 返回值（type=2）购物车结算支付通道

{
    "code": 1,
    "msg": "数据获取成功",
    "data": [
        {
            "type": 1 //QQ支付通道状态,1开启，其他关闭
        },
        {
            "type": 1 //微信支付通道状态,1开启，其他关闭
        },
        {
            "type": 1 //支付宝支付通道状态,1开启，其他关闭
        },
        {
            "type": 1, //余额付款通道状态，1已登陆，2未登录
            "surplus": "显示余额数量"
        },
        {
            "type": 1, //积分兑换通道状态，1已登陆，2未登录
            "surplus": "显示积分数量"
        }
    ],
    "state": 1, //登陆状态,1登陆,2未登录
    "currency":"货币名称",
    "notice":"购物车购买公告"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 商品售价计算

http(s)://域名/main.php?act=PriceCalculation

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+
num number 是 购买份数 1.9+
data Array 是 下单信息 1.9+

# act的合法值

属性 说明 最低版本
PriceCalculation 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID 1.9+

# num的合法值

属性 说明 最低版本
1+n 商品购买份数 1.9+

# data的合法值

属性 说明 最低版本
下单信息 下单信息 Array 1.9+

# 返回值

{
    "code": 1,
    "msg": "商品售价计算成功！",
    "freight": "运费", 
    "price": "商品售价",
    "points": "兑换价格",
    "area": "运费地区",
    "exceed": "需要计算运费的情况下，每超出一份的加价金额",
    "Count": "下单数量",
    "min": "最小下单份数",
    "max": "最大下单份数",
    "step": "进步器",
    "num": "当前下单份数,已转换为最佳数值"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 验证下单信息

http(s)://域名/main.php?act=CreateOrder

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+
num number 是 购买份数 1.9+
data Array 是 下单信息 1.9+

# act的合法值

属性 说明 最低版本
CreateOrder 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID 1.9+

# num的合法值

属性 说明 最低版本
1+n 购买份数 1.9+

# data的合法值

属性 说明 最低版本
下单信息 下单信息 Array 1.9+

# 返回值

{
    "code": 1,
    "msg": "商品订单信息获取成功",
    "data": {
        "gid": "商品ID", 
        "num": "下单份数",
        "name": "商品名称",
        "quantity": "购买数量",
        "data": [
            "输入框1",
            "输入框2"
        ],
        "price": "售价",
        "points": "兑换价",
        "type": 1, //无视,用于判断是否是单商品订单
        "method": "支持的付款方式", //1=支持余额+积分，2=支持余额不支持积分，3=不支持余额支持积分
        "currency": "货币名称",
        "input": [
            "输入框1名称",
            "输入框2名称"
        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 购买指定商品

http(s)://域名/main.php?act=Pay

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+
num number 是 购买份数 1.9+
type number 1 是 付款方式 1.9+
mode string wxpay 是 支付方式 1.9+
data Array 是 下单信息 1.9+

# act的合法值

属性 说明 最低版本
Pay 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID 1.9+

# num的合法值

属性 说明 最低版本
1+n 商品购买份数 1.9+

# type的合法值

属性 说明 最低版本
1 在线支付，调用支付接口
2 余额付款
3 积分兑换

注：除在线支付外，其他两种付款方式均需要携带用户Cookie(登陆状态)

# mode的合法值

属性 说明 最低版本
wxpay 微信付款
alipay 支付宝付款
qqpay QQ支付

注：若想mode值生效必须付款方式(type)的值=1

# data的合法值

属性 说明 最低版本
下单信息 下单信息 Array

# 返回值(type=1)

{
    "code": 2,
    "msg": "您付款成功了吗？点击下方继续!",
    "url": "付款链接",
    "pid": "订单ID"
}
1
2
3
4
5
6

# 返回值(type!=1)

{
    "code": 1,
    "msg": "提示信息",
    "pid": "订单ID"
}
1
2
3
4
5

可携带用户CK访问，CK名称：THEKEY，付款金额会跟随用户等级变化！
除在线付款方式外，余额，积分付款必须携带用户CK，另商品售价=0的免费商品也必须要携带用户CK才可购买！

# 搜索指定商品

http(s)://域名/main.php?act=GoodsSeek

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
keyword string 是 搜索内容 1.9+
page number 是 页码 1.9+

# act的合法值

属性 说明 最低版本
GoodsSeek 判断参数

# keyword的合法值

属性 说明 最低版本
商品名称关键词 商品名称的关键词，如鞋子，衣服等 1.9+

# keyword的合法值

属性 说明 最低版本
商品名称关键词 商品名称的关键词，如鞋子，衣服等 1.9+

# page的合法值

属性 说明 最低版本
1+n 页码，每页6条数据

# 返回值

{
    "code": 1,
    "msg": "搜索成功！",
    "data": [
        {
            "gid": "商品ID",
            "cid": "分类ID",
            "name": "商品名称",
            "image": "商品图片",
            "custom": "自定义价格规则,无视即可",
            "freight": "运费模板规则",
            "method": "支持的付款方式", //1=支持余额+积分，2=支持余额不支持积分，3=不支持余额支持积分
            "quantity": "每份商品数量",
            "quota": "库存",
            "label": [ //标签规则
                {
                    "name": "质量",
                    "color": "red"
                }
            ],
            "price": "售价",
            "points": "兑换价",
            "level": "当前用户等级名称",
            "state":"商品对接类型", //1=自营，2=API，3=发卡，4=对接
            "currency": "货币名称",
            "sales": "销量"
        }
    ],
    "tips": "共找到1个带有[测试商品]关键词的宝贝！"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

可携带用户CK访问，CK名称：THEKEY，会返回该用户所在等级的商品价格！

# 商品分享海报

http(s)://域名/main.php?act=SharePoster

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+

# act的合法值

属性 说明 最低版本
SharePoster 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID

# 返回值

{
    "code": 1,
    "msg": "商品海报图生成成功！",
    "src": "图片地址"
}
1
2
3
4
5

若商品图片不存在则无法合成海报图，会直接生成失败！
网站编辑后台可设置获取方式，云端获取，本地获取！

# 订单队列监控

http(s)://域名/api.php?act=SubmitOrder&num=1

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数
num string 是 监控数量

# act的合法值

属性 说明 最低版本
SubmitOrder 判断参数

# num的合法值

属性 说明 最低版本
1-10 每次监控提交的订单数量

# 返回值

{
    "code": 1,
    "msg": "返回订单队列监控结果"
}
1
2
3
4

若想使用此功能，必须在网站编辑内开启,若num参数过大，可能会失败！

# 获取轮播图片

http(s)://域名/main.php?act=banner

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+

# act的合法值

属性 说明 最低版本
banner 判断参数 1.9+

# 返回值

{
    "code": 1,
    "msg": "获取成功",
    "title": "商城名称+副名称",
    "data": [
        {
            "image": "图片地址",
            "url": "跳转链接"
        },
        {
            "image": "图片地址",
            "url": "跳转链接"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 获取客服数据

http(s)://域名/main.php?act=Service

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+

# act的合法值

属性 说明 最低版本
Service 判断参数 1.9+

# 返回值

{
    "code": 1,
    "msg": "数据获取成功",
    "qq": "客服QQ",
    "image": "添加客服二维码",
    "url": "云智服跳转链接",
    "tips": "客服界面公告",
    "GroupUrl": "加群链接"
}
1
2
3
4
5
6
7
8
9

# 获取文章列表

http(s)://域名/main.php?act=ArticleList

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
page number 是 页码 1.9+
search string 否 搜索关键词 1.9+

# act的合法值

属性 说明 最低版本
ArticleList 判断参数 1.9+

# page的合法值

属性 说明 最低版本
1+n 页码，每页6条数据

# search的合法值

属性 说明 最低版本
关键词 文章标题关键词

# 返回值

{
    "code": 1,
    "msg": "数据获取成功",
    "data": [
        {
            "id": "文章ID",
            "title": "文章标题",
            "content": "文章内容",
            "image": "文章图片",
            "count": "阅读人数,不准确",
            "addtime": "发布时间"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 商品评论列表

http(s)://域名/main.php?act=Discuss

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID 1.9+
num number 是 取出数量 1.9+

# act的合法值

属性 说明 最低版本
Discuss 判断参数 1.9+

# gid的合法值

属性 说明 最低版本
1+n 需要取出评论列表的商品ID

# num的合法值

属性 说明 最低版本
1+n 取出的评论数量

# 返回值

{
    "code": 1,
    "msg": "评论列表获取成功",
    "data": [
        {
            "id": "评论ID",
            "image": "评论者头像",
            "username": "评论者名称",
            "content": "评论内容",
            "imageArr": [
                "评论图片1",
                "评论图片2"
            ],
            "score": "评分,1-5",
            "goodsname": "购买的订单信息，简介"
        }
    ],
    "count": "评论总数",
    "avg": "平均评分"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 获取杂项信息

http(s)://域名/main.php?act=inform

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+

# act的合法值

属性 说明 最低版本
inform 判断参数 1.9+

# 返回值

{
    "code": 1,
    "msg": "获取成功",
    "data": {
        "NoticeTop": "首页公告",
        "PopupNotice": "弹窗公告",
        "NoticeBottom": "底部导航",
        "NoticeCheck": "查单公告",
        "Appurl": "APP下载链接",
        "Navigation": [ //自定义导航规则
            {
                "name": "名称",
                "url": "跳转URL"
            },
            {
                "name": "名称",
                "url": "跳转URL"
            }
        ],
        "UserImage": "用户头像信息，-1未登录"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 易支付漏单检测

http(s)://域名/api.php?act=OrdersTesting

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数

# act的合法值

属性 说明 最低版本
OrdersTesting 判断参数

推荐监控频率：5分钟1次！,可在宝塔计划任务内监控

# 查询购物车列表

http(s)://域名/main.php?act=CartList

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数
CartKey string -1 否 购物车Cookie参数 1.9+
data string all 否 需取出的购物车商品 1.9+

# act的合法值

属性 说明 最低版本
CartList 判断参数

# CartKey的合法值

属性 说明 最低版本
32位的Cookie(CartKey)值 若链接后面加此参数,可无需携带购物车Cookie(CartKey) ，直接将此Cookie(CartKey)的值添加到链接后面！既可获取Cookie(CartKey)对应的购物车参数！

# data的合法值

属性 说明 最低版本
0,1,2 需要取出的购物车列表序号，第一个购物车商品是序号0,第二个是序号1，以此类推，中间用逗号分割！ 1.9+

# 返回值

{
    "code": 1,
    "msg": "当前共有1条待付款商品!",
    "data": [
        {
            "gid": "商品ID",
            "input": [
                "下单信息（第一个输入框）",
                "下单信息（第二个输入框）"
            ],
            "num": "下单份数",
            "conts": "自定义下单提示信息",
            "price": "商品添加到购物车时的售价",
            "GidData": {
                "name": "商品名称",
                "image": "商品图片链接",
                "price": "商品查询时的实时售价",
                "points": "商品实时兑换价格",
                "cid": "商品分类ID",
                "count_type": "是否运行购买多份",
                "min": "最新下单数量",
                "max": "最大下单数量",
                "quota": "今日商品库存",
                "quantity": "商品下单数量",
                "Count": "当前商品在购物车内的总份数",
                "communityId": "对接货源ID",
                "method": "[1,2,3,4,5,6,7]，商品参数"
            }
        }
    ],
    "count": "购物车内的商品数量",
    "sitename": "当前站点的名称",
    "Charge": "当前购物车内免费商品总数"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

# 修改购物车商品份数

http(s)://域名/main.php?act=CartNum

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数
id number 是 要修改的购物车商品ID
num number 是 修改的份数

# act的合法值

属性 说明 最低版本
CartNum 判断参数

# id的合法值

属性 说明 最低版本
0+n 购物车商品ID,如填写0,则修改购物车第一个商品,填1则修改第二个,以此类推 1.9+

# num的合法值

属性 说明 最低版本
1+n 需要修改的份数 1.9+

# 返回值

{
    "code": 1,
    "msg": "调整成功！"
}
1
2
3
4

# 删除购物车商品

http(s)://域名/main.php?act=CartDet

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数
arr string 是 需要删除的商品

# act的合法值

属性 说明 最低版本
CartDet 判断参数

# arr的合法值

属性 说明 最低版本
0,1,2 购物车商品ID组,如填写0,则删除购物车第一个商品,填1则删除第二个,以此类推，中间用逗号分割 1.9+

# 返回值

{
    "code": 1,
    "msg": "删除成功！"
}
1
2
3
4

# 新增购物车商品

 http(s)://域名/main.php?act=CartAdd

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
gid number 是 商品ID
num number 是 下单份数
data Array 是 下单信息

# act的合法值

属性 说明 最低版本
CartAdd 判断参数

# gid的合法值

属性 说明 最低版本
1+n 商品ID 1.9+

# data的合法值

属性 说明 最低版本
下单信息 下单信息 Array 1.9+

# 返回值

{
    "code": 1,
    "msg": "已经成功添加到购物车!",
    "count": "购物车当前商品数量"
}
1
2
3
4
5

注意：若添加到购物车的商品ID，下单信息和购物车已经存在的商品信息一致的话，不会新增，而是合并

# 结算购物车商品

 http(s)://域名/main.php?act=CartPay

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.9+
type number 1 是 付款方式
mode string wxpay 是 支付方式
CartKey string -1 否 购物车Cookie参数
data Array 是 购物车列表数组

# act的合法值

属性 说明 最低版本
CartPay 判断参数

# type的合法值

属性 说明 最低版本
1 在线支付，调用支付接口
2 余额付款
3 积分兑换

注：除在线支付外，其他两种付款方式均需要携带用户CK(登陆状态)

# mode的合法值

属性 说明 最低版本
wxpay 微信付款
alipay 支付宝付款
qqpay QQ支付

注：若想mode值生效必须付款方式(type)的值=1

# CartKey的合法值

属性 说明 最低版本
32位的Cookie(CartKey)值 若链接后面加此参数,可无需携带购物车Cookie(CartKey) ，直接将此Cookie(CartKey)的值添加到链接后面！既可获取Cookie(CartKey)对应的购物车参数！

# data的合法值

属性 说明 最低版本
购物车数组 需要取出的购物车列表序号，第一个购物车商品是序号0,第二个是序号1，以此类推，如下所示

GET data传值方式为：

 &0=0&1=1&2=3
1

POST data数组格式为：

[
    "0", //第一个购物车商品
    "1", //第二个购物车商品
    "3" //第四个购物车商品
]
1
2
3
4
5

# 返回值

{
    "code": 2,
    "msg": "付款链接创建成功！",
    "pid": "付款订单ID",
    "url": "付款链接（完整链接）"
}
1
2
3
4
5
6

# 用户加款/扣款

http(s)://域名/api.php?act=UserMoneyApi&token=密钥&uid=1000&type=1&money=0.01

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
uid number 是 用户编号
type number 是 方式
money float 是 金额

# act的合法值

属性 说明 最低版本
UserMoneyApi 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# uid的合法值

属性 说明 最低版本
1000+n 用户编号(UID)

# type的合法值

属性 说明 最低版本
1 充值
2 扣款

# money的合法值

属性 说明 最低版本
0.01+n 充值或扣款金额

# 返回值

{
    "code": 1,
    "msg": "处理结果"
}
1
2
3
4

# 备份整站数据

http(s)://域名/api.php?act=SqlBackups&token=对接密钥

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥

# act的合法值

属性 说明 最低版本
SqlBackups 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# 返回值

{
    "code": 1,
    "msg": "处理结果"
}
1
2
3
4

# 获取数据备份列表

http(s)://域名/api.php?act=SqlBackupsList&token=对接密钥&page=1&limit=10

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
page number 是 页码
limit number 是 每页数量

# act的合法值

属性 说明 最低版本
SqlBackupsList 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# page的合法值

属性 说明 最低版本
1+n 页码

# limit的合法值

属性 说明 最低版本
10+n 每页数量

# 返回值

{
    "code": 0,
    "msg": "列表获取成功",
    "count": "总数据条数",
    "data": [
        {
            "date": "创建时间",
            "filename": "文件名称",
            "count": "里面的sql数据行数"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12

# 删除指定备份数据

http(s)://域名/api.php?act=SqlBackupsDel&token=对接密钥&name=备份文件名称

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
name string 是 对接文件名称

# act的合法值

属性 说明 最低版本
SqlBackupsDel 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# name的合法值

属性 说明 最低版本
xxx.sql 需要删除的备份数据文件名

# 返回值

{
    "code": 1,
    "msg": "删除成功"
}
1
2
3
4

# 下载网站数据备份

http(s)://域名/api.php?act=SqlBackupsDownload&token=对接密钥&name=备份文件名称&date=文件备份日期

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
name string 是 对接文件名称
date string 是 文件备份日期

# act的合法值

属性 说明 最低版本
SqlBackupsDownload 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# name的合法值

属性 说明 最低版本
xxx.sql 需要删除的备份数据文件名

# date的合法值

属性 说明 最低版本
2020-03-25 17:48:54 文件创建时间
一个备份文件 也可以自定义可执行SQL文件的名称

# 返回值

{
    "code": 1,
    "msg": "下载地址已经分配好,若未自动下载,请点击确定手动下载！",
    "flie": "文件下载地址"
}
1
2
3
4
5

备份源文件是不可直接在数据库执行的,必须通过此API下载转换！

# 将备份数据文件上传到云端

http(s)://域名/api.php?act=SqlBackupsUpdate&token=对接密钥&name=备份文件名称

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
name string 是 对接文件名称

# act的合法值

属性 说明 最低版本
SqlBackupsUpdate 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# name的合法值

属性 说明 最低版本
xxx.sql 需要删除的备份数据文件名

# 返回值

{
    "code": 1,
    "msg": "文件上传成功<br>云端已经永久保存了您的备份文件：<br>文件名称.sql<br>若有需要可直接下载恢复,数据永不丢失！<br>Ps:每个授权域名只可存储一个备份文件哦<br>提交新的会覆盖旧的！,且无法恢复旧的！"
}
1
2
3
4

# 将云端的备份文件下载到本地

http(s)://域名/api.php?act=SqlBackupsDownloadLocal&token=对接密钥

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥

# act的合法值

属性 说明 最低版本
SqlBackupsDownloadLocal 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# 返回值

{
    "code": 1,
    "msg": "云端文件下载成功,文件名称：<br>文件名称.sql<br>此备份上传时间为<font color=red>2020-03-25 21:39:40</font>"
}
1
2
3
4

云端的备份文件重复下载会重复覆盖,且前缀有一个cloud_标识！

# 使用备份恢复整站数据

http(s)://域名/api.php?act=SqlBackupsRecovery&token=对接密钥&name=备份文件名称&page=1&limit=1000

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
page number 是 备份数据恢复的页码
limit number 是 每次执行恢复数据的次数

# act的合法值

属性 说明 最低版本
SqlBackupsRecovery 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# page的合法值

属性 说明 最低版本
1+n 备份数据恢复的页码

# limit的合法值

属性 说明 最低版本
100+n 每次执行恢复数据的次数，推荐100-1000

嫌麻烦直接10000+n，等待时间长点而已，当然，一次执行太多次sql命令，对网站配置也是一个挑战

# 返回值 进行中

{
    "code": 1,
    "msg": "成功",
    "sql": [
        {
            "sql": "SQL命令;",
            "type": "1:成功，2:失败"
        }
        ...
    ]
}
1
2
3
4
5
6
7
8
9
10
11

# 返回值 已完成

{
    "code": 2,
    "msg": "执行完毕！"
}
1
2
3
4

# 取出指定条件的订单

http(s)://域名/api.php?act=OrderList&token=对接密钥&state=1&limit=100

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
state number 是 订单状态
limit number 是 取出的订单条数

# act的合法值

属性 说明 最低版本
OrderList 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# state的合法值

属性 说明 最低版本
1-7 订单类型

1成功，2待处理，3异常，4正在处理，5退款，6售后维权，7已评价

# limit的合法值

属性 说明 最低版本
100+n 取出的订单条数

# 返回值

{
    "code": 1,
    "msg": "订单数据获取成功！",
    "class": "类型(state)：1成功，2待处理，3异常，4正在处理，5退款,6售后维权,7已评价",
    "data": [
        {
            "id": "订单ID",
            "order": "订单号",
            "trade_no": "商户订单号",
            "uid": "购买用户ID",
            "ip": "127.0.0.1",
            "input": "下单信息,JSON格式",
            "state": "订单状态",
            "num": "下单份数",
            "return": "订单下单货源返回的结果",
            "gid": "商品ID",
            "order_id": "货源订单号",
            "money": "下单成本",
            "payment": "付款方式",
            "take": "1=未收货,2=确认收货",
            "price": "订单金额",
            "user_rmb": "货源返回的余额",
            "remark": "订单备注",
            "endtime": "订单完成时间",
            "addtime": "订单创建时间"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

此API用于软件对接供货订单处理等！

# 修改指定订单状态

http(s)://域名/api.php?act=OrderSet&token=对接密钥&state=1&remark=订单备注信息&user_rmb=余额&order_id=货源订单&return=货源对接返回信息

# 参数

属性 类型 默认值 必填 说明 最低版本
act string 是 判断参数 1.7+
token string 是 API对接密钥
state number 是 订单状态
remark string 是 订单备注信息
user_rmb float 是 货源余额
order_id string 是 货源订单
return string 是 货源对接返回信息

# act的合法值

属性 说明 最低版本
OrderSet 判断参数

# token的合法值

属性 说明 最低版本
密钥 api对接密钥

# state的合法值

属性 说明 最低版本
1-7 想要修改的订单类型

1成功，2待处理，3异常，4正在处理，5退款，6售后维权，7已评价

# remark的合法值

属性 说明 最低版本
订单备注 订单备注信息

# user_rmb的合法值

属性 说明 最低版本
0.00+n 货源余额

# order_id的合法值

属性 说明 最低版本
3xxxxx2xxxx2xxx 货源订单号

# return的合法值

属性 说明 最低版本
返回信息 货源对接返回信息

# 返回值

{
    "code": 1,
    "msg": "订单[需要修改数据的订单号]状态修改成功"
}
1
2
3
4

# 待扩展

← 系统对接 →