维易淘客联盟接口开发文档:淘客渠道接口

淘宝联盟渠道接口:渠道ID用法及如何绑定客户

淘客渠道接口包含:

1、淘宝客邀请码生成接口

2、淘宝客渠道信息备案

3、淘宝客信息查询

【调用权限】核心接口会员卡可用。


以上三个接口官方文档参:http://open.taobao.com/api.htm?docId=37988&docType=2&scopeId=14474 


一、渠道接口的作用——了解是哪一个客户下的订单?

渠道接口用于创建渠道ID,以标识每一个客户的身份,方便跟踪和统计是哪一个客户的订单。

通过渠道API,你的客户(淘宝号)在你的联盟号下创建了可以标识他的渠道ID,

这个ID是你的客户在你的淘宝联盟帐号唯一的身份标识码。相当于每个人在国家数据库中注册的身份证号。

渠道ID一旦创建了,不可删除。

有了客户的渠道ID后,那如何用渠道ID识别客户?

1、客户下单前:使用高佣转链接口,通过传送“渠道ID+渠道专属PID”参数进行高佣转链(2个条件缺一不可,不是用普通PID),如果你用的是会员ID,则必须用“会员专属PID”。


2、客户下单后:在订单接口中指定order_scene参数为2或3,获取到该渠道ID或会员ID,就可以知道哪一个客户下的订单。


以上2步具体参考高佣转链接口,以及订单接口。本篇接口讲的是如何创建生成渠道ID


二、谁可以使用渠道接口?

当您向淘宝联盟申请渠道权限和渠道API后,联盟会隔周审批给你,如果你条件达到,联盟会把权限和API都发放给你,你有自己的渠道API就不需要再使用本站的渠道接口。

如果你是新淘客,或条件还不达标(参考下面附文系列),联盟一般只会审批给你渠道权限,但不发放渠道API给你,这时您需要使用这里的接口。那如何判断自己有渠道权限或API?

1、怎么看自己有渠道权限了?

渠道权限就是您可以使用渠道ID来推广产品的权限,如果您没有渠道API,那么可以手动推广,也可以借助维易第三方渠道接口来实现自动化运营。当你申请了渠道后,隔一周联盟如果通过了,你的联盟号中会出现如下版面,就说明已经有渠道权限了。

同样,如果出现会员运营管理版块,就有会员运营权限。

【名词说明】

“合作方”:当你申请到了以上权限时,你的这个联盟帐号就是“合作方”——即已经具备了让别人成为你的渠道的能力的联盟号。这时你这个联盟帐号不能再申请成为别人的渠道ID了。否则接口会报错“您已经是合作方”。

更多请阅读下面系列文章介绍。


【注意】如果您没有申请到该权限而调用渠道API,就会提示"授权用户未入驻!",您必须先申请到权限。

申请地址: 登录淘宝联盟官网pub.alimama.com——推广管理——渠道管理下申请

请务必阅读以下《入门必读》文章系列


2、怎么看我有渠道API?

渠道API是用于实现在你的APP或网站等程序中自动帮客户生成渠道ID。

