integrationApi-v1.3

集成API

ServiceType 服务资源值

值	描述
ai	AI能力服务资源

访问集成API接口中的认证token(调用[创建用户]接口获取的token),必须为应用集成的管理员用户(登录闪闪编辑器应用集成管理后台的手机号)

机构服务资源余量

URL


xxxxxxxxxx
get  https://www.shanedit.com/partners/{serviceType}/available

描述

查询集成机构可分配的服务资源余量

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/available"
    -H "Authorization: Bearer $token"

返回示例


xxxxxxxxxx
{
    "data": {
        "totalAvailableNum": 1000,  //可分配总数
        "records": [
            {
                "id": 1,             //记录Id
                "totalNum": 1000,     // 总量
                "allocatedNum": 200,  // 已分配量
                "remainingNum": 800,  // 剩余可分配量
                "expireDate": "2025-12-31"  // 过期日期,在此日期后次日剩余可分配量过期
            },
            {
                "id":2,
                "totalNum": 200,
                "allocatedNum": 0,
                "remainingNum": 200,
                "expireDate": "2026-12-31"
            }
        ]
    },
    "message": "success",
    "success": true,
    "code": 200
}

机构服务资源详情

URL


xxxxxxxxxx
get https://www.shanedit.com/partners/{serviceType}/detail?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&pageNo=1&pageSize=10

描述

查询集成机构购买的服务资源列表详情

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
startDate	query	string	否	购买开始日期yyyy-MM-dd格式,为空则默认6个月前月初第一天
endDate	query	string	否	购买结束日期yyyy-MM-dd格式,为空则默认为当前日期
pageNo	query	integer	否	分页查询开始页面,从1开始,默认1
pageSize	query	integer	否	分页查询每页查询多少条记录,最小为1,最大为100,默认10

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/detail?pageNo=1&pageSize=10&startDate=2025-01-01&endDate=2025-06-30"
     -H "Authorization: Bearer $token"

返回示例


xxxxxxxxxx
{
    "data": {
        "records": [
            {
                "id": 1,           //标识Id
                "totalNum": 1000,     // 总量
                "allocatedNum": 800,  // 已分配量
                "cancelledNum":200, // 过期作废量
                "remainingNum": 0,     // 剩余量=总量-已分配量-过期作废量
                "status": 1,       //状态: 0使用中，1用完
                "expireDate": "2025-05-31"  // 过期日期,在此日期后次日剩余可分配量过期
            },
            {
                "id": 2,             //标识Id
                "totalNum": 2000,      // 总量
                "allocatedNum": 2000,  // 已分配量
                "cancelledNum":0,  // 过期作废量
                "remainingNum": 0,    // 剩余量=总量-已分配量-过期作废量
                "status": 0,       //状态: 0使用中，1用完
                "expireDate": "2025-12-31"  // 过期日期
            }
        ],
        "total": 2   //总记录数
    },
    "message": "success",
    "success": true,
    "code": 200
}

机构服务资源分配操作

URL


xxxxxxxxxx
post https://www.shanedit.com/partners/{serviceType}/allocate/{userId}

描述

集成机构将服务资源量分配给其用户

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
Content-Type	header	string	是	application/json
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
userId	path	string	是	待分配的用户Id,同[创建用户]接口中返回的Id
data	body	json	是	分配详情json参数,见请求data示例

示例


xxxxxxxxxx
curl -X POST "https://www.shanedit.com/partners/ai/allocate/123456"
    -H "Authorization: Bearer $token" 
    -H "Content-Type: application/json"
    -d '{"allocatedNum": 200, "expireDate": "2025-12-31"}'

请求data示例


xxxxxxxxxx
{
    "allocatedNum": 200,  //分配量
    "expireDate":"2025-12-31"  //过期日期yyyy-MM-dd格式,不能小于当前日期,不能大于当前日期起1年
}

返回示例


xxxxxxxxxx
{
    "data": {
        "preAllocatedNum": 300, //分配前可用量
        "allocatedNum": 200,  // 当前分配的量
        "availableNum": 500  //分配后用户可用额度
    },
    "message": "success",
    "success": true,
    "code": 200
}

错误信息


xxxxxxxxxx
{
    "data": null,
    "message": "当前可分配额度不足200",
    "success": false,
    "code": 400
}

机构服务资源分配记录

URL


xxxxxxxxxx
get https://www.shanedit.com/partners/{serviceType}/allocate-detail?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&pageNo=1&pageSize=10

描述

查询集成机构服务资源分配列表详情

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
startDate	query	string	否	分配开始日期yyyy-MM-dd格式,为空则默认6个月前月初第一天
endDate	query	string	否	分配结束日期yyyy-MM-dd格式,为空则默认为当前日期
pageNo	query	integer	否	分页查询开始页面,从1开始,默认1
pageSize	query	integer	否	分页查询每页查询多少条记录,最小为1,最大为100,默认10

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/allocate-detail?pageNo=1&pageSize=10&startDate=2025-01-01&endDate=2025-05-31"
-H "Authorization: Bearer $token"

返回示例


