激活码插件（acti-code）前端接口文档

目录

  1. 获取会员激活码列表
  2. 获取激活码详情
  3. 使用激活码激活云店主
  4. 转赠激活码
  5. 获取可用激活码数量
  6. 查询会员信息
  7. 获取转赠记录
  8. 获取激活码使用说明
  9. 获取激活码统计信息
  10. 获取云店主的激活码列表

1. 获取会员激活码列表

简要描述：

获取当前会员的激活码列表，支持按状态筛选。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-list

请求参数说明:

参数名 类型 说明
status int 状态筛选，0=未使用，1=已使用，2=已过期，不传则返回全部
code string 激活码序列号搜索，支持模糊匹配
source_type int 获得方式筛选，1=后台发放，2=受赠
page int 页码，默认 1

返回示例:

正确时返回

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "list": [
            {
                "id": 1,
                "code": "AC202604200001",
                "status": 0,
                "status_name": "未使用",
                "expire_time": "2026-05-20 23:59:59",
                "source_type": 1,
                "source_type_text": "后台发放",
                "created_at": "2026-04-20 10:00:00"
            },
            {
                "id": 2,
                "code": "AC202604200002",
                "status": 1,
                "status_name": "已使用",
                "expire_time": "2026-05-20 23:59:59",
                "source_type": 1,
                "source_type_text": "后台发放",
                "created_at": "2026-04-20 10:00:00"
            }
        ],
        "total": 2,
        "current_page": 1,
        "last_page": 1,
		"is_merchant":: true
    }
}

返回参数说明:

参数名 类型 说明
is_merchant bool 是否为云店店主，true是，false 不是
result int 接口状态，1 表示成功
msg string 返回提示
data.list array 激活码列表
data.list[].id int 激活码ID
data.list[].code string 激活码序列号
data.list[].status int 状态，0=未使用，1=已使用，2=已过期
data.list[].status_name string 状态名称
data.list[].expire_time string 过期时间，永久有效时返回"永久有效"
data.list[].source_type int 获得方式，1=后台发放，2=受赠
data.list[].source_type_text string 获得方式文本
data.list[].created_at string 获得时间
data.total int 总记录数
data.current_page int 当前页码
data.last_page int 最后一页页码

2. 获取激活码详情

简要描述：

获取指定激活码的详细信息。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-detail

请求参数说明:

参数名 类型 说明
id int 激活码ID，必填

返回示例:

正确时返回

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "id": 1,
        "code": "AC202604200001",
        "status": 0,
        "status_name": "未使用",
        "expire_time": "2026-05-20 23:59:59",
        "source_type": 1,
        "source_type_text": "后台发放",
        "use_type": 0,
        "use_type_text": "-",
        "remark": "",
        "created_at": "2026-04-20 10:00:00",
        "use_time": "",
        "recipient": null
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 激活码详情
data.id int 激活码ID
data.code string 激活码序列号
data.status int 状态，0=未使用，1=已使用，2=已过期
data.status_name string 状态名称
data.expire_time string 过期时间，永久有效时返回"永久有效"
data.source_type int 获得方式，1=后台发放，2=受赠
data.source_type_text string 获得方式文本
data.use_type int 使用方式，0=未使用，1=激活云店主，2=转赠，3=过期
data.use_type_text string 使用方式文本
data.remark string 备注
data.created_at string 获得时间
data.use_time string 使用时间，已使用时有值
data.recipient object 转赠场景下的受赠用户信息
data.recipient object 当前持有者信息（转赠后显示）
data.recipient.member_id int 持有者会员ID
data.recipient.nickname string 持有者昵称
data.recipient.avatar string 持有者头像URL
data.recipient.mobile string 持有者手机号

3. 使用激活码激活云店主

简要描述：

使用激活码激活云店主身份。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.use-code

请求参数说明:

参数名 类型 说明
id int 激活码ID，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "激活成功",
    "data": {
        "merchant_id": 123,
        "plugin_name": "云店主",
        "redirect_url": "/addons/yun_shop/#/plugin/cloud-merchant"
    }
}

失败时返回

{
    "result": 0,
    "msg": "激活码不可用"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功，0 表示失败
msg string 返回提示
data object 成功时返回的数据
data.merchant_id int 创建的云店主ID
data.plugin_name string 插件名称
data.redirect_url string 跳转URL

错误提示说明:

错误提示 说明
激活码不存在 激活码ID无效或不属于当前用户
激活码不可用 激活码已使用或已过期
您已是云店主，无法重复激活 当前会员已是云店主
云店主功能暂未开启 后台未开启云店主功能

4. 转赠激活码

简要描述：

将激活码转赠给其他会员。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.transfer

请求参数说明:

参数名 类型 说明
quantity int 转赠数量，必填
target_info string 受赠人ID或手机号，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "转赠成功",
    "data": {
        "transfer_count": 2,
        "target_member_id": 10002,
        "target_nickname": "张三",
        "target_mobile": "13800138000"
    }
}

失败时返回

