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

淘客渠道接口

淘客渠道接口包含:

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

2、淘宝客渠道信息备案

3、淘宝客信息查询

【调用权限】全能卡会员可用。

当您的日订单在100单以下,不建议使用渠道关系,推荐使用旧方案,参:http://wsd.591hufu.com/taokelianmeng/265.html 


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


《渠道管理和会员运营管理》新规专题参考:

 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、再用邀请码帮助您的渠道方(客户)进行备案。

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


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

一个合作方的联盟账号,都只有一个固定的邀请码,当您已生成过邀请码后,可保存起来下次使用,不必重复生成。

第2次可以直接取出保存的邀请码再复用。

接口:

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就可以备案。

接口:

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  


(二)API自动备案:

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

接口:

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)。指渠道类型,

    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:结果描述,如“绑定成功”,如果重复绑定会提示:”重复绑定渠道“或”重复绑定粉丝“


三、淘宝客信息查询

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

接口:

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

参数:

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

    info_type:可选,默认1,表示渠道备案

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

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

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

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


调用示例:

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

返回值:

成功时返回:

{

    "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://tsw.taobao.com/task/questionnaire.htm?taskId=16799      


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

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

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


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

整个过程的要点时:

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

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

 

客服

关注