【API通用原则】

1、本站所有接口都是基于utf-8编码，当您的网站等应用是gbk等编码，请转码后发送。

2、所有接口返回值均为JSON。没有xml等格式。

3、全站接口，如无特别说明，均为 GET 请求

一、全能高佣转链接口介绍：

维易万能转链接口，几千的客户不断反馈，5年多时间的沉淀！

全面处理各种奇形古怪的参数，简单暴力好用的接口，简化你的程序，提高你的成交机会！

高佣转链接口，帮您获取淘客联盟最高佣金比例，并自动帮您申请定向计划，帮您多赚更多。

唯易高佣接口和普通高佣金转链接口区别：

1、全面的参数处理能力：近5年的沉淀，可以处理几乎所有的场景参数，除了id转高佣链，淘口令转淘口令（含解密功能），各种链接（二合一、产品链、短链接、天猫链等）转淘口令。一个接口搞定各种情形，大大简化你的程序。

2、自动二次处理无券产品：对无券商品自动转高佣链接。普通接口对无券产品生成的是错误的二合一链接，跳转后提示优惠券已失效，影响用户体验。

3、兼容商家合作券和店铺券：有的商品在联盟中没有优惠券，接口可以兼容该商品其它优惠券，比如商家合作券或店铺券。

4、支持淘小铺、淘礼金等十几种特殊产品链接解析：更强大的解析能力，最大程序避免您的生意流失。

5、支持生成微博防拦截的淘客链接功能。使用该功能，可生成防止微博挡截的链接，把它发到微博上，不会被微博屏蔽，也不需要再交纳50%佣金给微博（需另外白名单域名）。

6、优化BUG：官方高佣接口在多张券时出现的有时优惠券不可用的BUG，本接口已优化。

高佣金转链接口使用注意事项：

高佣转链接口包含：id转高佣淘口令、淘口令转淘口令、各种链接转淘口令......等几乎所有应用场景。

但是使用高佣转链前，请务必完成帐户升级（可委托本站帮忙升级），为什么？

1、如果您的联盟帐号是初级的，那么联盟的所有商品只给您一种佣金可选，因此用高佣接口没有意义。

2、如果你的联盟帐号升高级后，联盟会把商品所有可选的1-4种佣金开放给你选择，这时使用本站高佣转链API，就可以从这几种佣金中取最高一个。这时高佣转链API才有意义。

二、接口地址（调用方式 GET）：

高级高佣请直接使用第1种全能转链接口（hcapi），一个接口搞定所有形式。

以下高佣接口全部使用GET方式调用：

【接口请求方式】GET或POST方式 

【万能转链】高级高佣全转链接口（id,淘口令,链接转淘口令）： hcapi

此API全能处理各种转链需求，比如id转链高佣、链接转高佣等等。

使用权限：核心接口卡、超级卡、高级版使用

http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=产品ID或淘口令或链接等各种参数（urlencode编码）...&pid=其它可选参数，参后面第3节

以上参数是主参数，更多参数请参考下节。

本接口参数 para 可传参数类型（请做urlencode编码后传参）：

（1）淘宝产品id：比如 557662422568 或直接产品链接 //item.taobao.com/item.htm?id=...

（2）二合一链接：比如 https://uland.taobao.com/coupon/edetail?e=...

（3）s.click.taobao.com 长和短链接，比如 https://s.click.taobao.com/M9CMYLw 

（4）天猫的长淘口令：如￥TMcPKOfd03nu2TM￥ 【手机天喵】

（5）天猫的喵口令 如 http://zmnxbc.com/s/YJk6Z

（6）手淘APP的分享链接：http://m.tb.cn/h.WDXp8bv

（7）别人的淘口令：如 ￥40pM0yyztET￥，或手淘分享链接文本直接传参数。

（8）新浪短网址，百度短网址封装的淘宝链接：http://t.cn/E6jP2DJ

（9）淘礼金淘口令解析功能：含旧版淘礼金和新版淘礼金口令

（10）其它十几种不常见的淘客链接，如 淘小铺、火聚手、以及多类型的点击串解析：如 $j5WW1aZsqQi$

（11）手淘上分享的内容直接做参数传参数。 如：