xxxxxxxxxx
{
    "data": {
        "records": [
            {
                "id":1, //记录Id
                "userId": "xxx", // 用户Id
                "allocateType": 1, // 1:分配
                "allocatedNum": 200, //分配量
                "allocatedBeforeNum":1000, //分配前集成商可用分配总量
                "allocatedAfterNum":800, //分配后集成商可用分配总量  
                "userBeforeAvailableNum":0, //用户分配前可用总量
                "userAfterAvailableNum":200, //用户分配后可用总量
                "createTime": "2025-05-04 12:00:00"  //分配时间
            },
            {
                "id":2, //记录Id
                "userId": "yyy", // 用户Id
                "allocateType": 1, // 1:分配
                "allocatedNum": 500, //分配量
                "allocatedBeforeNum":800, //分配前集成商可用分配总量
                "allocatedAfterNum":300, //分配后集成商可用分配总量
                "userBeforeAvailableNum":200, //用户分配前可用总量
                "userAfterAvailableNum":700, //用户分配后可用总量
                "createTime": "2025-05-05 14:00:00"  //分配时间
            }
        ],
        "total": 2
    },
    "message": "success",
    "success": true,
    "code": 200
}

用户余量

URL


xxxxxxxxxx
get  https://www.shanedit.com/partners/{serviceType}/user-available?userIds=xxx,yyy&pageNo=1&pageSize=10

描述

查询集成机构的用户服务资源余量

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
userIds	query	string	否	用户id,多个用户Id以英文逗号分隔;为空则查询该机构下所有用户
pageNo	query	integer	否	分页查询开始页面,从1开始,默认1
pageSize	query	integer	否	分页查询每页查询多少条记录,最小为1,最大为100,默认10

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/user-available?pageNo=1&pageSize=10&userIds=xxx,yyy"
-H "Authorization: Bearer $token" \

返回示例


xxxxxxxxxx
{
    "data": {
        "records": [
            {
                "userId": "xxx",  //用户Id
                "availableNum": 500, //用户可用总量
                "details": [  //明细
                    {
                        "id":1,  //记录Id
                        "availableNum": 200, //可用量
                        "expireDate": "2025-07-31" //过期日期
                    },
                    {
                        "id":2,  //记录Id
                        "availableNum": 300,
                        "expireDate": "2025-12-31"
                    }
                ]
            },
            {
                "userId": "yyy",
                "availableNum": 200,
                "details": [
                    {
                        "id":3,
                        "availableNum": 200,
                        "expireDate": "2025-07-31"
                    }
                ]
            }
        ],
        "total": 2
    },
    "message": "success",
    "success": true,
    "code": 200
}

用户消耗（实时）

URL


xxxxxxxxxx
get  https://www.shanedit.com/partners/{serviceType}/user-usage/{userId}?startDate=yyyy-MM-dd&endDate=yyyy-MM-dd&pageNo=1&pageSize=10

描述

查询集成机构的用户当前服务资源消耗

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
userId	path	string	是	用户id, 同[创建用户]接口中返回的Id
startDate	query	string	否	开始日期yyyy-MM-dd格式,为空则默认为当月1号;早于当月1号则自动设置为当月1号
endDate	query	string	否	结束日期yyyy-MM-dd格式,为空则默认为当前日期
pageNo	query	integer	否	分页查询开始页面,从1开始,默认1
pageSize	query	integer	否	分页查询每页查询多少条记录,最小为1,最大为100,默认10

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/user-usage/123456?pageNo=1&pageSize=10&startDate=2025-05-01"
    -H "Authorization: Bearer $token"

返回示例


xxxxxxxxxx
{
    "data": {
        "records": [
            {
                "consumeDate": "2025-05-04",  //消耗日期
                "consumeNum": 500 //消耗数量
            },
            {
                "consumeDate": "2025-05-05",
                "consumeNum": 200
            }
        ],
        "total": 2
    },
    "message": "success",
    "success": true,
    "code": 200
}

用户账单

URL


xxxxxxxxxx
get https://www.shanedit.com/partners/{serviceType}/user-bill?startBillDate=yyyy-MM&endBillDate=yyyy-MM&pageNo=1&pageSize=100

描述

查询集成机构的用户的账单信息

参数说明

参数	分类	类型	必须	说明
Authorization	header	string	是	Bearer $token
serviceType	path	string	是	服务资源类型, 需替换为具体的值,如ai
startBillDate	query	string	是	账单月开始月份,格式yyyy-MM
endBillDate	query	string	是	账单月结束月份,格式yyyy-MM
pageNo	query	integer	否	分页查询开始页面,从1开始,默认1
pageSize	query	integer	否	分页查询每页查询多少条记录,最小为1,最大为100,默认10

示例


xxxxxxxxxx
curl -X GET "https://www.shanedit.com/partners/ai/user-bill?startBillDate=2025-04&endBillDate=2025-05&pageNo=1&pageSize=10"
-H "Authorization: Bearer $token"

返回示例


xxxxxxxxxx
{
    "data": {
        "records": [
            {
                "id":1, //记录Id
                "billDate": "202504", //账单月份
                "userId": "xxx",  //用户Id
                "consumeNum": 200,  //消耗量
                "cancelledNum":0, //过期作废量
            },
            {
                "id":2,
                "billDate": "202504",
                "userId": "yyy",  
                "consumeNum": 100,
                "cancelledNum":0
            },
            {
                "id":3,
                "billDate": "202505",
                "userId": "xxx",
                "consumeNum": 100,
                "cancelledNum":0
            },
            {
                "id":4,
                "billDate": "202505",
                "userId": "yyy",
                "consumeNum": 200,
                "cancelledNum":0
            }
        ],
        "total": 4
    },
    "message": "success",
    "success": true,
    "code": 200
}