术语定义

开发者:兑吧活动工具使用者的简称。

免登录URL:由活动工具接口生成,用户访问该链接可跳转进入兑吧活动页面。注:免登录的定义是用户id由开发者传给兑吧,作为用户的唯一识别凭证,不需要用户在积分商城内再次登录。

活动页面链接:兑吧内部活动页面的链接地址,兑吧后台会自动将其通过dbredirect参数拼接在活动工具接口地址上,需要通过活动工具接口跳转,不可直接访问。填写活动工具接口后,可以在活动列表页面获取。

dbredirect:由客户端传给服务端的重定向参数,该参数用于携带活动页面链接。

活动工具接口

活动工具接口拼接用户信息以及要跳转的活动页面链接生成免登录URL,该链接向兑吧提供用户唯一标识uid)。兑吧需要根据uid来区分不同的用户,管理参与次数和发放奖品。

接口请求流程图

接口请求流程图

原理及说明

活动工具接口需要部署在开发者的服务端,提供给客户端调取。运营在兑吧后台配置一个活动,在活动列表页获取到拼接好的活动链接,将其埋在客户端的运营位上,用户点击活动会访问服务端的活动工具接口,服务端根据用户信息和dbredirect参数上的活动链接生成免登录URL,通过302响应码返回给用户,让其重定向到该免登录URL,进入活动。

免登录URL需经过 MD5 签名,该链接地址 5 分钟失效,请务必在生成后立即使用,用户访问免登录URL后即可进入活动页面,登录状态 24 小时有效。如果开发者事先生成免登录URL,将会导致 5 分钟后用户访问该地址过期。

为了确保用户每次点击都获取到最新的链接,客户端应避免请求被缓存。

输入参数

参数 是否必须 参数类型 限制长度 参数说明
uid yes string 255 用户唯一标识
credits yes long 20 独立活动工具接入,此参数值默认传 0 即可
appKey yes string 225 接口appKey,区分应用的唯一标识
timestamp yes long 20 1970-01-01开始的时间戳,毫秒为单位
redirect yes string 225 重定向参数,跳转到指定的活动页(取dbredirect的值)
sign yes string 225 MD5签名(查看签名规则

服务端开发包下载地址

点此下载(Java开发包)

代码示例(Java)

String redirect=request.getParameter("dbredirect");  //从客户端请求中获取dbredirect参数的值,将其赋给redirect

Map<String, String> map=new HashMap<String, String>();    
if(redirect!=null&&!"".equals(redirect)){
    map.put("redirect", redirect);
}

String appKey="test-fwimmZD8gShMbR2w9zA";    //在兑吧后台获取
String appSecret="test-4VpDYvuDxhdpo9mt6FVWi";    //签名密钥,发送到注册邮箱中,需妥善保管
String timestamp=String.valueOf(new Date().getTime());    //以北京时间为准,单位为毫秒

map.put("uid", "test111");    //uid为区分用户的唯一标识符,可使用用户id或者设备号。
map.put("credits", "0");    //credits参数默认写死为0
map.put("timestamp", timestamp);

CreditTool tool=new CreditTool(appKey, appSecret);

String url="http://www.duiba.com.cn/autoLogin/autologin?";
String autoLoginUrl = tool.buildUrlWithSign(url, map);

客户端配置活动链接

活动链接会经过URL编码后拼接在活动工具接口的dbredirect参数上,拼接好的链接可以从兑吧后台的活动列表获取。

链接组成:活动工具接口 + dbredirect 此处输入图片的描述

服务端生成的免登录URL示例

链接组成:兑吧接口 (http://www.duiba.com.cn/autoLogin/autologin?)+ appKey + uid + credits + sign + redirect

拼接后示例: http://www.duiba.com.cn/autoLogin/autologin?appKey=fwimmZD8gShMbR2w9zAUoDado6L&uid=test111&credits=10&sign=eac72a1bf98e2197fc2d73a40d1a07c6&redirect=http%3A%2F%2Fwww.duiba.com.cn%2Fguess%2Findex%3Fid%3D1448004&timestamp=1469590624828

用户唯一标识:uid

兑吧通过用户标识uid来识别是哪个用户参加的活动,从而发放奖品给参加活动中奖的用户。

开发者可以根据自身的需求情况,可在以下两种方式中选择。

  1. 以设备号为用户标识
    • 优点:游客可直接参与活动,提高了流量流入。技术上也不用对接唤起登录的功能,方便简单。
    • 缺点:只有在原生的app中才能获取到设备标识,有一定的局限性。
  2. 以开发者的用户id作为用户标识
    • 优点:除了原生app,其他各个场景都可获取到用户标识,提高游客的注册量。
    • 缺点:需要额外对接唤起登录功能。请参考文档 游客(未登录用户)唤起登录

results matching ""

    No results matching ""