【langtian浪天电动牙刷成人款家用非充电式声波自动牙刷软毛防水】http://m.tb.cn/h.WyeyGDw 点击链接，再选择浏览器打开；或复制这条信息￥7TT90t9FVqQ￥后打开手淘

这段文字直接urlencode后传给para参数即可。

hcapi接口不区分以上参数类型，直接传参给para参数即可，接口自动识别

三、接口参数说明：

（一）公共参数：vekey和para 

1、参数vekey：是所有接口必备的，用于验证您调用此接口的权限。

2、参数para：基本包含了所有淘客场景，参前文8种para参数，在辅助接口中，则有对应参数规格要求：。

     （1）在id转淘口令接口中，para要传递产品id

     （2）在淘口令转淘口令接口中，para要传递别人的淘口令，接口将它转为您的淘口令。

     （3）在链接转淘口令接口中，para要传递二合一链接或s.click链接。

（二）其它非必需参数：

完整URL接口地址：

http://api.veapi.cn/tbk/hcapi?vekey=你的vepkey&para=主参数&pid=mm_11_22_33&detail=1&sessionkey=.....&activityId=bdsaf..

1、pid：必选，值为mm_xxx_xxx_xxx。当你在会员中心设置了默认Pid后，如果不需要更换PID，就不需要传递本参数，此时接口默认会调用你设置的pid。当您需要换为同一淘客帐号下的其它pid，那么就传递本pid参数。

如果是多用户版的用户，要注意传的pid参数，必须是对应授权（sessionkey参数）的那个淘宝联盟帐号下的PID，注意不能用联盟号A授权，却用了联盟号B的PID，

【很重要】

（1）当您使用的是渠道ID时，请务必使用“渠道专属PID”。

（2）当您使用的是会员运营ID绑定订单（比如比价时传参数special_id），请勿必使用“会员专属PID”。

2、relationId （注意大小写）：可选，渠道关系ID值，适用于渠道推广场景。普通转链不需要本参数

【注意】使用渠道ID，务必满足2个要点：

1、使用专属渠道PID或会员专属PID。

2、传递relationId参数指定渠道rid。

满足以上两个条件后，转链下单，可用订单接口指定order_scene=2来查询渠道订单。

更多渠道用法参考 http://www.veapi.cn/doc/taokequdaojiekou 

3、special_id（注意大小写）：可选参数，会员运营ID。特别强调：当你传了本参数时，请务必使用“会员专属PID”，这样下单时才有透出会员运营ID。

4、external_id：可选参数，淘宝客外部用户标记，如自身系统账户ID；微信ID等，需要配合渠道接口（publisherget）获取special_id

此参数用法和有关比价说明参考：http://www.veapi.cn/taokelianmeng/490.html

5、detail ： 可选，0（默认值）或1，0或不设置表示不显示产品具体信息。若指定值为1显示产品信息。如果您需要高佣转链接口要返回更详细的产品信息，不需要再去调用其它接口，可以传递detail参数。结果比较参下文“返回值”。

6、activityId：可选值0或自己指定优惠券id，提供本参数后，接口自动在返回的推广链接后面添加该券id，并获取该优惠券信息字段一起返回。本参数和 deepcoupon参数只能使用一个，如果一起使用，则deepcoupon参数失效。

7、deepcoupon：可选值0或1或2：默认值0，当指定1或2时，则接口会对商品进一步检查商家合作优惠券，参数值含义：1-表示对联盟产品无官方优惠券时，则进行检查是否有商家合作券；2-（不建议）表示不管转链的商品有没有券，都进行进一步检查商家合作券，如果商品本身就有单品券，则与检查出来的商家合作券取“券面额大”的一个使用。

注意：本参数和activityId参数二选一，如果一起使用，则以activityId优先，本参数失效。

8、shopcoupon：可选值0或1：默认值0，当指定1时，接口会整合你传递的淘口令或淘客链接的参数中店铺券返回。如果你发现原淘口令中有店铺券，但接口返回没有店铺券，可以加上本参数，则返回值会保持原口令中的店铺券。本参数可以和deepcoupon一起使用。

注意：

（A）当deepcoupon也使用时，以商家合作券优先，如果找到商家合作券，则不再使用参数中的店铺券。

