API文档中心

热门接口：产品ID找同款全量维权查询万能转链字符串ID转换 （有API需求可联系本站）

淘客万能转链接口—支持产品ID、淘口令、链接各类参数

调用权限：核心接口会员卡调用
 接口测试 
接口使用场景等说明：

生成淘客产品的转链和淘口令，能轻松处理淘客基本所有类型的参数。让您的开发更轻松。

本接口适用于产品万能转链。如果您需要一个接口处理“产品和活动”转链，请使用V2版本。


【特别提示】

根据联盟新规，请尽量使用新字符串ID或淘口令或推广链接入参。数字ID入参仅限手淘APP比价场景可使用。


【新版公告】

新版万能转链接口上线，欢迎使用，比现有的增加了活动、店铺转链处理功能。有需要可切换 https://www.veapi.cn/apidoc/taobaolianmeng/366 

但新版万能转链接口暂时没有自动保持入参中优惠券ID，也不支持自定义券ID（后续会增加）。请按需选择。


目前还在使用sid跟单的，请暂时保持现版hcapi转链接口。

调用说明

本接口需要您在会员中心授权（如果多用户可传入sessionkey参数）

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/tbk/hcapi 暂无

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
para String 是 ￥TA1WdUtzfbP￥ 各类产品类参数：如手淘分享的整段文案、或产品数字ID或字符串ID、或链接等十多种参数，参考指引说明，请务必urlencode编码后传参
detail Number 否 默认0 可选值1或2或3，表示需要更多产品信息的字段。设置为1时，表示获取常规信息；设置为2时，表示要获取到手价、促销信息、百亿补贴等更完整信息，当您指定为2时，相关字段含义参考搜索接口升级版；如果设置为3则可以获取商品是否会员运营营销库商品字段（material_lib_type=1即为营销库产品）
pid String 否 mm_11_22_33 淘客推广位，如在会员中心有设置PID可不传参，否则必须传参。
relation_id Number 否 565412325 渠道关系ID值，务必配合使用“渠道专属PID”，不能使用普通PID。
special_id Number 否 688441233 会员运营ID，当你传了本参数时，请务必使用“会员专属PID”，这样下单时才有透出会员运营ID。
external_id Number 否 21231 淘宝客外部用户标记，需配合渠道接口（publisherget）获取special_id，此参数详细用法和比价说明点此了解
activityId Number 否 dfdfDFsdf56522232adfDA 指定优惠券id,提供本参数后接口自动在返回的推广链接后面添加该券id及该券信息。本参数和deepcoupon参数只能使用一个，如果一起使用，则deepcoupon参数失效。
deepcoupon Number 否 默认0 可选值1或2，参数值含义：1-表示对联盟产品无官方优惠券时，则进行检查是否有商家合作券；2-（不建议）表示不管转链的商品有没有券，都进行进一步检查商家合作券，如果商品本身就有单品券，则与检查出来的商家合作券取“券面额大”的一个使用。使用shopcoupon和deepcoupon参数，调用接口会有一定的效率损失。
shopcoupon Number 否 默认0 可选值1，当指定1时，接口会整合你传递的淘口令或淘客链接的参数中店铺券返回。如果你发现原淘口令中有店铺券，但接口返回没有店铺券，可以加上本参数，则返回值会保持原口令中的店铺券。本参数可以和deepcoupon一起使用。
notkl Number 否 默认0 可选值1，接口默认会返回淘口令（tbk_pwd 字段），当您不需要返回值中包含淘口令时，请添加此参数notkl=1取消接口中返回淘口令，这样接口调用效率更高。
noshortlink Number 否 默认0 可选值1，接口默认会返回短链接（coupon_short_url 字段），如果您不需要此字段，使用本参数取消接口返回短链，并自行按需对返回值中的长链接生成短链，推荐使用本参数，这样可以提高您的高佣接口调用效率。
couponId Number 否 默认0 是否需要优惠券ID值返回,可选值0或1，如果传了本参数couponId=1则返回优惠券ID（在有券的情况下）。返回值中多了一个字段coupon_id。如果商品无券则coupon_id为空。仅当detail参数为1时，本参数有效。
xid Number 否 1232323 招商团长专用：团长与下游渠道合作的特殊标识，用于统计渠道推广效果
plhc String 否 默认0 可选值1 启用高佣批量转链，当启用本参数时，参数para必须是商品ID列表，如para=23883488910,598450446711...
get_topn_rate Number 否 默认0 可选值0或1，618大促等字段专用，表示是否获取前N件佣金 ,0-否，1-是
ucrowd_id Number 否 默认0 会员人群ID，用于统计人群推广效果
mini_program_link Number 否 默认0 可选1，是否需要获取小程序链接(暂未对外开放)
promotion_type Number 否 默认0 请按新字符串ID政策正确传参。可选值 1-自购省，2-推广赚（代理模式专属ID，代理模式是，非代理模式不用填写该字段）
biz_scene_id Number 否 可不传或空 【已废弃，请勿用】场景参数
weibo Number 否 默认0 可选1或传您自己的域名，使用本参数，将生成微博跳到手淘的防拦截链接，指定值1时，将使用本站提供的域名，如果您自己有域名，可以指定域名，比如 weibo=www.veapi.cn 或weibo=https://www.veapi.cn (不传https时默认为http)，您提供的域名必须解析到指定IP，IP地址请联系客服。
tkl_type Number 否 默认0 可选值1和0，默认0，指定1时表示使用无券推广链接sclick_url生成短链接和淘口令，这样购买时跳过二合一领券页。
bybt Number 否 默认0 （已废弃）可选1，如有淘宝百亿补贴将显示百亿补贴后的价格。目前遇到百亿补贴商品转链时自动处理，不需要再传本参数。
account_id String 否 联盟帐号ID 联盟帐号ID值，当一个维易号会员中心有2个以上联盟授权时，本参数指定要转链的联盟号，这时pid参数要和联盟号一致。请到会员中心授权页查看联盟号ID值
sessionkey String 否 7002455622... 淘客授权字串,本参数仅限多用户版，当您的接口卡是多用户版时，请提供本参数和对应联盟号的Pid参数

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=https://m.tb.cn/h.URqMeen&detail=1 

