拼者积分商城以h5页面为载体。客户app只要将获取到的url嵌入到自身app产品页面中即可,手机端用户可以免登录URL进入积分商城,兑换礼品同步扣除积分,同时积分商城给用户兑换结果推送到客户系统后台。

接入拼者积分商城主要分三部分来完成,主要包括

  • 账号注册#

    • 在对接拼者积分商城之前,开发者需要先注册拼者积分账号,并获取分配的应用唯一标识 appKey 和密钥 appSecret

  • 接口对接#

    • 开发者把拼者积分商城集成到自己的app小程序或者微信公众号中,需要对接拼者积分相关接口。

  • 接口配置和上线使用#

    • 接口开发完成以后,需要把接口地址配置到拼者积分后台的接口配置页面。


术语定义


术语名称说明
开发者使用拼者积分商城服务的开发者简称。
积分开发者与拼者积分商城对接使用的虚拟货币单位,开发者可以自己更改货币名称 和 货币汇率
汇率开发者自己平台上的虚拟货币与现实中人民币的大致比率。如:100积分 = 1元 意味着100积分可以兑换1元面值的商品。
服务端指开发者的服务器,用于接口对接。
客户端又称用户端,纯 H5 方式接入。
自动登录url又称免登录 url,在用户进入拼者积分商城的时候由服务端实时生成,提供用户的登录信息,包含用户 id 和积分值。
扣积分接口用户发起兑换请求后,拼者积分会向开发者发一个扣积分的 http 请求,开发者接收到请求后,需创建订单、扣除用户相应的积分,并响应相应的信息。
通知接口用户在拼者积分兑换成功/失败后,拼者积分会向开发者发通知请求,告知订单最终结果,开发者需根据通知结果修改本地订单状态,如果结果为失败,还需要退还用户之前扣除的积分。
开发者账号开发者在拼者积分注册的账号。
应用(app)开发者账号下可以创建多个应用,便于统一账号下管理。
appKey每个应用都有一个唯一的标识码。
签名遍历请求参数的值进行 MD5 编码,比对 sign 值,确保请求不可伪造。
channel应用的渠道标识(游戏类应用)。



————对接基础接口:—————


1、免登录URL接口
1.1积分商城本质上是一个 H5 网页,客户app需要将网页嵌入到 app 中去。 
1.2、用户登录积分商城商城,需要客户app根据用户信息在服务端生成一个免登录 url,通过这个 url 链接,积分商城才能知道是哪个用户来访问,并通过 credits 参数获取用户的积分余额。 
1.3、为了确保客户端每次请求到都是最新的免登录 url,客户端每次向服务器发的请求不能是固定的,以避免请求被缓存。
1.4、积分商城免登录 url 经过签名,该 url 地址 5分钟 失效,请务必在生成地址后立即使用,使用后用户即可进入积分商城,登录状态 24小时 有效。 
1.5、客户app服务器端需要通过一个重定向功能实现动态生成免登录 url 地址。 
1.6、如果客户app事先生成免登录 url 地址,将导致 5分钟 后用户访问该地址过期


接口地址#

https://v.pinzz.cn/pinzz_creditmall/api.php

API 参数#

参数是否必须类型长度限制说明
uidyesstring128用户id
creditsyeslong20用户积分余额
appKeyyesstring32接口appKey,应用的唯一标识
timeStampyeslong201970-01-01开始的时间戳,秒为单位
signyesstring32MD5签名,详见 签名规则
channelnostring255渠道标识符(仅针对游戏类别应用)
goodsIdnoint255商品ID,若传入则直接跳转至商品详情页
isJumpRecordnoint1是否跳转至兑换记录页,0:不跳转,1:跳转
isHiddenNavBarnoint1是否隐藏导航栏,0:不隐藏,1:隐藏
nicknamenostring20用户昵称
wxOpenIdnostring128用户微信标识,接入小程序支付时必须传此字段
redirectTypenostring128跳转类型,(商品详情:goods,商品分类:goodsClassify,限量抢兑列表:limitActivity,积分夺宝:lotteryDraw,积分夺宝列表:lotteryDrawList,抽奖游戏:gameActivity,订单列表:orderList,拼团列表:teamList,拼团详情:teamDetails)
redirectPageIdnoint11跳转页面ID(跳转商品详情、积分夺宝、抽奖游戏、拼团详情时必填)