（B）本参数和activityId参数二选一，如果一起使用，则以activityId优先，本参数失效。

（C）使用shopcoupon和deepcoupon参数，调用接口会有一定的效率损失。

【tip】优惠券小知识：三种优惠券：

（1）官方单品券（妈妈券）：转链接口默认就是直接获取联盟商品官方单品券，这类券是商家在联盟后台直接设置的。

（2）商家合作券：这类券是商家和接口平台合作的券，当你添加deepcoupon=1或2时，将会检查这类券。

（3）店铺券：即商家店铺优惠券，全店商品适用，所以当然也可以用于这个商品。这类券在领券页面会看到“店铺购物满XX元可以使用”。

【以下两个参数，会提高您的程序效率】

9、notkl ：可选值【重要】，值为1：接口默认会返回淘口令（tbk_pwd 字段），当您不需要返回值中包含淘口令时，请添加此参数notkl=1取消接口中返回淘口令，这样接口调用效率更高。

10、noshortlink ：可选值【重要】，值为1：接口默认会返回短链接（coupon_short_url 字段），如果您不需要此字段，或自己有淘宝客基础API权限和SDK包，使用本参数取消接口返回短链，并自行按需对返回值中的长链接生成短链，强烈推荐使用本参数，这样可以提高您的高佣接口调用效率。

11、couponId：需要优惠券ID参数,可选值0或1：默认0或不传，不返回转链商品的优惠券ID，如果传了本参数couponId=1则返回优惠券ID（在有券的情况下）。返回值中多了一个字段coupon_id。如果商品无券则coupon_id为空。仅当detail参数为1时，本参数有效。

12、sessionkey ： 淘客授权字串。本参数仅限多用户版，当您的接口卡是多用户版时，如果非默认的帐号调用，比如您的代理公众号调用，则需要传递他的淘客号授权sessionkey 以及该帐号下的pid

13、appkey和secret：应急参数，可选，淘口令生成备用密钥：用于生成淘口令的联盟应用的appkey和secret。【使用场景】默认情况下生成淘口令是用维易自带的appkey生成，但极个别时侯，联盟可能会出错导致淘口令不弹，出现这种情况时，你可以通过这2个参数传递自己的appkey和secret，调用基础API中淘口令生成接口。

【重要】口令不弹应急处理：http://www.veapi.cn/taokelianmeng/491.html

如何申请淘口令生成基础API取得appkey和secret？http://www.veapi.cn/taokelianmeng/492.html

14、tkl_type 应急参数，可选（值1，或0或不填）：可选值0或1，默认0，当指定1时，接口返回的短链接coupon_short_url和淘口令均为无券链接。消费者在购买时，不会跳到二合一页面，而是直接进入详情页。

15、xid 非必选，招商团长专用：团长与下游渠道合作的特殊标识，用于统计渠道推广效果

16、plhc 可选值1或0，默认0，启用高佣批量转链，当启用本参数值1时，参数para必须是商品ID列表，如：

http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=23883488910,598450446711,984504&plhc=1

17、get_topn_rate：可选值0或1，618大促等字段专用，表示是否获取前N件佣金 ,0-否，1-是,其他值-否

18、ucrowd_id：可选，会员人群ID，用于统计人群推广效果

19、mini_program_link ：可选，是否需要获取小程序链接，需要设置1。(暂未对外开放)

20、weibo：可选，默认值为0，可指1或传您自己的域名，使用本参数，将生成微博跳到手淘的防拦截链接，指定值1时，将使用本站提供的域名，如果您自己有域名，可以指定域名，比如 weibo=www.abc.com 或weibo=https://www.abc.com (不传https时默认为http)，您提供的域名必须解析到指定IP，IP地址请联系客服。

21、promotion_type：可选，请按新政策正确传参。可选值：1-自购省，2-推广赚（代理模式专属ID，代理模式必填，非代理模式不用填写该字段）

22、biz_scene_id：可选，不传或值3，本参数只接受动态ID的B段（即您的商品库中的字符型商品ID的B段）转链时传参3。其它不需要传参。

四、返回值：

返回值格式： json

分简略版和详情版。

【如何计算预估佣金】

