【API通用原则】

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

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

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

4、很重要：由于不同接口对应不同的负载均衡集群服务器，因此API所用域名会有不同，请务必按接口文档所示的域名调用。

高佣金转链接口使用说明：

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

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

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

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

一、接口介绍：

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

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

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

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

1、全面的参数处理能力：除了id转高佣链，淘口令转淘口令（包含解密功能），各种链接（二合一、产品链、短链接、天猫链等）转淘口令。一个接口搞定各种情形，大大简化你的程序。

2、自动二次处理无券产品：对无券商品自动转高佣链接（同时返回原始二合一链接供您按需使用）。普通接口对无券产品生成的是错误的二合一链接，跳转后提示优惠券已失效，影响用户体验。

3、延续优惠券信息：对无券商品转高佣API时，自动保持原有优惠券为您所用。参http://wsd.591hufu.com/taokelianmeng/347.html 

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

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

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

1、免授权转链接口（仅适用于有优惠券的商品）：

【特别说明】

（1）本接口仅适用于有优惠券的商品

（2）很重要：官方通知2019年6月1号下线本接口所依赖的API，但目前仍可使用，建议使用下方hcapi万能转链。

http://api.vephp.com/directhc?vekey=xxx&para=产品ID&pid=你的PID

参数：

para：必选，产品ID，淘口令，二合一加密链等等

pid：必选，如果在会员中心有设置了默认的PID则可以不提供。

notkl ： 可选，默认0，当指定notkl=1时，返回值不提供淘口令，当你不需要淘口令时请使用它，效率高。

noshortlink：可选，默认0，当指定noshortlink=1时，返回值不提供短链接，效率更高。

relation_id：可选，渠道ID，当你使用渠道转链时可以使用它

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

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

使用权限：全能卡、超级卡、高级版使用

http://api.vephp.com/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）天猫的喵口令 如 http://zmnxbc.com/s/YJk6Z

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

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

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

（8）其它一些不常见的淘客链接

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

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

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

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

  说明

（1）全能卡、超级卡、高级版等会员只用 hcapi 即可（包含以下接口所有功能）。不需要使用以下接口。

（2）以下 hcid, hclink, hctkl 主要由辅助接口会员使用。

2、【辅助接口使用】id转高佣淘口令接口： hcid

http://api.vephp.com/hcid?vekey=你的vepkey&para=产品ID

本接口仅转链ID参数，高级高佣的hcapi已自带本功能。示例（vekey示例用，请换成您自己的vekey）：

http://api.vephp.com/hcid?vekey=xxxxxxxxx&para=567409957366

3、【辅助接口使用】链接转高佣接口： hctkl 和 hclink

hclink接口不包含id转链，因此链接参数不接收淘宝或天猫的产品链接，这类链接使用id转链需要高级版。

         （a）链接转淘口令： http://api.vephp.com/hclink?vekey=你的vepkey&para=https%3A%2F%2Fuland.taobao.com%...

                                         【注意】hclink链接参数不包含淘宝或天猫的产品链接。

         （b）淘口令转淘口令： 

              http://api.vephp.com/hctkl?vekey=你的vepkey&para=￥D9l10C3rdQz￥

注意：链接要编码后传入参数para。

比如上例是 https://uland.taobao.com/coupon/edetail?e=M4Nc... 编码后是https%3A%2F%2Fuland.taoba.....

【接口请求方式】GET方式 （仅图片转高佣中提交图片base64或二进制数据时使用post）

三、接口参数说明：

（一）公共参数：vekey和para 

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

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

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

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

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

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

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

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

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

（二）其它非必需参数：

完整URL接口地址：

http://api.vephp.com/hcapi?vekey=你的vepkey&para=主参数&pid=mm_11_22_33&sina=1&detail=1&sessionkey=71005..&activityId=bdsaf..

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

但是，如果是多用户版的用户，您在本站授权和设置Pid的淘客号是主号，而主号以外的、您的代理或子帐号调用接口时，就必须传递pid参数以及下文的sessionkey参数。