请求示例#

https://v.pinzz.cn/pinzz_creditmall/api.php?appKey=Fii6DgbvqWnEm2HYXupl5oaw&channel=17173&credits=200000&timeStamp=1459161352&uid=neo&sign=b451fb67aa4996d2c08b3567ba3591d3

Java 代码示例#

package com.mailejifen.sign;import java.util.Arrays;import java.util.HashMap;import java.util.Iterator;import java.util.Map;public class Sign {

    public static void main(String[] args) {
        //生成自动登录URL,用户根据自己需要更改HashMap中的数据
        HashMap<String, String> params = new HashMap<String, String>();
        params.put("uid", "商户登录用户标识");
        params.put("appKey", "商户对应的appKey(由拼者积分商城提供)");
        params.put("credits", "商户登录用户当前积分");
        params.put("channel", "商户提供的渠道标识符(仅针对游戏类应用)");
        params.put("timeStamp", String.valueOf(System.currentTimeMillis() / 1000));//当前时间戳
        params.put("sign", buildSign(params, "商户对应的appSercet(由拼者积分商城提供)"));
        String query = httpBuildQuery(params);

        String url = "https://v.pinzz.cn/pinzz_creditmall/api.php?" + query;

        System.out.println(url);
    }

    /**
     * 获得签名值
     *
     * @param params 传递给URL的参数,不含sign
     * @param secret App对应的secret
     * @return string
     */
    public static String buildSign(HashMap<String, String> params, String secret) {
        Object[] keys = params.keySet().toArray();
        Arrays.sort(keys);

        String str = "";
        for (Object key : keys) {
            str += params.get(key);
        }
        str += secret;

        //MD5生成方法有许多种,如有需要可网上查一下,在此就不再贴MD5类的源码了
        String sign = MD5.getMD5Code(str);
        return sign;
    }

    /**
     * 生成query
     *
     * @param params 传递给URL的参数,含sign
     * @return string
     */
    public static String httpBuildQuery(HashMap<String, String> params) {
        String query = "";
        Iterator iter = params.entrySet().iterator();
        while (iter.hasNext()) {
            Map.Entry entry = (Map.Entry) iter.next();
            query += entry.getKey() + "=" + entry.getValue() + "&";
        }
        return query;
    }}

PHP 代码示例#

	$appSercet = '';    //商户对应的appSercet(由拼者积分商城提供)
	$appKey = '';       //商户对应的appKey(由拼者积分商城提供)
	$uid = '';          //商户登录用户标识
	$timeStamp = time();//当前时间戳
	$credits = 1000;    //商户登录用户当前积分
	$channel = '';      //商户提供的渠道标识符(仅针对游戏类应用)
	$string = '';       //预定义构造请求url
	  
	$params = array(
	    'uid'=> $uid,
	    'appKey' => $appKey,
	    'timeStamp' => $timeStamp,
	    'credits' => $credits,
	    'channel' => $channel
	);
	 
	ksort($params);
	
	$string = join("", $params);
	
	$params['sign'] = md5($string . $appSercet);
	
	$query = http_build_query($params);
	
	return "https://v.pinzz.cn/pinzz_creditmall/api.php?" . $query;


2、用户积分扣除接口
2.1当用户发起兑换请求后,积分商城将会创建一个订单,然后发起该用户的积分扣除请求给客户app。

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

2.3如果扣除成功,写入成功的参数和客户app系统的订单号,返回这个响应给积分商城。

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

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


后台配置方法#

点击放大
点击放大

扣积分超时处理方式#

  • 拼者积分向开发者发起扣积分请求时,拼者积分设置超时时间为 30秒,由于开发者服务器响应过慢,或者网络异常等原因,可能会出现超时情况。 

  • 针对超时情况,拼者积分将该订单标记为失败,并向开发者发出失败通知。 如果开发者已经扣积分成功了,当收到通知时,需要对用户积分进行回滚。

  • 因为扣积分请求超时,拼者积分并没有收到开发者的订单号,因此在发送失败通知时,不会携带 bizId 数据。 

  • 开发者在接受拼者积分通知时,请以拼者积分订单号 orderSn 进行处理,而不要根据 bizId 进行处理!


