《团800 CPS平台接入说明.docx》由会员分享，可在线阅读，更多相关《团800 CPS平台接入说明.docx（7页珍藏版）》请在金锄头文库上搜索。
1、团800 CPS平台接入说明目录一、简介1二、团800 CPS平台流程介绍2三、团800 CPS平台接入接口33.1 团800 CPS平台进入团购网站的接口（见Figure 1 - A）33.2 团购网站向团800推送订单信息的接口（见Figure 1 - B）43.3 团购网站向团800提供的订单查询接口（见Figure 1 - C）53.3. 1接口说明53.3.2 交易查询结果数据格式5一、 简介本文档对“团 800 CPS平台”的接入方式进行介绍。“团800 CPS平台”是团800为广告主提供的，以CPS方式计费的广告系统。接入“团800 CPS平台”的广告主（以CPS方式在团800
2、CPS平台上购买广告的客户）需要依据团800 CPS平台的规范，对自己的网站进行相应的开发，以便顺利接入团800的CPS系统，并且完成相应的业务功能。本文档第二部分介绍团800 CPS系统和广告主网站之间的工作流程；第三部分介绍各广告主需要完成的接入接口，第四部分说明相应的技术支持方式。二、 团800 CPS平台流程介绍团800 CPS平台和广告主网站的交互过程如下图所示：Figure 1团800 CPS平台和广告主网站交互示意图如Figure 1所示，团800 CPS平台和广告主系统的交互存在3个接口：A 当用户点击团800 CPS平台上的广告时，进入广告主的系统的入口页，同时会以URL参数
3、的形式，将相应的信息带入广告主的网站。B 广告主的网站需要记录这些参数，并且在用户产生购买行为的时候，根据团800定义的规则，以URL参数的形式，访问团800指定的URL，以便回传相应的信息给团800。C 广告主的网站同时需要提供一个查询接口，供团800 CPS系统查询相应订单的状态，以便和广告主进行对账等工作。广告主需要完成上述A/B/C三个接口。其具体的接口定义如本文档第三部分所示。三、 团800 CPS平台接入接口为便于说明 我们假定合作团购网站的站点是http:/ 团800 CPS平台进入团购网站的接口（见Figure 1- A）团购网需支持用下述两种方式之一来接收来自团800的流量：
4、1. 跳转url形式访问团购网的站点http:/ =e1324380f80ba3acd3cd4a8099fbed9f&url=http:/ 非跳转url形式访问团购网的站点http:/ =e1324380f80ba3acd3cd4a8099fbed9ftrack.page为合作团购网站的跳转页面some.page 为合作团购网站上的到达目标页面参数说明：参数名类型描述是否必填备注srcstring来源是tuan800 (默认标识)cidint推广标识是团800网的推广方式id，在某些推广活动中，比如特定的页面或者通过联盟推广的页面，设定了该参数。如果没有设定推广的页面，则设置该参数为0。wis
5、tring合作推广站点的信息是该参数经过base64编码，合作团购网站无需转码，须原样回传给团800。uidString团800网的用户id是为32位的uuid，当用户未登录是，可以使用匿名用户的idurlString目标页面在合作团购网站上的目标页面，包括目录页、单品页、专题页要求：a) 团购网需记录src、cid、wi、uid，在用户生成订单后，将实时订单数据及来源参数存入数据库（或文件）中，并为团800提供订单查询。b) 设置广告效果认证期（RD认证期）说明：用户第一次通过团800的链接跳转到了团购网网站，在一段时间之后，第二次没通过团800广告链接，而是直接登陆团购网网站去下了订单。此
6、时产生的业绩也属于团800。当超过此段时间后，直接登陆团购网网站下的订单将不算作团800的业绩。这个时间段称为RD认证期。团购网方面需要在程序中按合同内容设定效果认证期（RD认证期）。一般为30天。可通过cookie方式实现。当用户点击广告到达团购网的网站时，可将src、cid、wi，uid的值存入客户端cookie，有效时间设为30天。用户下单时，团购网的程序去客户端查看cookie中有无团800cookie信息，如有则该订单就是团800带去的订单，将src、cid、wi,uid和订单数据一起存入数据库（或文件）中。3.2 团购网站向团800推送订单信息的接口（见Figure 1 - B）当
7、用户在团购网下订单后，由团购网回调cps系统的实时返还交易数据的接口把交易数据回传给团800。接口：http:/ CPS系统中的唯一标识是32位uuid字符串cidInt团800活动标识是来源于接受CPS参数的接口中参数cidwiString合作推广站点的信息是来源于接受CPS参数的接口中参数wiuidString团800的用户id是32位uuidonString订单编号是合作团购网站内的订单编号taInt订单数量是订单数量1ppint订单总价是扣除其他费用的订单金额（有效金额单位分）sdlong下单时间是格式：时间戳 1285813236000statusInt订单状态是与CPS接口中的状态
8、一致: 0：新下订单（NEW） 1：订单已付款(PAY)2：已出货(SHIP)3：已收货(SHIP)4：订单确定（收到货且过退货期, NEW）5：订单取消或退货(FAIL)encodingString编码方式否默认utf-8编码signString数字签名是为了保证cps接口不被恶意使用，需要提供加密保护，生成规则为：md5(sk|cid|wi|uid|on|ta|pp|sd|status |siteKey|siteSecurity)在计算md5时请使用UTF-8编码t_commint佣金总额否整个订单的佣金总额（单位分）p_cdString该订单中商品详细列表是p_cd=商品1编号|_|商品
9、2编号|_|priceString该订单中商品详细单价是price=单价1|_|单价2|_| , it_cntString该订单中商品详细数目是it_cnt=数量1|_|数量2|_|commString该订单中商品详细佣金是comm=佣金1|_|佣金2|_| , c_cdString该订单中商品详细分类是c_cd=分类1|_|分类2|_| , 注：以GET请求发送数据，返回值说明：0=正确插入参数，1=缺少必要参数，2=参数格式错误。合作方团购网站我方均会给其颁发siteKey, siteSecuritysign的用法：根据sk（即团800给其分配的siteKey）查询到合作团购网站的site
10、Security，使用接收到的参数按照sign的规则生成后，和传递过来的sign参数值进行比较，如果相同则认为有效3.3 团购网站向团800提供的订单查询接口（见Figure 1 - C）合作团购网站需要提供一个查询一段时间内发生状态变化的订单的接口3.3. 1接口说明http:/ 查询开始日期是格式为 YYYY-MM-DDedString查询结束日期否格式为 YYYY-MM-DDsignString数字签名是为了防止非授权用户访问查询接口，我们通过sign来确认这是一次合法的访问。md5(src|cid|d|ed|siteKey|siteSecurity)在计算md5时请使用UTF-8编码合
11、作方团购网站我方均会给其颁发siteKey, siteSecuritysign的用法：当合作方团购网站接收到查询请求时，使用tuan800给其分配的siteKey，siteSecurity就可以计算出：Md5(src|cid|d|ed|siteKey|siteSecurity)，将其生成的字符串sign比较，如果相同，则说明该次查询有效。3.3.2 交易查询结果数据格式1、 txt文件格式,：不带有任何HTML标记的纯文本文件，每行一条条记录内字段使用|作为区分，用n换行格式：下单时间|订单编号|订单金额|佣金总额|状态|WI|CID|订单详细信息2011-05-10 10:23:12|201
12、10708211852|29823|999|4|WI|c5ee1e3020cb45a8b050939796c8f9ce|4103|p_cd=43283|_|47938|_|&title=稻香村|_|大闸蟹|_|&price=91520|_|31963|_|&it_cnt=1|_|2|_|&comm=586|_|895|_|&c_cd=0|_|7|_|字段实例说明是否必须下单时间2011-08-03 11:33:22用户下单的时间是订单编号由商家系统定义是订单金额10000订单有效金额(单位分)是佣金总额999佣金总额(单位分)否状态与CPS接口中的状态一致: 0：新下订单（NEW） 1：订单已付款(PAY)2：已出货(SHIP)3：已收货(SHIP)4：订单确定（收到货且过退货期, NEW）5：订单取消或退货(FAIL)是WI联盟编号是CID如3.1节所述的接口中，团800传递给团购站的cid。是订单详细信息p_cd=商品1编号|_|商品2编号|_|&title=稻香村|_|大闸蟹|_|&price=单价1|_|单价2|_|&it_cnt=数量1|_|数量2|_|&comm=佣金1|_|佣金2|_|&c_cd=分类1|_|分类2|_|该订单中货品的详细信息(所有金额的单位都是分)是
