回调任务完成通知协议说明

特别声明
1.本文档仅针对已经接入支付,且已上线QQ空间的应用使用。
2.本协议说明用于实现交叉推广任务集市V2版本买方应用开发说明中的Step4;买方答复平台查询任务完成状态请求,详见这里)。

目录

1 任务完成查询说明

任务完成查询接口由买方应用在管理中心创建任务时填写(详见:任务发布)。
该功能由买方应用实现,用于提供给平台回调。当用户点击“去做任务”按钮后,平台将回调该接口向买方应用发出任务完成状态查询请求,买方应用将任务完成状态返回给平台。
买方应用请按照下列协议进行任务完成通知的开发。

本操作属于整体流程中的第6步:
cross_spread_v2_12.png

2 协议参数

请开发者特别关注:
平台后续可能对协议进行扩展,因此请不要将参与签名的参数写死。
计算签名时,请以每次接收到的参数为准,接收到的所有参数除sig以外都要参与签名。

参数名称 类型 描述
openid string 根据APPID以及QQ号码转化得到的ID。与应用通信的用户key,跳转到应用首页后,URL后会带该参数,访问OpenAPI时必需。
appid string 应用的唯一ID。可以通过appid查找应用的基本信息。
pf string 跳转到应用首页后,URL后会带该参数,表示应用的来源平台。由平台直接传给应用。
ts string linux时间戳(从UTC时间1970年1月1日00:00:00到当前时刻的秒数)。
version string 协议版本号,由于基于V3版OpenAPI,这里一定返回“V3”。
contractid string 交叉营销任务集市V2版本中,任务发布成功后系统分配的唯一ID。
sig string 请求串的签名,由需要签名的参数生成。

(1)签名方法请见文档:腾讯开放平台第三方应用签名参数sig的说明
(2)按照上述文档进行签名生成时,需注意回调协议里多加了一个步骤:
在构造源串的第3步“将排序后的参数(key=value)用&拼接起来,并进行URL编码”之前,需对value先进行一次编码 (编码规则为:除了 0~9 a~z A~Z !*() 之外其他字符按其ASCII码的十六进制加%进行表示,例如“-”编码为“%2D”)。
(3)以每笔交易接收到的参数为准,接收到的所有参数除sig以外都要参与签名。为方便平台后续对协议进行扩展,请不要将参与签名的参数写死。
(4)所有参数都是string型,进行签名时必须使用原始接收到的string型值。

3 请求示例

下面演示了sig签名的生成细节。开发者可以下面的示例来验证sig的详细过程,但不能直接复制。

第一步: 买方应用接收后台发送过来的查询任务完成状态请求
该请求通过后台发送,因此所有参数都未进行URL编码。但是该请求中所带的sig却进行了URL编码(这一点请开发者关注,在回调协议中这里比较特殊)。
请求示例如下:
http://IP:9001/<font color="red">cgi-bin/check_completion</font>?appid=15499&openid=0000000000000000000
0000014111111&pf=qzone&version=v3&contractid=10&ts=1331561610&sig=jQbqINCK1HW%2FJST7D5VwSvjfjCg%3D

特别提示
1. 示例中的IP即买方在“我是买家”的“填写任务信息”页面中配置的任务完成查询接口对应的服务器IP。
2. 示例中的红色部分为买方应用在任务完成查询接口中自定义的部分(详见任务发布)。

第二步: 应用对该请求进行解析,根据得到的请求源参数来计算sig
对上面的请求进行解析,得到源参数如下:

method: GET
url_path: /cgi-bin/check_completion
假设appkey为:123456789876543


请求源参数以及对应的值为:
(注意:请以接收到的参数为准,除sig外的所有参数都需要参与签名。请仔细核对,如果拆分结果不对,则后面的步骤都是错误的。)
appid : 15499
openid : 00000000000000000000000014111111
pf : qzone
version : v3
contractid : 10
ts : 1331561610
在回调发货协议中,在进行签名生成时,回调协议里多加了一个步骤: 
在构造源串第3步之前(sig生成通用步骤说明详见这里),需对value先按照如下编码规则进行编码(注意这里不是urlencode):
除了 0~9 a~z A~Z !*() 之外其他字符按其ASCII码的十六进制加%进行表示,例如“-”编码为“%2D”。

本请求中不含有需要进行编码的字符,此步骤不需要做。


执行构造源串的第3步:“将排序后的参数(key=value)用&拼接起来,并进行URL编码”(sig生成通用步骤说明详见这里)。


则源串为:GET&%2Fcgi-bin%2Fcheck_completion&appid%3D15499%26contractid%3D10%26openid%3D0000000000000000000
0000014111111%26pf%3Dqzone%26ts%3D1331561610%26version%3Dv3


密钥为:123456789876543&


根据HMAC-SHA1加密算法将源串以及密钥进行加密,然后对加密后的字符串经过Base64编码后,得到的Sig的值。

生成的签名为:jQbqINCK1HW/JST7D5VwSvjfjCg=



第三步: 应用将自己生成的sig与腾讯支付后台发送的请求中的sig进行比对
注意: 应用接收到的腾讯支付平台发送过来的请求后,请先对请求中的sig值做一次URL解码;
然后再将解码后的sig值与应用自己生成的sig值进行比对。
在PHP中,通过$_GET['sig']获取sig值,PHP语言本身对sig值进行了URL解码,不需要再次解码。

如果sig值一致,表示该请求合法,应用可以处理该请求并将任务完成状态返回给后台。

4 协议返回包

应用的返回包应该包含如下参数:

ret: 返回码。

msg: 错误信息。

zoneid: 玩家完成任务所在对应游戏的分区ID号,用于发放奖励(如果不返回,则平台默认给玩家发放奖励到zoneid为0所对应的游戏分区)。


5 协议错误码

应用的错误码应该从0开始,按照整数递增的方式进行定义,建议应用按照如下描述定义错误码:


0: 成功

1: 系统繁忙

2: token已过期

3: token不存在

4: 请求参数错误:(这里填写错误的具体参数)


6 返回示例

正确返回示例:

Content-type: text/html; charset=utf-8
{
"ret":0,
"msg":"OK",
"zoneid":"1"
}

错误返回示例:(开发者返回给平台的错误码一定要控制在1-200的正整数之间,否则系统会报错。)

Content-type: text/html; charset=utf-8
{
"ret":4,
"msg":"参数错误"
}


相关文档

上一步:v3/pay/inform_task_completed

下一步:回调任务集市V2发货URL协议说明

其他相关文档:交叉推广渠道简介_V2 | 交叉推广常见问题

以上信息是否解决您的问题?

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部