首先你要在淘宝联盟推广管理下创建网站应用,然后去申请渠道时,提供该应用的APPKEY,如果隔周联盟审批同意,那么请到开放平台(https://open.taobao.com/)下应用管理中查看该appkey的应用,

是否有“淘宝客【公用】私域用户管理”API组,

如果有,那么你就可以直接调用自己的API,而不需要使用维易渠道API,如下图:


该API有目标考核,如果没达标,可能会被收回。

如果没有这个API,那么需要借助维易渠道API开发。


3、什么是渠道邀请码渠道专属PID会员专属PID

当您拥有渠道权限后,就可以生成渠道邀请码(生成渠道ID时要用到),并需要了解什么是渠道PID和会员专属PID,如图:

(1)渠道专属PID:在如下图位置创建的PID即属于“渠道专属PID”:

同样,在“会员运营管理”下,也会看到创建会员专属PID创建。

(2)渠请码:

进入渠道管理,点下图“获取链接”,就可以看到你的渠道邀请链接:

如:

https://mos.m.taobao.com/inviter/register?inviterCode=C1CTEA&src=pub&app=common

其中C1CTEA就是你的邀请码,它不会变化,是固定的,后续不管是手动渠道备案,还是用API备案,所用的邀请码都是固定的,不需要每次调用渠道API去生成邀请码。


三、渠道入门必读:

以下系列附文为你详细讲解渠道专项知识。新手可能会觉得复杂,其实它的流程很简单:

在你申请到了渠道权限了(参考上面)后,按以下流程操作即可:

1、客户授权:让你的客户使用他的淘宝号进行授权(H5网页)。获取授权返回的参数(授权码sessionkey,userid等)。注意:授权后获得授权码并生成了渠道ID后,则授权就没有用处了,后续不需要再定期授权。

2、生成渠道ID:授权后你再用客户的授权码调用渠道私域API,配合您的邀请码,创建该客户的渠道ID。你的客户一旦在你的联盟号下创建了渠道ID,就不能注销这个渠道ID,也不会过期,如果是会员运营则授权后即可,不需要调用API。此外,生成渠道ID或会员运营ID后,也不需要每个月让客户都授权再生成,一次授权后生成渠道ID,永久保持。

3、渠道ID使用:第2步生成该客户的渠道ID后,你就可以用它识别该客户,在高佣转链时传递渠道专属PID和渠道ID。或传会员专属PID,这样下单后,订单中就有他的渠道ID或会员ID返回。具体参考高佣转链文档和订单文档。

【注】

如果是APP授权,需要先用百川SDK唤醒淘宝APP,实现免帐密,再通过百川调用H5授权,就不需要输入帐号和密码。

更详细内容请参考以下系列文章。

如果您还不了解渠道,请勿必花点时间看下面系列文章:


新手必看:《渠道管理和会员运营管理》新规专题系列:

 1.如何使用渠道ID和会员运营ID的API绑定客户
http://wsd.591hufu.com/taokelianmeng/384.html 

2.新规下如何使用高佣转链和查订单接口?
http://wsd.591hufu.com/taokelianmeng/386.html 

3.如何在商业模式中应用新政策,做好返利和加盟商运营?
http://wsd.591hufu.com/taokelianmeng/387.html 

4.如何使用渠道ID和会员运营ID的API跟踪客户订单?

http://wsd.591hufu.com/taokelianmeng/398.html 


5.微信公众号怎样让客户授权?如何使用rtag参数让客户备案?

http://wsd.591hufu.com/taokelianmeng/411.html 


附:淘宝客渠道管理和会员运营时如何授权?
http://wsd.591hufu.com/taokelianmeng/385.html    


维易渠道接口使用流程:

1、首先要生成您的邀请码(当您生成一个邀请码以后就固定了,不必每次重新生成邀请码)。

2、再用邀请码帮助您的渠道方(客户)进行备案。

使用本工具接口,您和您的渠道方都要授权给维易,即您发给客户的授权链接是维易的,参考下文。


附:

(2020-05-06)【淘宝联盟官方通知】淘宝客私域用户管理能力升级 

http://wsd.591hufu.com/taokelianmeng/470.html


四、渠道接口:

(一)淘宝客邀请码生成接口:

【特别提示】

TIP1:一个合作方的联盟账号,都只有一个固定的邀请码,当您已生成过邀请码后,可保存起来下次使用,不必重复生成。比如保存到后台设置项中。第2次可以直接取出保存的邀请码再复用。

TIP2:因为邀请码是固定的,所以推荐直接到你的联盟后台复制邀请码(如果你不懂在哪复制邀请码,请参考上文图解),不推荐使用本接口生成。

接口:

http://api.vephp.com/invitecode?vekey=xxx&code_type=x&其它参数=..

参数:

    accesstoken :可选,限多用户版使用,合作方给维易的授权码,单用户版已经维易后台授权了,就不需要本参数。

                            多用户版如何使用参考后面。

    code_type:可选,默认1。可选的邀请码类型:1 - 渠道邀请,2 - 渠道裂变,3 -会员邀请

    relation_app:可选,表示渠道推广的物料类型,外部媒体调用可统一填写 common 类型

    relationId:可选,默认为空,渠道关系ID。示例值:1231512

参数使用说明:

一般code_type不设置或设为1即可,如果要设置为2(裂变),这时可以和relation_id参数配合使用,指定上级的relation_id。但目前联盟对裂变还没处理,无法查询上下级关系,因为裂变还没有意义。

【必知】

 对调用维易渠道接口的,记得您做为合作方不需要再用auth接口授权一次,否则会挤掉维易会员中心的那个授权有效性。
auth是给你们客户(渠道方)授权的,参考下一个备案接口。 



调用示例:

例1:直接生成合作方邀请码:http://api.vephp.com/invitecode?vekey=xxxxxx

例2:带裂变关系生成邀请码:http://api.vephp.com/invitecode?vekey=xxxx&relation_id=12345678&code_type=2


返回值:

成功时返回(inviter_code就是邀请码):

{

    "error": "0",

    "msg": "淘宝客邀请码生成成功!",

    "inviter_code": "C9CTAS"

}


(二) 淘宝客渠道信息备案接口:

生成邀请码后,接下来就可以创建备案了。备案方式有两种:手动和自动。


【特别提示】

如果你是开发APP,在你的APP中使用H5授权时,会要求输入用户的淘宝帐号和密码,用户体验不好。

你可以用百川SDK唤起淘宝APP实现免帐密,再通过百川调用H5授权获取授权码(即以下publishersave接口的accesstoken参数)。

百川具体参考 https://baichuan.taobao.com/  


1、API自动备案:

适合场景:有独立APP等方便授权场景,可用API自动备案。

接口使用流程:

假如你是开发APP的,你有一个联盟帐号A”(这个帐号也是你在维易会员中心授权的那个帐号)已申请过了渠道权限,

假如张三注册成为你的APP用户并且他有一个淘宝帐号B”(B不能申请过渠道的,如果B已经有渠道权限,需要让张三换一个淘宝号)。

要怎么样使用 publishersave 接口 ,让张三的“淘宝帐号B”成为你的渠道ID?

流程:

1.获得邀请码:到你的联盟帐号A(称为“合作方”)后台复制邀请码,参考上文图解。也可以用invitecode接口生成。

2.张三在你的APP或网站上用联盟帐号B(称为“渠道方”)授权:先用B帐号做H5授权被授权方是维易,授权方法参考下文accesstoken参数)—>从授权中拿到session做为accesstoken参数值—>传给接口publishersave