调用高佣转链接口一般都是在APP等应用的详情页面，这时需要计算预估佣金：

佣金是根据“券后价*佣金比例”预估的，券后价分3步计算（请先熟悉下文返回值）：

1、提取优惠券面额：从优惠券字段 coupon_info 中提取券面额（参考下文返回值），格式都是固定的“满XX元减yy元”，提取YY元就是券面额。

2、计算券后价：用折后价字段 zk_final_price（这个就是商品在淘宝天猫售价，注意不是原价）减去 券面额YY元，“zk_final_price - yy”元就是券后价。

3、计算预估佣金：“券后价 * 佣金比例字段commission_rate”，注意commission_rate是百分比，不是小数，因此该值20表示20%，还需要转成小数。

最后要注意的是，这个是买前预估理想佣金值，实际下单，还要扣除税收、以后可能使用红包导致变低佣等影响，具体参考订单接口。

有关丢单，参考http://www.veapi.cn/taokelianmeng/114.html 

【注意】

1、以下两种返回值都带有已经转化成你的PID的 coupon_click_url 推广链接和 tbk_pwd 和 coupon_short_url 三个值。您可以直接分发给客户使用。

2、返回值中，当产品没有优惠券时，比有优惠券的会少了几个字段，因此你的程序要做判断避免出错，也可以使用result来判断是否有优惠券：

比如在PHP中，要做  if(!empty($re['coupon_info'])){ ...... } 的判断，此字段不存在或为空时，表示该产品没有优惠券。

如果用 result 判断是否有优惠券：1-该产品有优惠券，2-表示该产品无优惠券。

以下是返回值：

【注】优惠券面额从coupon_info中提取，格式都是固定“满XX元减YY元”，提取出YY元即为优惠券面额。

1、当没有detail参数时：如图

（1）有优惠券：

2018年8月20号左右，接口推出最新妈妈券返回值字段，如下面“mm_开头”的字段 ：

详情参 http://www.veapi.cn/taokelianmeng/282.html 

【特别提醒】请务必做好判断是否有mm_开头的字段，并根据你的需要来选择一个优惠券。我们推荐的做法是2种优惠券都展示出来，让你的客户自己选择。

（2）无优惠券：

其中original_uland_link是原始的高佣二合一链接，跳转到领券页后，会提示优惠券领完，

建议使用 coupon_click_url，不会到领券页，而是直接跳到产品页，体验感较好。

这两个字段看自己需要选择。

（3）产品下架或者非淘客联盟产品时返回：

2、当带上detail参数时：如图

【注】优惠券面额从coupon_info中提取，格式都是固定“满XX元减YY元”，提取出YY元即为优惠券面额。

result 表示是否有优惠券：1-该产品有优惠券，2-表示该产品无优惠券

category_id ：分类ID

coupon_click_url ：已转链后的您的二合一链接（有券产品）或s.click链接（无券产品），可直接使用

coupon_end_time：优惠券过期时间 （有优惠券时才有此字段）

coupon_info：优惠券信息，格式都是“满xx元减xx元”（有优惠券时才有此字段）

coupon_remain_count：剩余优惠券数量，当为0时优惠券失效。（有优惠券时才有此字段）

coupon_start_time：优惠券开始时间（有优惠券时才有此字段）

coupon_total_count：优惠券发放总量 （有优惠券时才有此字段）

coupon_id：优惠券ID，当有券时字段不为空（有优惠券且detail参数为1时才有此字段）

coupon_start_fee：优惠券起用金额。比如“满50元减10元”中的50 （有优惠券时才有此字段）

coupon_amount：优惠券面额。比如“满50元减10元”中的10 （有优惠券时才有此字段）

coupon_type：优惠券类型：1 公开券，2 私有券，3 妈妈券 （有优惠券时才有此字段）

num_iid：产品ID

sclick_url：带有佣金但直接跳转到淘宝详情页的链接。适合不想跳转二合一领取优惠券的情形。如果商品无优惠券，那么这个字段值和coupon_click_url值一样。

istaote：是否为淘特商品：0是不是淘特，1是淘特。这决定了返回值中coupon_click_url的链接是跳往淘宝或PC端淘宝，还是跳往淘特APP手机端，淘特链接没有PC端。

