交叉授权API文档

1. 发起授权请求

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.initiate-authorization

请求参数说明:

参数名 类型 是否必需 说明
authorized_member_id int 被授权机主会员ID

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "授权请求已发送",
    "data": {
        "id": 1,
        "initiator_machine_id": 1,
        "initiator_member_id": 1001,
        "authorized_machine_id": 2,
        "authorized_member_id": 1002,
        "status": 0,
        "created_at": "2025-12-29 10:00:00",
        "updated_at": "2025-12-29 10:00:00"
    }
}

错误时返回:

{
    "result": 0,
    "msg": "授权机主会员ID不能为空"
}

返回参数说明:

参数名 类型 说明
data.id int 授权记录ID
data.initiator_machine_id int 发起授权的机主ID
data.initiator_member_id int 发起授权的会员ID
data.authorized_machine_id int 被授权的机主ID
data.authorized_member_id int 被授权的会员ID
data.status int 授权状态:0-待处理,1-已授权,2-已拒绝,3-已取消
data.created_at string 创建时间
data.updated_at string 更新时间

2. 同意授权

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.approve-authorization

请求参数说明:

参数名 类型 是否必需 说明
id int 授权记录ID

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "授权已通过",
    "data": {
        "id": 1,
        "initiator_machine_id": 1,
        "initiator_member_id": 1001,
        "authorized_machine_id": 2,
        "authorized_member_id": 1002,
        "status": 1,
        "created_at": "2025-12-29 10:00:00",
        "updated_at": "2025-12-29 10:30:00"
    }
}

错误时返回:

{
    "result": 0,
    "msg": "授权记录ID不能为空"
}

返回参数说明:

参数名 类型 说明
data.id int 授权记录ID
data.status int 授权状态:1-已授权
data.updated_at string 更新时间

3. 拒绝授权

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.reject-authorization

请求参数说明:

参数名 类型 是否必需 说明
id int 授权记录ID

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "授权已拒绝",
    "data": {
        "id": 1,
        "initiator_machine_id": 1,
        "initiator_member_id": 1001,
        "authorized_machine_id": 2,
        "authorized_member_id": 1002,
        "status": 2,
        "created_at": "2025-12-29 10:00:00",
        "updated_at": "2025-12-29 10:30:00"
    }
}

错误时返回:

{
    "result": 0,
    "msg": "授权记录ID不能为空"
}

返回参数说明:

参数名 类型 说明
data.id int 授权记录ID
data.status int 授权状态:2-已拒绝
data.updated_at string 更新时间

4. 取消授权

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.cancel-authorization

请求参数说明:

参数名 类型 是否必需 说明
id int 授权记录ID

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "授权已取消",
    "data": {
        "id": 1,
        "initiator_machine_id": 1,
        "initiator_member_id": 1001,
        "authorized_machine_id": 2,
        "authorized_member_id": 1002,
        "status": 3,
        "created_at": "2025-12-29 10:00:00",
        "updated_at": "2025-12-29 10:20:00"
    }
}

错误时返回:

{
    "result": 0,
    "msg": "授权记录ID不能为空"
}

返回参数说明:

参数名 类型 说明
data.id int 授权记录ID
data.status int 授权状态:3-已取消
data.updated_at string 更新时间

5. 删除授权记录

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.delete-authorization

请求参数说明:

参数名 类型 是否必需 说明
id int 授权记录ID

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "授权记录已删除"
}

错误时返回:

{
    "result": 0,
    "msg": "授权记录ID不能为空"
}

6. 获取授权列表

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.get-authorization-list&page=1&page_size=15

请求参数说明:

参数名 类型 是否必需 说明
page int 页码,默认1
page_size int 每页条数,默认15

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "list": [
            {
                "id": 1,
                "initiator_machine_id": 1,
                "initiator_member_id": 1001,
                "authorized_machine_id": 2,
                "authorized_member_id": 1002,
                "status": 1,
                "created_at": "2025-12-29 10:00:00",
                "updated_at": "2025-12-29 10:30:00",
                "initiatorMember": {
                    "uid": 1001,
                    "nickname": "机主A",
                    "avatar": "http://example.com/avatar1.jpg"
                },
                "authorizedMember": {
                    "uid": 1002,
                    "nickname": "机主B",
                    "avatar": "http://example.com/avatar2.jpg"
                }
            }
        ],
        "page": 1,
        "page_size": 15,
        "total": 1
    }
}

错误时返回:

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

返回参数说明:

参数名 类型 说明
data.list array 授权记录列表
data.page int 当前页码
data.page_size int 每页条数
data.total int 总记录数
data.list[].id int 授权记录ID
data.list[].status int 授权状态
data.list[].initiatorMember object 发起授权的会员信息
data.list[].authorizedMember object 被授权的会员信息

7. 获取待处理授权

请求路由:

route=plugin.yz-supply-water-machine.frontend.business.authorization.get-pending-authorizations&page=1&page_size=15

请求参数说明:

参数名 类型 是否必需 说明
page int 页码,默认1
page_size int 每页条数,默认15

返回示例:

正确时返回:

{
    "result": 1,
    "msg": "获取成功",
    "data": {
        "list": [
            {
                "id": 2,
                "initiator_machine_id": 3,
                "initiator_member_id": 1003,
                "authorized_machine_id": 2,
                "authorized_member_id": 1002,
                "status": 0,
                "created_at": "2025-12-29 11:00:00",
                "updated_at": "2025-12-29 11:00:00",
                "initiatorMember": {
                    "uid": 1003,
                    "nickname": "机主C",
                    "avatar": "http://example.com/avatar3.jpg"
                }
            }
        ],
        "page": 1,
        "page_size": 15,
        "total": 1
    }
}

错误时返回:

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

返回参数说明:

参数名 类型 说明
data.list array 待处理授权记录列表
data.page int 当前页码
data.page_size int 每页条数
data.total int 总记录数
data.list[].id int 授权记录ID
data.list[].status int 授权状态:0-待处理
data.list[].initiatorMember object 发起授权的会员信息
data.list[].authorized_machine_id object 接收授权的会员信息

状态码说明

状态码 说明
pending 等待确认
success 授权成功
rejected 已拒绝
canceled 已取消

错误码说明

错误信息 说明
插件未开启 插件未在后台开启
授权机主会员ID不能为空 缺少必填参数authorized_member_id
您还不是机主,无法发起授权 当前用户不是机主
授权机主不存在 被授权的机主不存在
不能对自己发起授权 发起授权和被授权的是同一个机主
已存在待处理或已授权的记录 已经存在有效的授权记录
授权记录ID不能为空 缺少必填参数id
授权记录不存在 授权记录不存在
您还不是机主 当前用户不是机主
无权操作此授权 当前用户无权操作该授权记录
该授权记录已处理 授权记录已经被处理过
已授权的记录不能取消 已授权的记录不能取消