橙积分橙积分
返回首页
返回首页
  • 对接准备
  • 接入方式
    • 客户端接入
    • 微信端接入
  • 对接说明
  • 接口交互流程
  • 术语定义
  • 签名规则
  • 登录接口
    • 接口说明
    • API文档
  • 扣积分接口
    • 扣积分接口
      • 接口说明
      • API 文档
      • 响应参数
      • data 说明
      • 成功返回示例
  • 加积分接口
  • 查积分接口
  • 虚拟商品充值接口
    • 接口说明
    • 虚拟充值接口API文档
    • 充值通知接口API文档
    • 附录
  • 接口文档V1.1.2

扣积分接口

接口说明

该接口由开发者开放给橙券积分商城。

当用户发起兑换请求后,橙券积分商城将会创建一个订单,并发送一条该用户对应的扣积分请求给开发者。

这个请求会包含 uid,橙券积分商城订单号,消耗的积分数,兑换描述等信息。开发者收到该请求后,请自行在系统中创建订单,并记录请求中的相关信息,同时执行用户积分扣除行为。

如果扣除成功,写入成功的参数和开发者系统的订单号,返回这个响应给橙券积分商城。

如果扣除失败,写入失败的参数,并带上失败原因。橙券积分商城收到失败响应后会将这个兑换订单标记为失败,并转告用户失败原因。

API 文档

应用级参数

参数名类型必须描述
creditsint是本次扣减的积分值
order_nostring(32)是橙券积分商城提交的订单号,最长 32 位(唯一)
exchange_descstring(255)否本次积分消耗的描述(带中文,请用 UTF-8 进行 URL 解码)
uidstring(50)是用户唯一性标识,对应唯一一个用户且不可变

请求示例

{
    "app_key": "5gtbvgWkeSAvUjItxjeY",
    "credits": "2",
    "order_no": "SIGN1775353644988706816",
    "timestamp": "1712112268103",
    "uid": "30343",
    "sign": "7332C03065BAD07CE5177377FDD4CAC5"
}

响应参数

参数名类型必须描述
codeint(10)是状态码(200 为成功,其他均为失败)
dataobject是响应数据
messagestring(255)是响应信息

data 说明

参数名类型必须描述
userOrderNostring(32)是合作方订单号
creditsint是用户当前积分余额

成功返回示例

{
    "message": "请求通过",
    "data": {
        "userOrderNo": "ORI78789",
        "credits": 100
    },
    "code": 200
}
Prev
登录接口
Next
加积分接口