tbk_pwd：淘口令，此口令是已转化成你自己PID的口令，可直接使用

ios_tbk_pwd：针对联盟2020-8-31新出的适用于IOS14的淘口令文案。参考http://www.veapi.cn/taokelianmeng/496.html 

global_tbk_pwd：苹果IOS和安卓通用的简化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd

coupon_short_url：短链接，如有QQ推广等场景，已转化成你自己PID的口令，可直接使用。

original_uland_link ： 无券产品的原始二合一链接。（无券时才有此字段，不推荐使用，仅做为原始数据返回，直接使用会提示优惠券失效）

max_commission_rate 常规佣金率：当不入参special_id、relation_id、external_id时，展示常规佣金率(%)

min_commission_rate 最低佣金率：当入参special_id、relation_id、external_id时，该字段展示预估最低佣金率(%)

commission_rate：该产品最大佣金比例，值10表示10%。如果你使用了比价参数external_id，special_id，relation_id时，接口返回min_commission_rate和max_commission_rate，因此字段“commission_rate”将显示为min和max两个字段中最大的一个佣金。

【双11参数——仅双11大促时有】

1、双11期间，增加detail参数时，获取到以下字段：

presale_discount_fee_text： 预售商品-商品优惠信息，如“付定金立减20元”

presale_tail_end_time： 预售商品-付定金结束时间（毫秒）

presale_tail_start_time：预售商品-付尾款开始时间（毫秒）

presale_end_time：预售商品-付定金结束时间（毫秒）

presale_start_time：预售商品-付定金开始时间（毫秒）

presale_deposit： 预售商品-定金（元）

2、双11期间，高佣转链接口返回“ysyl_”开头的字段，是预售有礼字段，

参考https://tbk.bbs.taobao.com/detail.html?postId=9336539

ysyl_click_url  预售有礼-推广链接

ysyl_tlj_face  预售有礼-预估淘礼金（元）

ysyl_tlj_send_time  预售有礼-淘礼金发放时间

ysyl_tlj_use_end_time  淘礼金使用结束时间

ysyl_tlj_use_start_time  淘礼金使用开始时间

ysyl_commission_rate  预售有礼-佣金比例（%）

3、促销活动字段：

tmall_play_activity_start_time :天猫限时抢可售 -开始时间（毫秒）

tmall_play_activity_end_time :天猫限时抢可售 -结束时间（毫秒）

play_info :玩法,  1聚划算满减：满N件减X元，满N件X折，满N件X元） 2天猫限时抢：前N分钟每件X元，前N分钟满N件每件X元，前N件每件X元）

ju_play_end_time 聚划算满减 -结束时间（毫秒）

ju_play_start_time 聚划算满减 -开始时间（毫秒）

【其它详情版参数】

title：产品标题

shop_title：店铺名称

nick：卖家旺旺昵称

zk_final_price：产品折后价

reserve_price：原价

volume：最近30天销量

cat_name：分类名

cat_leaf_name：分类子叶

seller_id：卖家id

user_type：1、表示天猫，0、表示淘宝

material_lib_type : 商品库类型，支持多库类型输出，以“，”区分，1: 表示为营销商品主推库

item_url：表示产品链接地址（天猫国际有的也是taobao.com链接，要结合user_type分析）

reward_info: 比价场景专用，当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时，该字段显示1，否则为0

topn_info {  //前N件佣金信息-当入参get_topn_rate=1，前N件佣金生效且最高，透出该组字段

        "topn_end_time": "1622822399000",  //前N件佣金结束时间， 当前N件佣金 失效，本字段置空

        "topn_quantity": "440",  //前N件剩余库存，当前N件佣金失效，本字段置空

        "topn_start_time": "1622217600000",  //前N件佣金开始时间，当前N件佣金失效，本字段置空

        "topn_total_count": "500"  //前N件初始总库存，当前N件佣金失效，本字段置空（失效：任务完成、时间结束、商品下架）

},

五、错误时返回值：

当找不到产品，或出错时，返回值json如：

{
    "error": "6001",
    "msg": "请传递产品ID、或淘口令，或淘客链接"
}

具体错误码参考 http://www.veapi.cn/doc/taobaokeapijiekoucuowuma