商家自有积分接口(使用商家级别appkey和appSecret)

接口交互流程图

扣积分接口

接口说明

该接口由开发者开放给通兑吧

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

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

如果扣除成功,写入成功的参数和开发者系统的订单号,返回这个响应给通兑吧。

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

扣积分行为可能会发生超时的情况,对于这种情况,通兑吧会将订单标记为失败,并进行失败通知。

注:通兑吧向开发者发起加或减积分请求时,通兑吧设置超时时间为10秒,由于开发者服务器响应过慢,或者网络异常等原因,可能会出现超时情况。 针对超时情况,通兑吧将该订单标记为失败,并向开发者发出失败通知。 如果开发者已经加或扣积分成功了,结合自己实际情况进行相应处理。通兑吧可能会并发请求接口,请开发者做好幂等性处理,如果相同订单已处理,请返回对应响应结构。

API文档

  • 请求类型:GET

  • 签名规则请查看签名算法

  • 请求参数

变量名 是否必填 长度 类型 说明
unionId 32 string 用户unionId
pointsAmount 11 int 扣减用户积分数量
subject 25 string 扣减类型,如活动消耗
orderId 100 string 订单id
  • 返回信息
参数 是否必填 类型 说明
code int 返回状态码(参考状态码定义部分)
msg string 返回错误信息,code为0,则为“success”
data objects 响应内容
bizId string 开发者的订单号(唯一且不重复,如果失败情况,该值可以不传)
  • 返回示例

    {    
           "code": 0,
           "msg": "success",    
           "data": {        
               "bizId": "123456789" 
           } 
    }
    

加积分接口

接口说明

该接口由开发者服务端开放给通兑吧

当用户在积分商城达成加积分的条件后,通兑吧服务端会给上述配置的接口发送加积分请求,请求会带上加积分相关的必要信息,开发者收到请求后需生成订单、记录通兑吧订单号及相关的加积分信息,并标记订单处理结果以方便回溯查询。同时,返回此次加积分请求的结果响应。

API文档

  • 请求类型:GET
  • 签名规则请查看签名算法

请求参数

参数 是否必填 长度 类型 说明
unionId 32 string 用户unionId
pointsAmount 11 int 添加用户积分数量
subject 25 string 扣减类型,如打卡签到
orderId 100 string 订单id

返回响应

参数 是否必填 类型 说明
code int 返回状态码(参考状态码定义部分)
msg string 返回错误信息,code为0,则为“success”
data objects 响应内容
bizId string 开发者的订单号(唯一且不重复,如果失败情况,该值可以不传)

返回示例

{    
       "code": 0,
       "msg": "success",    
       "data": {        
           "bizId": "123456789" 
       } 
}

查询用户积分

接口说明

该接口由开发者服务端开放给通兑吧

积分商城这边需要显示用户积分账户数据,该接口有开发者开放给通兑吧

API文档

请求类型:GET

签名规则请查看签名算法

请求参数

参数 是否必填 类型 说明
unionId string 用户unionId

返回响应

参数 是否必填 长度 类型 说明
code 11 int 返回状态码(参考状态码定义部分)
msg 255 string 返回错误信息,code为0,则为“success”
data objects 响应内容
unionId 100 string 用户unionId
pointsAmount 11 int 用户积分数额

返回示例

{    
       "code": 0,
       "msg": "success",    
       "data": {        
           "unionId": "123456789",
           "pointsAmount": 45
       } 
}

兑换结果通知接口

接口说明

该接口由开发者开放给通兑吧

不管兑换行为最终成功还是失败,通兑吧都会向开发者发出通知,汇报兑换结果。

如果兑换成功,开发者在系统内标记此订单为成功状态即可。如果兑换失败,开发者需要将该订单标记为失败,并将之前扣积分接口预扣的积分返还给用户或者加积分的接口再扣除积分。

无论接受到的结果如何,只要开发者收到该请求,请返回 ok 字符串(不含双引号),如果响应为非 ok 字符串,通兑吧会在24小时内最多重试 8 次通知。

注:出于网络异常的可能性,通兑吧可能会对开发者进行重复通知,开发者务必确保一笔订单不进行重复处理,否则将产生严重bug

API文档

请求类型:GET

签名规则请查看签名算法

请求参数

参数 是否必填 长度 类型 说明
unionId 32 string 用户unionId
status 1 int 状态: 0是成功1是失败
bizId 100 string 开发者订单号
orderId 100 string 通兑吧订单号
errorMessage 255 string 出错原因

注:开发者收到通知后,请以通兑吧订单号orderId为准进行处理,不要以开发者订单号bizId进行处理。

响应参数

开发者服务器端收到通知并处理完成后,请返回纯文本的 ok 字符串,两边不带空格,通兑吧在验证到响应为 ok 后会标记通知成功。

results matching ""

    No results matching ""