使用场景:
企业其它渠道消耗用户积分余额
接口地址 /api/integrate/audience/point/change
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
接口描述 用户积分变更接口
应用权限 积分->用户积分变更
#请求参数
###请求头参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-Token | 自建应用访问token | header | true | string |
###公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
data | 变更数据,每次最大500条 | body | true | array | 用户积分变更 |
###用户积分变更
- 用户匹配顺序
thirdId > audienceUserId,匹配标识必传一种
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
audienceUserId | 用户ID | body | false | Long | |
thirdId | 第三方用户ID | body | false | String | |
nickName | 昵称 | body | false | String | |
avatar | 头像 | body | false | String | |
orderNo | 交易号,变更请求唯一识别ID | body | true | String | |
contentId | 触发变更的内容ID | body | false | String | |
contentName | 触发变更的内容名称 | body | false | String | |
eventType | 行为类型(createExchangeOrder:创建兑换订单, pointTrim:增减积分, pointOverdue:过期积分) | body | true | String | |
exchangeType | 变动类型(1:获得, 2:消耗) | body | true | int | |
exchangePoint | 变动积分 | body | true | int | |
remark | 备注 | body | false | String | |
actionTime | 操作时间,格式:yyyy-MM-dd HH:mm:ss | body | true | String |
###请求示例
{
"data":[{
}]
}
#响应参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
code | 状态码 | body | true | string | |
errorCode | 异常码 | body | true | string | |
msg | 描述 | body | true | string | |
data | 响应数据 | body | true | object | 用户积分变更结果 |
###用户积分变更结果 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | status | 任务状态(-1: 失败, 0: 进行中, 1: 成功, 2: 部分成功) | body | true | int | | | errorData | 变更失败数据 | body | false | array | 用户积分变更 | | successData | 变更成功数据 | body | false | array | 积分记录 |
###积分记录 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | orderNo | 交易号,变更请求唯一识别ID | body | true | String | | | pointRecordId | 积分记录ID | body | true | Long | |
###响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
###响应示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok",
"data": null
}