3.publishersave接口将把B创建为A的渠道ID,调用接口后,可以到你的联盟后台渠道管理下查看是否成功。

【特别说明】

1. APP上请用百川SDK调用,你可以下载花生日记等APP参考他的领券前授权流程。百川唤起淘宝APP后实现免帐密,再用百川调用H5授权。百川用法请到官方钉钉群咨询。

2. 在你开发中,不要为了图省事,把A当成B使用,只用一个联盟号,又是合作方又是渠道方。这样无法成功,并且因为你用A帐号授权,导致维易会员中心的A授权过期失效。

3. 如果你收到提示“你已经是合作方了”,请检查B是否已经申请过渠道并成为合作方了,出现这种错误只能把B更换成一个没有申请过渠道的帐号。

接口:

http://api.vephp.com/publishersave?vekey=xxx&inviter_code=邀请码&其它参数=..

参数:

    accesstoken :必选,您的客户(即要成为你的渠道方)授权给维易,进行授权后得到的access token值。

                                      如何授权?参考 http://wsd.591hufu.com/taokelianmeng/391.html 

    inviter_code :必选,淘宝客邀请渠道的邀请码。使用淘宝客邀请码接口生成或到你的联盟后台手动复制。

    relation_from:可选,渠道备案来源,取链接的来源。

    offline_scene:可选(默认1),表示渠道备案 - 线下场景信息:1 - 门店,2- 学校,3 - 工厂,4 - 其他

    online_scene:可选(默认1),表示线上场景信息:1 - 微信群,2- QQ群,3 - 其他

    info_type:可选(默认1)。指渠道类型,

    register_info :可选(是否需要本参数,取决于备案类型):当你的邀请码备案是用“线下门店”和“线下个人”,请提供本参数,否则会提“省(province)为空 ”等错误,推荐使用“通用备案”。参考:http://wsd.591hufu.com/taokelianmeng/489.html

    note : 可选,媒体侧渠道备注信息。一般不要使用本参数,很容易出现“备注信息包含非法”而出现接口调用失败。


调用示例:

http://api.vephp.com/publishersave?vekey=xxx&inviter_code=C9CTAS&accesstoken=700021001....36

备案成功后,可以在联盟后台查看到该客户的渠道ID,如图:


返回值:

1、注意:如果使用本接口备案会员运营ID时,该会员联盟号不能是申请过合作方,否则会返回如下信息:

{

    "error": 15,

    "msg": "合作方不能成为粉丝"

}


2、其它返回错误信息时,如:

{

    "error": 27,

    "msg": "session key非法"

}


2、返回成功时:

{

    "error": "0",

    "msg": "淘宝客渠道信息备案成功!",

    "data":{

            "relation_id":40232,

            "account_name":"xxx",

            "special_id":32304,   //此项值新版已被联盟取消

            "desc":"绑定成功"

     }

}


返回值字段含义:

relation_id:渠道关系ID,如:509783191

account_name:渠道昵称,一般是淘宝帐户名

special_id:会员运营ID,如32304

desc:结果描述,如“绑定成功”,如果重复绑定会提示:”重复绑定渠道“或”重复绑定粉丝“


2、手动备案:

适合场景:微信公众号,微信机器人等客户备案。本接口主要是帮您生成淘口令,让客户复制后,打开手机淘宝APP就可以备案。

接口:

http://api.vephp.com/publishertkl?vekey=xxx&inviter_code=XXXX&rtag=xxx&text=超级会员备案&pic=...

参数:

inviter_code  必选,你的邀请码,每个联盟号是固定的。

rtag 必选,你用于标识该客户身份的标识,它必须是在你的数据库中唯一的。