API 参数#

参数是否必须类型限制长度说明
uidyesstring255用户id
creditsyeslong20本次兑换扣除的积分,当领取活动奖品时该值为0
appKeyyesstring255接口appKey,应用的唯一标识
timeStampyesstring201970-01-01开始的时间戳,秒为单位
descriptionnostring255本次积分消耗的描述(带中文,请用utf-8进行url解码)
orderSnyesstring255拼者积分订单号(请记录到数据库中)
typeyesstring255兑换类型(reality:实物phonefees:话费phonetraffic:流量coupon:卡券activity:活动
facePricenoint11兑换商品的市场价值,单位是分,请自行转换单位
actualPriceyesint11此次兑换实际扣除开发者账户费用,单位为
ipnostring255用户ip,不保证获取到
tokennostring255用于校验本次下单的支付密码是否合法,请查看 支付密码示例页面
orderParamsnostring255详情参数,不同的类型,返回不同的内容(json格式的字符串,通过解码成json对象读取数据),实物类型返回字段包含字段:phone,addressee,address;手机充值类型包含字段:phone
signyesstring255MD5签名,详见 签名规则

响应参数#

参数是否必须类型限制长度说明
codeyesint
状态码,0:处理成功,其他状态则判定为处理失败
msgyesstring255出错原因
datayes

返回数据
bizIdnostring255开发者的订单号(拼者积分会判断该订单号的唯一性,注意区分测试和正式对接时的订单号,以免重复)
creditsyeslong20用户积分余额

响应示例#

{
	"code": 0,
	"data": {
		"bizId": "1023851231",
		"credits": 185
	}}

注:请以标准json格式返回,字段名、字符串变量必须加双引号,数字类型不能用引号包含,对象、数组的最后一个元素不能有逗号结尾




3、用户兑换结果通知接口
3.1不管兑换行为最终成功还是失败,积分商城都会向客户app发出通知,汇报兑换结果。 
3.2客户app收到通知后,请以积分商城订单号 orderSn 为准进行处理,不要以客户app订单号bizId进行处理。原因详见上一章节的:扣积分超时处理方式。 
3.3如果兑换成功,客户app在系统内标记此订单为成功状态即可。如果兑换失败,客户app需要将该订单标记为失败,并将之前预扣的积分或余额返还给用户。 
3.4无论接收到的结果如何,只要客户app收到该请求,请返回JSON格式的code=0,否则积分商城将进行重复通知,直到客户app收到或者24小时内最多重复 4次

后台配置方法#

点击放大
点击放大

扣积分超时处理方式#

  • 拼者积分向开发者发起扣积分请求时,拼者积分设置超时时间为 30秒,由于开发者服务器响应过慢,或者网络异常等原因,可能会出现超时情况。 

  • 针对超时情况,拼者积分将该订单标记为失败,并向开发者发出失败通知。 如果开发者已经扣积分成功了,当收到通知时,需要对用户积分进行回滚。

  • 因为扣积分请求超时,拼者积分并没有收到开发者的订单号,因此在发送失败通知时,不会携带 bizId 数据。 

  • 开发者在接受拼者积分通知时,请以麦乐积分订单号 orderSn 进行处理,而不要根据 bizId 进行处理!

API参数#

参数是否必须类型限制长度说明
appKeyyesstring255接口appKey,应用的唯一标识码
timeStampyeslong201970-01-01开始的时间戳,秒为单位
successyesint10表示失败,1表示成功
errorMessagenostring255出错原因(带中文,请用utf-8进行解码)
orderSnyesstring255拼者积分订单号
typeyesstring255兑换类型
bizIdnostring255开发者的订单号
uidnostring128用户id
signyesstring255签名,详见 签名规则

响应参数:#

{
    "code": 0}
  • 开发者服务器端收到通知并处理完成后,请返回JSON格式的code=0,拼者积分在验证到响应为 JSON格式的code=0后会标记通知成功。

  • 如果响应为非以上结果,拼者积分会在24小时内最多重试4次通知。 通知时间间隔为:1m、2m、10m、1h

注:出于网络异常的可能性,拼者积分可能会对开发者进行重复通知,开发者务必确保一笔订单不进行重复处理,否则将产生严重 bug;详细原因参考下述:重复通知处理

重复通知处理#

  • 由于网络具有不稳定的特性,当拼者积分向开发者服务器发送成功/失败通知时,有可能存在拼者积分发送了通知,开发者收到了通知并进行了处理。

  • 若此时出现网络故障,开发者响应拼者积分失败,拼者积分没有收到开发者的响应,拼者积分会认为开发者没有收到通知,于是进行重复通知。

  • 此时开发者收到通知后,务必先确认此订单是否已经处理过。如果已经处理过,则忽略此通知,并响应JSON格式的code=0。 

  • 如果此时开发者忽略订单是否已经被处理过,而直接进行处理,将导致开发者反复向用户返还积分,导致损失!

注:有部分订单如实物类订单,需等待发货之后才会确认订单成功,此类订单可能会隔比较长时间才发订单结果通知;如果限制了通知等待时长会导致部分订单接收不到结果。



积分接口说明#

  • 当用户发起查看积分请求后,拼者积分将会调用该接口查看积分明细,商户返回对应的积分明细。

  • 这个请求会包含用户 id,消费类型等等信息。开发者收到该请求后,返回对应用户的积分明细。

  • 如果查询失败,写入失败的参数,并带上失败原因。拼者积分收到失败响应后会转告用户失败原因。


API 参数#

参数是否必须类型限制长度说明
uidyesstring255用户id
credits_typeyesint4积分类型(0:全部,1:积分收入,2:积分消耗)
appKeyyesstring255接口appKey,应用的唯一标识
timeStampyesstring201970-01-01开始的时间戳,秒为单位
pageyesint11当前页数
pageSizeyes1111每页多少条数据
signyesstring255MD5签名,详见 签名规则

响应参数#

参数是否必须类型限制长度说明
idyes

数据id
active_nameyesstring255事件名称(例如:抽奖、签到)
credits_amountyesint
积分值
create_timeyes

事件时间
credits_typeyesint4积分类型(1:积分收入 2:积分消耗)

响应示例#

{
	"code": 0,
	"msg":"",
	"data": [
	    {
            
    		"id": 1,
    		"active_name": "抽奖",
            "credits_amount": 10,
            "create_time": "2020-5-19",
            "credits_type": 2
            
        },
        {
                    
            "id": 2,
            "active_name": "签到",
            "credits_amount": 10,
            "create_time": "2020-5-19",
            "credits_type": 1
                    
        }
	]}

注:请以标准json格式返回,字段名、字符串变量必须加双引号,数字类型不能用引号包含,对象、数组的最后一个元素不能有逗号结尾





11月3日中国银行招标需要给客户解答技术上几点问题:

   1、我们的平台如何和客户的手机端口对接,需要客户提供哪些数据或者开放什么样的端口

答:我们积分商城通过h5网页链接到客户app需要客户app在服务端生成一个免登录 url我们积分商城才能知道是哪个用户来访问,并通过 credits 参数获取用户的积分余额。

   2、按照我们以往的技术,对接过程中会有哪些BUG,我们如何快速解决
答:会出现以下错误情况:
   a.
请求已过期:为了安全免登陆地址是有5分钟的有效期的
     
出错的免登录链接地址,观察链接中时间戳的参数(timestamp)的值是   
   b
签名验证失败 
   
检查验签的appkeyappsecrect是否和请求一致
    

   3、对接打通后,呈现方式有几种,弹窗、植入、还有哪些?
答:植入h5网页的方式

   4、从客户给到对接端口数据到接通,需要多久,之前有无成功案例可与客户分享
答:需要15天技术开发


拼者api接口文档

某位大咖 活动培训 2023-07-26 1534 0

有意向请提交和作或在线报名

活动主办方



某位大咖

活动时间:2023-07-26
报名数:0人
1534

此活动扫码转发到微信