{
    "result": 0,
    "msg": "可用激活码数量不足，当前可用：1"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 转赠结果数据
data.transfer_count int 成功转赠的数量
data.target_member_id int 受赠人会员ID
data.target_nickname string 受赠人昵称
data.target_mobile string 受赠人手机号

5. 获取可用激活码数量

简要描述：

获取当前会员可用（未使用且未过期）的激活码数量。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-available-count

请求参数说明:

无

返回示例:

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "available_count": 5
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data.available_count int 可用激活码数量

6. 查询会员信息

简要描述：

查询会员信息，用于转赠时回显受赠人信息。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.search-member

请求参数说明:

参数名 类型 说明
keyword string 会员ID或手机号，必填

返回示例:

成功时返回

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "member_id": 10002,
        "nickname": "张三",
        "avatar": "https://example.com/static/images/avatar.png",
        "mobile": "13800138000"
    }
}

失败时返回

{
    "result": 0,
    "msg": "会员不存在"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 会员信息
data.member_id int 会员ID
data.nickname string 会员昵称，未设置时返回"未设置昵称"
data.avatar string 会员头像URL
data.mobile string 会员手机号

7. 获取转赠记录

简要描述：

获取转赠记录列表，支持查看发出的转赠或收到的受赠。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-transfer-records

请求参数说明:

参数名 类型 说明
type string 记录类型，send=发出的转赠，receive=收到的受赠，默认 send
page int 页码，默认 1

返回示例:

正确时返回

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "list": [
            {
                "id": 3,
                "code": "AC202604200003",
                "status": 0,
                "status_name": "未使用",
                "source_type": 2,
                "source_type_text": "受赠",
                "created_at": "2026-04-20 15:00:00"
            }
        ],
        "total": 1,
        "current_page": 1,
        "last_page": 1
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data.list array 转赠记录列表
data.list[].id int 激活码ID
data.list[].code string 激活码序列号
data.list[].status int 状态，0=未使用，1=已使用，2=已过期
data.list[].status_name string 状态名称
data.list[].source_type int 获得方式，1=后台发放，2=受赠
data.list[].source_type_text string 获得方式文本
data.list[].created_at string 获得时间
data.total int 总记录数
data.current_page int 当前页码
data.last_page int 最后一页页码

8. 获取激活码使用说明

简要描述：

获取激活码的使用说明和提示信息。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-instructions

请求参数说明:

无

返回示例:

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "instructions": "激活码可用于激活云店主身份...",
        "tips": [
            "1. 激活码可用于激活云店主身份",
            "2. 激活码可在有效期内使用",
            "3. 激活码可转赠给其他会员",
            "4. 已过期的激活码无法使用"
        ]
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 使用说明数据
data.instructions string 详细使用说明（从后台设置获取）
data.tips array 提示信息列表

9. 获取激活码统计信息

简要描述：

获取当前会员激活码的统计数据。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-stats

请求参数说明:

无

返回示例:

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "total": 10,
        "unused": 5,
        "used": 3,
        "expired": 2
    }
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data.total int 激活码总数
data.unused int 未使用数量（未过期）
data.used int 已使用数量
data.expired int 已过期数量

10. 获取云店主的激活码列表

简要描述：

获取云店主的激活码列表，包含云店主信息。

请求域名:

  • http://xx.com

请求路由:

/addons/yun_shop/api.php?i=商城ID&route=plugin.acti-code.frontend.acti-code.get-merchant-codes

请求参数说明:

参数名 类型 说明
status int 状态筛选，0=未使用，1=已使用，2=已过期，不传则返回全部
page int 页码，默认 1

返回示例:

成功时返回

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "merchant": {
            "merchant_id": 123,
            "member_id": 10001,
            "invite_reward_total": "100.00",
            "self_sale_total": "500.00",
            "created_at": "2026-04-20 10:00:00"
        },
        "list": [
            {
                "id": 1,
                "code": "AC202604200001",
                "status": 1,
                "status_name": "已使用",
                "expire_time": "2026-05-20 23:59:59",
                "use_type": 1,
                "use_type_text": "激活云店主",
                "use_time": "2026-04-20 12:00:00",
                "created_at": "2026-04-20 10:00:00"
            }
        ],
        "total": 1,
        "current_page": 1,
        "last_page": 1
    }
}

失败时返回

{
    "result": 0,
    "msg": "您还不是云店主"
}

返回参数说明:

参数名 类型 说明
result int 接口状态，1 表示成功
msg string 返回提示
data object 云店主和激活码数据
data.merchant object 云店主信息
data.merchant.merchant_id int 云店主ID
data.merchant.member_id int 会员ID
data.merchant.invite_reward_total string 邀请奖励总额
data.merchant.self_sale_total string 自店销售总额
data.merchant.created_at string 成为云店主时间
data.list array 激活码列表
data.list[].id int 激活码ID
data.list[].code string 激活码序列号
data.list[].status int 状态，0=未使用，1=已使用，2=已过期
data.list[].status_name string 状态名称
data.list[].expire_time string 过期时间
data.list[].use_type int 使用方式，0=未使用，1=激活云店主，2=转赠，3=过期
data.list[].use_type_text string 使用方式文本
data.list[].use_time string 使用时间
data.list[].created_at string 获得时间
data.total int 总记录数
data.current_page int 当前页码
data.last_page int 最后一页页码