text 可选,默认值“开始会员备案”:淘口令提示标题,在淘宝APP中弹出时显示。

pic 可选,淘口令图片,默认图地址 http://wsd.591hufu.com/public/images/mba.png


【说明】

rtag 参数定义为字符串形式,不超过100个字符.

渠道打开淘口令,或链接,页面展示无变化,rtag不会透出给渠道。

注意:在拼接和发放邀请链接过程,一定要注意避免链接随意传播,确保备案的渠道对应到具体要迁移人的原始身份。同时官方为了减少这样的错误出现,针对拼接了rtag的备案页面,做了有效期限制,当渠道成功备案后,该页面立即失效,无法二次备案使用。


【返回值】

{

    "error": "0",

    "msg": "淘口令生成成功",

    "tbk_pwd": "¥A2fPbCDRF1E¥"

}


生成结果中,客户复制tbk_pwd字段的淘口令,后续操作详情,参考 http://wsd.591hufu.com/taokelianmeng/411.html  


(三) 淘宝客信息查询接口:

本接口用于查询合作方名下所有的渠道关系。

接口:

http://api.vephp.com/publisherget?vekey=xxx&info_type=x&其它参数=..

参数:

    accesstoken :可选,限多用户版使用,合作方给维易的授权码,单用户版已经维易后台授权了,就不需要本参数。

    info_type:可选,默认1,可选值含义:1:渠道信息;2:会员信息(比价查询sid时要用)

    relationId:可选,渠道关系ID。如果指定本值,则只查询该渠道ID的信息,而不是查您联盟号下全部渠道关系。

    relation_app:可选,默认“common”,渠道推广的物料类型

    page : 可选,分页码,默认1

    pagesize:可选,每页展示数,默认10

    special_id:可选,会员运营ID

    external_id:可选,淘宝客外部用户标记,如自身系统账户ID;微信ID等


调用示例:

http://api.vephp.com/publisherget?vekey=xxxx&info_type=1

查询会员的比价授权后的sid:

http://api.vephp.com/publisherget?vekey=xxxx&external_id=mymem00001&info_type=2

返回值:

成功时返回:

{

    "error": "0",

    "msg": "淘宝客信息查询成功!",

    "data":{            

              //返回值参考下文字段含义说明

     }

}


【data中返回字段含义】

root_pid_channel_list:  渠道专属pidList,例mm_1_1_1

total_count:  总记录数

inviter_list:  渠道列表,包含以下字段:

relation_app: 渠道备案 - 渠道推广的物料类型

create_date: 渠道备案 - 备案日期,如2018-06-01 11:12:23

account_name: 渠道备案 - 渠道昵称

real_name:    渠道备案 - 渠道姓名

relation_id :渠道备案 - 渠道关系ID

offline_scene:  渠道备案 - 线下场景信息,1 - 门店,2- 学校,3 - 工厂,4 - 其他

online_scene:   渠道备案 - 线上场景信息,1 - 微信群,2- QQ群,3 - 其他

note: 媒体侧渠道备注信息

root_pid :渠道专属pid



五、维易多用户版如何使用维易渠道接口帮客户备案他们的渠道方?

多用户版一般是用于做平台,或开发软件销售等:

如果你是类似花生日记这样APP,那你是平台方,

如果是卖软件给你的客户或甲方委托你们开发APP,你的功能也相当于平台方,

因此,为了便于理解以下内容,我们以平台方来统称以上2种情形。


你是平台方时,你要帮你的加盟商或委托你们开发软件的甲方客户(统称他们为渠道新规中的“合作方”, 以下简称您的加盟商、代理商或乙方为“合作方”)备案他们的渠道方,那流程是:

1、你的加盟商、代理商或甲方他们本身联盟帐号需要先向阿里妈妈申请成为“合作方”,即渠道管理或会员运营权限。

     权限申请地址:  https://survey.taobao.com/apps/zhiliao/0JpI9eizU     


2、使用维易授权接口获得授权链接,然后把链接给合作方授权后得到的session。

     【如何授权?参考 http://wsd.591hufu.com/taokelianmeng/391.html 】

     把获得的授权码传给维易渠道接口中invitecode接口的accesstoken参数,得到合作方的邀请码,这个邀请码可以复用。不需要每次都生成,您帮合作方保存即可,下次先检查合作方是否有邀请码,如有则跳过这一步。


3、再让合作方的客户也使用第2步中的授权链接,也授权给维易,得到这个客户的授权码,发给维易publishersave接口的accesstoken参数,从而创建渠道备案,获取该客户的relation_id。

整个过程的要点时:

让合作方和他的客户都使用维易授权链接进行授权,这样才能使用维易接口帮他们处理。

请按上面流程操作,如有渠道问题,可联系客服。

 

客服