【例子】直接转链全段手淘分享文本
http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=97￥ CZ0001 SOS7defeKjf￥ https://m.tb.cn/h.URqhfIE  短袖t恤女白色纯棉（实际使用请对para参数url编码）


【例子】转链推广链接
http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=https://s.click.taobao.com/XPnazLu


【例子】转链淘口令
http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=6￥ CZ3457 SOS7defeKjf￥/（实际使用请对para参数url编码）


【例子】转链商品ID
http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=551700864501
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=https://m.tb.cn/h.URqMeen&detail=1";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api);
//curl_setopt($ch, CURLOPT_POST, true);  //POST方式时启用
//curl_setopt($ch, CURLOPT_POSTFIELDS, $postData );  //POST方式时传参

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );   //返回数据流，不直接输出
curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快
curl_setopt($ch, CURLOPT_TIMEOUT, 6);  //允许执行的最长秒数。这里设定6S
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);

$result = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);

echo $result; //返回值
使用okhttp3/httpclient/jsoup/hutool，以hutool为例：

import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;

public class testGetParam {

    public static void main(String[] args) {
        // API网址
        String url = "http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=https://m.tb.cn/h.URqMeen&detail=1";
        // JDK 8u111版本后，若目标页面为HTTPS协议，请启用proxy用户密码鉴权
        //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

        // 发送请求
        String result = HttpRequest.get(url)
                .timeout(10000)//设置超时，毫秒
                .execute().body();
        System.out.println(result);
    }
}
推荐使用 requests，支持访问http,https网页：

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/tbk/hcapi?vekey=xxx&para=https://m.tb.cn/h.URqMeen&detail=1"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值（JSON）

