接口说明
接口需求背景
为了优化积分商城内部的积分流通,提高用户的粘性和参与度,橙券积分商城内置了多个积分运营场景,如:参加连续签到活动获取积分,使用这些运营场景需要开发者提供增加积分的接口。增加积分接口为可选接口,开发者可根据自身运营需求合理地进行配置。
该接口由开发者开放给橙券积分商城
当用户产生增加积分的行为后,橙券积分商城将会创建一个订单,橙券积分商城会向商户配置的加积分接口发送一条该用户对应的增加积分请求。
这个请求会包含uid,橙券积分商城订单号,增加的积分数,积分描述等信息。开发者收到该请求后,请系统中创建加积分订单,并记录请求中的相关信息,同时执行用户积分增加操作,并返回此次加积分请求的结果响应。
如果增加积分成功,写入成功的参数和开发者系统的订单号,返回这个响应给橙券积分商城。
如果增加积分失败,写入失败的参数,并带上失败原因。橙券积分商城收到失败响应后会将这个加积分订单标记为失败。
API文档
应用级参数
| 参数名 | 类型 | 必须 | 描述 |
|---|---|---|---|
| credits | int(11) | 是 | 本次增加的积分值 |
| order_no | string(32) | 是 | 橙券积分商城提交的订单号,最长32位(唯一) |
| increase_desc | string(255) | 否 | 本次积分增加的描述(带中文,请用 UTF-8 进行 URL 解码) |
| uid | string(50) | 是 | 用户唯一性标识,对应唯一一个用户且不可变 |
请求示例
{
"app_key": "5gtbvgWkeSAvUjItxjeY",
"credits": 2,
"order_no": "SIGN1775353644988706816",
"timestamp": "1712112268103",
"uid": "17606382359",
"sign": "7332C03065BAD07CE5177377FDD4CAC5"
}
响应参数
| 参数名 | 类型 | 必须 | 描述 |
|---|---|---|---|
| code | int(10) | 是 | 状态码(200 为成功,其他均为失败) |
| data | object | 是 | 响应数据 |
| message | string(255) | 是 | 响应信息 |
data 说明
| 参数名 | 类型 | 必须 | 描述 |
|---|---|---|---|
| userOrderNo | string(32) | 是 | 合作方订单号 |
| credits | int(11) | 是 | 用户当前积分余额 |
成功返回示例
{
"message": "请求通过",
"data": {
"userOrderNo": "ORI78789",
"credits": 100
},
"code": 200
}