【很重要】

（1）当您使用的是渠道ID时，请勿必使用“渠道专属PID”，到淘宝联盟后台“推广管理——渠道管理——渠道专属PID”。

（2）当您使用的是会员运营ID绑定订单，请勿必使用“会员专属PID”。

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

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

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

5、activityId：【重要】可选，接口自动检测参数中是否已带有的优惠券ID，但也可直接指定优惠券ID，参http://wsd.591hufu.com/taokelianmeng/347.html 

6、sina ：可选，值为0（或不设置）或1。表示是否要把转链生成的短链接生成新浪t.cn短网址，默认0或不设置是淘宝的短网址，比如：

https://s.click.taobao.com/lWz8kQw

如果传递 &sina=1 则会生成：

http://t.cn/RBFwwuT

短网址主要是用于QQ群推送或微信推送时使用。如无必要不必传送sina参数。

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

7、notkl ：可选值【重要】，值为1：接口默认会返回淘口令（tbk_pwd 字段），主要是早期为了方便一些没有淘宝联盟基础API接口的客户。如果您自己有淘宝客基础API权限和SDK包，使用本参数取消接口直接返回淘口令，并在您自己程序中对返回值中的长链接生成淘口令，强烈推荐使用本参数，可以提高您的高佣接口调用效率。

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

9、sclickurl ：可选，值固定为1，或不传，当产品有优惠券时，但有时你可能只需要s.click链接，也就是有统计淘客推广佣金，但不需要领取优惠券，那加本参数，可以获取s.click链接。

【注意】本参数生成的短链主要用于网络软文或论坛贴子推广，不适合于微信上推广（微信主要靠防封图，否则因众所周知的腾讯和阿里两家互相屏蔽的原因，短链直接解析出的淘宝推广链接，在微信或QQ上也是无法打开的）。

如果您需要在微博推广，则需要下面的weibo参数

10、weibo ： 可选，值固定1，或不传。如果需要在微博推广，在微博中贴文中包含淘客推广网址，则添加本参数，可以生成防止新浪微博屏蔽的新浪短网址t.cn，并跳到淘客推广链接。

【注意】使用必知

1、因新浪对t.cn短网址停止对外使用和频率限制，添加本参数会降低接口性能，有时可能需要1-5秒以上才能返回值。

2、使用本参数后，接口限制1分钟25次。

3、使用本参数获取的t.cn仅适合微博推广，不适合微信和QQ等腾讯应用。

4、如果你需要在其它网站推广，以便百度收录和软文推广中包含短链，则建议用sclickurl参数，高效生成短链，而不建议使用weibo参数

10、me ：营销计划链接中的me参数，一般不使用。

11、tklpic ： 淘口令主图：在接口没有指定notkl 参数时，默认是有返回淘口令，淘口令主图默认是使用产品淘宝天猫主图第一张，如果你设置了tklpic参数，提供了自定的网络主图，则生成淘口令将使用您提供的图片地址做封面。

12、card ： 指定卡识别码（所有接口通用）。当您的帐号下有多张卡时，系统默认是按“多用户版--->年卡或月卡--->点卡”顺序使用。如果您想使用点卡等优先度低的卡，那么可以传递本参数，它的值为卡识别码，具体参考《更多帮助》第4节

四、返回值：

返回值格式： json

分简略版和详情版。

【注意】

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

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

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

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

以下是返回值：

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

（1）有优惠券：

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

详情参 http://wsd.591hufu.com/taokelianmeng/282.html 

（2）无优惠券：

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

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

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

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

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

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_type：优惠券类型：1 公开券，2 私有券，3 妈妈券 （有优惠券时才有此字段）

commission_rate：该产品佣金比例，多级代理依此值计算。值10表示10%。

num_iid：产品ID

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

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

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

【其它详情版参数】

title：产品标题

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分析）

五、错误时返回值：

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

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