参数名称 参数类型 示例值 描述
result Number 1 是否有券：1该产品有优惠券，2该产品无券
category_id Number 568 商品信息-叶子类目id
coupon_click_url String https://uland... 推广长链接，有券时为uland二合一，无券时为s.click链接
max_commission_rate String 1 常规佣金率：当不入参special_id、relation_id、external_id时展示常规佣金率(%)，百分比率值
commission_rate Number 1 该产品最大佣金比例，值10表示10%。如果你使用了比价参数external_id，special_id，relation_id时，接口返回min_commission_rate和max_commission_rate，因此字段“commission_rate”将显示为min和max两个字段中最大的一个佣金。
coupon_info String 满16元减10元 优惠券信息，可以从这里提取券使用条件和面额
coupon_start_time String 2019-12-10 优惠券开始时间
coupon_end_time String 2019-11-10 优惠券结束时间
coupon_type Number 1 优惠券(商品优惠券推广链接中的券)类型，1 公开券，2 私有券，3 妈妈券
coupon_total_count Number 6000 优惠券总量
coupon_remain_count Number 2300 优惠券剩余量
coupon_start_fee Number 86 优惠券起用条件，比如“满86元16元”中的86元
coupon_amount Number 86 优惠券面额，比如“满86元16元”中的16元
reward_info Number 1 比价场景专用，当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时，该字段显示1，否则为0
istaote Number 0 是否为淘特产品，0否，1是，这会影响推广链接跳转，淘特产品跳转到手淘，开发APP时可用到。
scene_id Number 1 当前参数的场景ID，如果您要用转链返回值继续使用其它接口，该参数可能会用的上。
num_iid Number 1 商品ID，注意可能是数字ID或AAA-BBB两段式的字符串ID
original_uland_link String https://... 记录调用接口的入参中原始链接，通常不需要该字段。
sclick_url Number 1 无券的推广链接，如果不想推广优惠券（佣金高），就可以使用此链接给客户下单。
zk_final_price Number 1 折后价(注意非原价，需要入参加detail=1时才返回本参数)，即商品在线售卖价。若属于预售商品，付定金时间内，在线售卖价=预售价
white_image String https://... 商品信息-商品白底图
volume Number 5681 30天销量(饿了么卡券信息-总销量）
user_type Number 1 店铺信息-卖家类型。0表示集市，1表示天猫
title String 1 商品标题
superior_brand Number 1 是否品牌精选，0不是，1是
small_images String[] 1 商品小图列表
short_title String 1 商品短标题
shop_title String xx旗舰店 店铺名称
shop_dsr Number 13 店铺dsr评分
seller_id Number 1232323 卖家id
reserve_price String 12.00 一口价（原价），通常淘宝上显示为划线价
real_post_fee String 0.00 商品邮费
pict_url Number https://...jpg 商品主图
nick String XX掌柜 店铺信息-卖家昵称
item_url String https://... 商品地址
cat_name String 女装/女士精品 分类名称
cat_leaf_name String T恤 叶子类目名称
tbk_pwd String ￥cPKOfd03nu2￥ 淘口令，如$adfder74dDS$
ios_tbk_pwd String   专用于IOS14和IOS16手机的淘口令，避免不弹窗。
global_tbk_pwd String   IOS和安卓通用的淘口令。
coupon_short_url String https://... 短链接，是coupon_click_url的压缩链接
original_para_id String 56642522332 商品入参的原始商品ID
presale_tail_start_time Number 1567440000000 预售商品-付尾款开始时间(毫秒)
presale_tail_end_time Number 1567440000000 预售商品-付尾款结束时间(毫秒)
presale_start_time Number 1567440000000 预售商品-付定金开始时间(毫秒)
presale_end_time Number 1567440000000 预售商品-付定金结束时间(毫秒)
presale_deposit Number 15 预售商品-定金(元)
ysyl_click_url String https://uland... 预售有礼-推广链接
ysyl_tlj_face String 0.6 预售有礼-预估淘礼金（元）
ysyl_tlj_send_time String 2019-11-10 21:59:59 预售有礼-淘礼金发放时间
ysyl_tlj_use_start_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用开始时间
ysyl_tlj_use_end_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用结束时间
ysyl_commission_rate String 20.3 预售有礼-佣金比例（%）
topn_info Stepratedto   前N件佣金信息-当入参get_topn_rate=1，前N件佣金生效且最高，透出该组字段
 └─ topn_end_time Number 1937297392332 前N件佣金结束时间， 当前N件佣金 失效，本字段置空
 └─ topn_start_time Number 1937297392332 前N件佣金开始时间，当前N件佣金失效，本字段置空
 └─ topn_quantity Number 3000 前N件剩余库存，当前N件佣金失效，本字段置空
 └─ topn_total_count Number 3000 前N件初始总库存，当前N件佣金失效，本字段置空（失效：任务完成、时间结束、商品下架）

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "高佣转链成功！", "result": 2, "data": { "category_id": "16", "coupon_click_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DJrfasB31fjFw4vFB6t2Z2ueEDrYVVa64XoO8tOebS%2BfLWlSKdGSYDmA1EycBkBwjxq3IhSJN6GQNx086yGXKPm3yp02FtiUkuEHV73KYXCORJkMnNrcwP4VwhIsr1DlAgb9ZeSZXs4q%2F6W5q5jAFizAJVS%2FRIROtzRD18rVfQC6EuM7wkVK6rtThqAp%2BpePCXg3%2BUeNSMHFNzuMLUNyvdEJo9rViF8f%2Bg0OBYUMFYSQR48L5HQGTXlrW6yLoIYeJIYULNg46oBA%3D&union_lens=lensId:TAPI@1670913294@21082972_0b5c_1850a317fbe_1a28@01", "max_commission_rate": "3.00", "reward_info": "0", "commission_rate": "3.00", "istaote": 0, "scene_id": "2", "num_iid": "23883488910", "original_uland_link": "https://uland.taobao.com/coupon/edetail?e=nFZEJmwK0wClhHvvyUNXZfh8CuWt5YH5OVuOuRD5gLJMmdsrkidbOcgNAa9X6T79uG1ZaNECU%2FTdiCVi3ZV%2FHKnQULKmQ8AQXRuv7xpz1L7QEUCpE4O7XWnTpXCrAMlvO6TpSu6KgJYO9MiSCo%2BUCxMpA7951nw0baIWn4iaUCAnApf0Rcjdm0%2FYgOxmYRfAdFgrnckdj2Bl2x8U%2BFCOkQU568IN27VVdJX1vdN4%2B2O2%2BHN1qNBsRYQJcAalGcHkGWqNBzv719M%3D&traceId=210764e316709132941293535e131a&&union_lens=lensId:TAPI@1670913294@21082972_0b5c_1850a317fbe_1a28@01", "sclick_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DJrfasB31fjFw4vFB6t2Z2ueEDrYVVa64XoO8tOebS%2BfLWlSKdGSYDmA1EycBkBwjxq3IhSJN6GQNx086yGXKPm3yp02FtiUkuEHV73KYXCORJkMnNrcwP4VwhIsr1DlAgb9ZeSZXs4q%2F6W5q5jAFizAJVS%2FRIROtzRD18rVfQC6EuM7wkVK6rtThqAp%2BpePCXg3%2BUeNSMHFNzuMLUNyvdEJo9rViF8f%2Bg0OBYUMFYSQR48L5HQGTXlrW6yLoIYeJIYULNg46oBA%3D&union_lens=lensId:TAPI@1670913294@21082972_0b5c_1850a317fbe_1a28@01", "tbk_pwd": "￥cICwd3oUzyb￥", "ios_tbk_pwd": "28￥ CZ0001 cICwd3oUzyb￥ https://m.tb.cn/h.URFvzTz 短袖t恤女白色紧身纯棉短款体恤夏季新款半袖修身内搭打底衫上衣", "global_tbk_pwd": "5￥ CZ3457 cICwd3oUzyb￥/", "coupon_short_url": "https://s.click.taobao.com/E0J8pOu", "original_para_id": "23883488910" }, "request_id": "6uR2lXE" }

错误码

如果error不为0时，请点此查看错误码表格

在线
客服

点此【QQ在线咨询】QQ号：3252444923

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部