API文档中心

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

全新万能转链-支持商品、店铺、活动ID、淘口令、链接等

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

本接口是2024年淘宝联盟全新万能转链，用于替代早期的 hcapi 和 hcapi_v2 接口。

接口支持淘宝客商品ID（含数字ID和字符串），店铺seller_id，淘客活动会场id。

轻松处理淘客基本所有类型的参数。让您的开发更轻松。


但本接口不支持批量转链，如有这个需求请使用批量万能转链接口（批量状态下不支持数字ID转链）


【双11品带红包】

想在2025年获取品带红包，请入参商品ID参数 item_dto 或商品链接 material_dto 或 para（传入item_dto或material_dto参数后，para可随意入参但不起作用），并提供required_link_type参数：

（1） required_link_type 选择性入参超红链接相关字段（coupon_supered_long_url、coupon_supered_long_tpwd、coupon_supered_short_url、coupon_supered_short_tpwd、cps_supered_long_url、cps_supered_long_tpwd、cps_supered_short_url、cps_supered_short_tpwd）

（2） 特别说明：默认不返回品带红包会场推广链接，仅required_link_type入参指定字段才返回，各类链接字段可根据淘客


【返回值说明】

返回值中有coupon_short_url 和 coupon_long_url 等coupon_开头的，这是二合一页面的链接，当商品没有优惠券时，跳到这个二合一页面会提示优惠券失效，影响用户体验，这时可以用 cps_short_url 或 cps_long_url 这两个链接。您可以用result=1或2来判断是否有券，进而决定用哪一个链接跳转。


【特别提示】

请在使用 hcapi 和 hcapi_v2 的可切换到本接口。但如果还在使用sid跟单以及使用activityId入参的，请先保留原有hcapi接口

调用说明

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

接口请求地址

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

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
required_link_type String 否 cps_short_tpwd,coupon_short_url 指定字段，不入参默认返回全部字段【特殊说明的频道页链接除外】。为提升接口响应时效，建议入参必要返回字段，可选值有：coupon_long_url, cps_long_url, cps_short_tpwd, coupon_short_tpwd, cps_short_url, coupon_short_url, coupon_full_tpwd, cps_full_tpwd, share_unit_url, tao_brick_url。当通过para或item_dto入参获取品带红包时，本参数可以选择性入参超红链接相关字段（coupon_supered_long_url、coupon_supered_long_tpwd、coupon_supered_short_url、coupon_supered_short_tpwd、cps_supered_long_url、cps_supered_long_tpwd、cps_supered_short_url、cps_supered_short_tpwd）
para String 是 ￥TA1WdUtzfbP￥ 各类产品类参数：如手淘分享的整段文案、或产品数字ID或字符串ID、或链接等十多种参数，参考指引说明，请urlencode编码后传参
pid String 是 mm_11_22_33 淘客推广位，如在会员中心有设置PID可不传参，否则必须传参。
relation_id Number 否 565412325 渠道关系ID值，务必配合使用“渠道专属PID”，不能使用普通PID。
special_id Number 否 688441233 会员运营ID，当你传了本参数时，请务必使用“会员专属PID”，这样下单时才有透出会员运营ID。当提供了本参数时，relation_id失效
globaltpwd Number 否 1 可选值0或1，是否生成IOS和安卓通用的简易淘口令
promotion_type Number 否 1 请按新字符串ID政策正确传参。可选值 1-自购省，2-推广赚（代理模式专属ID，代理模式是，非代理模式不用填写该字段）
detail Number 否 默认0 可选值1或2，推荐设置为2。表示需要更多产品信息的字段。获取到手价、促销信息、百亿补贴等更完整信息，相关字段含义参考商品详情；值1比2多了一个会员运营营销库商品字段（material_lib_type=1即为营销库产品）,如果不需要该字段则推荐detail为2
item_dto Jsonobj{} 否 item_dto={"item_id":"Y38gkx3hptPrYMGU7g0u2t6-8P9O0eC07RPm2xXU9","sku_id":"5769208096788"} 商品转链，双11品带红包将会用到（需配合required_link_type参数传入带_supered_的字段名，默认不返回品带红包会场推广链接，仅required_link_type入参指定字段才返回）。传入本参数时，para中的商品ID请设置成和item_id一样。请使用JSON格式。
 └─ item_id String 是 Y38gkx3hptPrYMGU7g0u2t6-8P9O0eC07RPm2xXU9 商品ID，当提供item_dto参数时则本项是，请把para参数和该项值设置成一样。
 └─ skuid String 否 5769208096788 提供指定的SKUID值，转链结果将直接选中该SKU产品。
 └─ dx String 否 1 1表示商品转通用计划链接，其他值或不传表示转最优佣金率（含营销计划）链接
material_dto Jsonobj{} 否 material_dto={"material_url":"https://s.click..."} 链接/口令转链，para参数请设置成和material_url一样。请使用JSON格式。
 └─ material_url String 是 https://s.click.taobao.com/d5ncVEq 物料链接，可以为url或淘口令,当提供material_dto参数时则本项是，请把para参数和该项值设置成一样。
account_id String 否 联盟帐号ID 联盟帐号ID值，当一个维易号会员中心有2个以上联盟授权时，本参数指定要转链的联盟号，这时pid参数要和联盟号一致。请到会员中心授权页查看联盟号ID值
sessionkey String 否 7002455622... 淘客授权字串,本参数仅限多用户版，当您的接口卡是多用户版时，请提供本参数和对应联盟号的Pid参数

请求示例

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

【例子】转链商品ID
http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=753382678663


【例子】直接转链全段手淘分享文本
http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=09￥ MF7997 7MpaWkHkB7x￥ https://m.tb.cn/h.5tnVYaW  家用高档合金筷（实际使用请对para参数url编码）


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


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


【例子】转链店铺推广链接
http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=4793097890753034937


【例子】转链活动会场ID
http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=20150318020017989


【例子】双11品带红包会场：required_link_type指定值
http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=Y38gkx3hptPrYMGU7g0u2t6-8P9O0eC07RPm2xXU9&globaltpwd=1&skuid=5769208096788&item_dto={"item_id":"Y38gkx3hptPrYMGU7g0u2t6-8P9O0eC07RPm2xXU9","sku_id":"5769208096788"}&required_link_type=coupon_supered_long_url,coupon_supered_long_tpwd
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/tbk/generalconvert?vekey=xxx&para=https://m.tb.cn/h.5tnVYaW&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/generalconvert?vekey=xxx&para=https://m.tb.cn/h.5tnVYaW&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/generalconvert?vekey=xxx&para=https://m.tb.cn/h.5tnVYaW&detail=1"

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

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

返回值（JSON）

参数名称 参数类型 示例值 描述
parse_type Number 1 转链类型（material_type）：1—单品 2—店铺 3—会场 4-承接开放 5-优惠券 6-直播间 7-淘积木页
result Number 1 是否有券：1该产品有优惠券，2该产品无券,0表示当前为非商品（比如店铺转链或会场转链）【说明】本字段值1或2决定了下面coupon_short_url或coupon_long_url二合一链接，还是cps_short_url 或 cps_long_url直跳详情页的链接，您要用哪一个链接跳转。
is_bybt Number 1 是否为百亿补贴：0不是，1是百亿补贴。【说明】该字段和result一样，本字段值0或1决定了下面coupon_short_url或coupon_long_url二合一链接，还是cps_short_url 或 cps_long_url直跳详情页的链接，您要用哪一个链接跳转。
istaote Number 0 是否为淘特产品，0否，1是，用于判断你的APP等应用是要跳到手淘APP还是淘特APP
original_para_id String 56642522332 商品入参的原始商品ID
commission_rate String 6.00 佣金率
activity_id String 19d114f1a6464c98a30b01b3cb17dad6 优惠券ID
coupon_remain_count Number 99944 优惠券剩余数量
coupon_amount String 80.00 券面额
coupon_start_time String 2022-12-14 00:00:00 优惠券开始时间
coupon_end_time String 2022-12-20 23:59:59 优惠券结束时间
coupon_desc String 满129元减80元 优惠券信息，满XX元减XX元
coupon_type Number 0 0-店铺 1-单品，该字段不一定出现
coupon_short_tpwd String ￥p7lYdesjTCG￥ 商品、店铺或活动会场的二合一链接的短口令
coupon_short_url String https://s.click.taobao.com/DvHjOPu 二合一链接短链。【说明】coupon_开头是二合一页面链接，当商品没有优惠券时，跳到这个二合一页面会提示优惠券失效，影响用户体验，这时可以用 cps_short_url 或 cps_long_url 这两个链接。可用result=1或2来判断是否有券，进而决定用哪一个链接跳转
coupon_full_tpwd String 47￥ CZ3457 p7lYdesjTCG￥ https://m.tb.cn/h.UQ4ceEA 爆肚粉香辣花甲 二合一链接的长口令
coupon_long_url String https://uland.taobao.com/coupon/edetail?e=.. 二合一长链接。【说明】coupon_开头是二合一页面链接，当商品没有优惠券时，跳到这个二合一页面会提示优惠券失效，影响用户体验，这时可以用 cps_short_url 或 cps_long_url 这两个链接。可用result=1或2来判断是否有券，进而决定用哪一个链接跳转
cps_long_url String https://s.click.taobao.com/t?e=m2.. 商品、店铺或活动会场的CPS链接长链。这个是带有您推广信息的直接跳到商品详情页或店铺、会场等落地页的链接。当转链的是商品时，本链接会跳过优惠券领取的二合一页面直接进入商品页。
cps_short_tpwd String ￥zRmVdesjTCu￥ CPS链接的短口令
cps_short_url String https://s.click.taobao.com/CvHjOPu CPS链接短链。当转链的是商品时，本链接会跳过优惠券领取的二合一页面直接进入商品页。
cps_full_tpwd String 39￥ CZ3457 zRmVdesjTCu￥ https://m.tb.cn/h.UQ4cewa 粉条六袋装 CPS链接的长口令
coupon_channel_url String https://uland.taobao.com/coupon/edetail?e=Hc... 频道片二合一链接，必须在required_link_type字段入参才可出参 目前支持淘金币
coupon_channel_tpwd String 47￥ CZ3457 p7lYdesjTCG￥ https://m.tb.cn/h.UQ4ceEA 我的天呐麻酱爆肚粉香辣花甲 频道页二合一口令，必须在required_link_type字段入参才可出参 目前支持淘金币
cps_channel_url String https://s.click.taobao.com/t?e=m%3D... 频道页CPS链接，必须在required_link_type字段入参才可出参 目前支持淘金币
cps_channel_tpwd String 47￥ CZ3457 XODHdeIlU9B￥ https://m.tb.cn/h.UQ4ceEy olayks煮茶器喷淋式黑茶白茶 频道页CPS口令，必须在required_link_type字段入参才可出参 目前支持淘金币
coupon_supered_long_url String https://uland.taobao.com/coup... 超红二合一长链接，必须在required_link_type字段入参才可出参
coupon_supered_short_url String https://s.click.taobao.com/HvHjOPu 超红二合一短链接，必须在required_link_type字段入参才可出参
coupon_supered_long_tpwd String 47￥ CZ3457 p7lYdesjTCG￥ https://m.tb.cn/h.UQ4ceEA 我的天呐麻酱爆肚粉香辣花甲 超红二合一长口令，必须在required_link_type字段入参才可出参
coupon_supered_short_tpwd String ￥LOcqdeIlU9y￥ 超红二合一短口令，必须在required_link_type字段入参才可出参
cps_supered_long_url String https://s.click.taobao.com/t?e... 超红cps长链接，必须在required_link_type字段入参才可出参
cps_supered_short_url String https://s.click.taobao.com/HvHjOPu 超红cps短链接，必须在required_link_type字段入参才可出参
cps_supered_long_tpwd String 47￥ CZ3457 p7lYdesjTCG￥ https://m.tb.cn/h.UQ4ceEA 我的天呐麻酱爆肚粉香辣花甲 超红cps长口令，必须在required_link_type字段入参才可出参
cps_supered_short_tpwd String ￥LOcqdeIlU9y￥ 超红cps短口令，必须在required_link_type字段入参才可出参
tk_biz_type Number 2 1-联盟口令，2-主站口令。入参物料不为淘口令时，此字段返回null
item_id String y387e62Ozub0TvtA-dAeOMBinu0 商品ID
seller_id String 123456 卖家ID
global_tpwd Obj   简短的IOS和安卓通用的口令。当您双11等大促期间通过required_link_type传入coupon_supered_long_url等带“_supered_”品带红字段时，这里返回的淘口令也是品带红的。如果不传带“_supered_”品带红字段时，则这里返回的是普通的二合一淘口令或CPS淘口令。本字段仅当返回了cps_short_tpwd,coupon_short_tpwd等带淘口令的字段后，才会返回，因此如果需要此字段，在指定required_link_type时，请加上带“_tpwd”的字段
 └─ coupon_full_tpwd String 2￥ CZ3457 Y16vf3fDd27￥/ 跳到二合一的IOS和安卓通用的口令，受required_link_type影响，不一定会出现该字段，请做好判断
 └─ cps_full_tpwd String 7￥ CZ3457 tih1f3fC2nB￥/ 直接跳转详情页的IOS和安卓通用的口令，受required_link_type影响，不一定会出现该字段，请做好判断
page_id String 20150318020014311 会场ID
material_id String 688401422805 物料ID，需根据material_type判断物料类型，可能为商品ID、卖家ID、会场ID
isv_mktid String aisjd8-8asdbaiu 根据入参工具服务商账号信息生成的新商品ID
tpwd_origin_url String https://item.taobao.com/item.htm?ut_sk=1.Xhm.. 淘口令原始链接，入参物料不为淘口令时，此字段返回null
multiple_items_prices_count Number 2 多件价需拍件数
multiple_items_coupon_info_list Obj[]   多件价券信息
 └─ coupon_title String 商品券 优惠名称
 └─ coupon_desc String 满7999减1300 优惠券信息，满XX元减XX元，满x件减y元
 └─ coupoon_fee String 1300.00 优惠金额。单位元
 └─ coupon_start_time String 2022-12-14 00:00:00 优惠开始时间
 └─ coupon_end_time String 2022-12-15 00:00:00 优惠结束时间
 └─ activity_id String 19d114f1a6464c98a30b01b3cb17dad6 优惠ID
 └─ coupon_remain_count Number 99987 优惠剩余数量

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "万能解析转链成功", "parse_type": 1, "data": { "activity_id": "c5f192fde0ed4af6b182c8307cd5fc5e", "coupon_amount": "241.00", "coupon_desc": "满300元减241元", "coupon_end_time": "2024-02-24 23:59:59", "coupon_remain_count": "98000", "coupon_start_time": "2024-02-17 20:00:00", "coupon_full_tpwd": "79￥ CA6496 Ex8yWkHNcG4￥ https://m.tb.cn/h.5GoYtgV 康巴赫五福分食筷子2024新款家用高档防滑防霉合金筷套装一人一筷", "coupon_long_url": "https://uland.taobao.com/coupon/edetail?e=eZqLmn7Pl3elhHvvyUNXZfh8CuWt5YH5OVuOuRD5gLJMmdsrkidbOWBzzpT26idJOrND8WfOINy62JYcPNdSnEgZlx17d0Xoxs16bmkceNO7hDgeYZWPum5Sf1etnnoB%2F1I4Va3MO0gUcLJJYP0Uq3bMhskDShwFT%2F1mTtwPHxT0fJdlTnMtJ5Yd8p8AWuCYQk49oiEpfvwJBeanfyHnfRvdFKWzl4V7%2B%2BQZ1WKK6dsKu0q0wSEpkoNilZ3GDvovpapcS64kFXJLfgIwr76UAtknvM3jYdSDEuNEFmVV7h%2BoLRfGbrMoPIlWokyLj%2B4oucncAAt5shdVbrKqp4Yn8g%3D%3D&traceId=21057b4217084163544113981e2955&skuId=5253834584032&&union_lens=lensId:TAPI@1708416354@21085874_1113_18dc58cc8e7_990d@01", "coupon_short_tpwd": "￥Ex8yWkHNcG4￥", "coupon_short_url": "https://s.click.taobao.com/sHqF5yt", "cps_full_tpwd": "88￥ CA6496 D9icWkHmQZl￥ https://m.tb.cn/h.5G2ld6O 康巴赫五福分食筷子2024新款家用高档防滑防霉合金筷套装一人一筷", "cps_long_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DgfOmXMx48nFw4vFB6t2Z2ueEDrYVVa64yK8Cckff7TVRAdhuF14FMUDEb5xG0VaUxq3IhSJN6GQNx086yGXKPm3yp02FtiUkuEHV73KYXCORJkMnNrcwP4VwhIsr1DlAgb9ZeSZXs4riUZ4qe2FytPFLSb2wfhFdOemaFM5tHHYxZyjQcbVDheesoYp3R6EY4sVE9MnMy3OWKvCO%2FTzLm%2B6ekRpwY%2FaGMcSn5BytfI0RdWAs8%2B7MBaX9ik5neujtMA936bpZwsioKHZNjzO%2BquCTnndEcWuj39IOj2KYEU3RRdpF%2BfJR6dNl6%2BNlWG2qyBNmcjbUX%2BrGJe8N%2FwNpGw%3D%3D&skuId=5253834584032&union_lens=lensId:TAPI@1708416354@21085874_1113_18dc58cc8e7_990d@01", "cps_short_tpwd": "￥D9icWkHmQZl￥", "cps_short_url": "https://s.click.taobao.com/HG9G5yt", "isv_mktid": "k0djXmuYt0AR7yi6bmCPtJ-mMVzK8s7xV83MMrHY9", "item_id": "WPW3yz5hot2jRv2M2ZurzOtVUa-mMVzK8s7xV83MMrHY9", "material_type": "1", "tk_biz_type": "2", "tpwd_origin_url": "https://uland.taobao.com/coupon/edetail?af=4&e=PLOHiJp8x5ilhHvvyUNXZfh8CuWt5YH5i0ljE1xcAElMmdsrkidbOWBzzpT26idJa7oi%2FTPu%2BzJZ3NqNNlTaYFimrM9Hk4u4xnnW2rZUmJC9QNRrQJZw0PtYnex4909kRSHvQe2jOLY4UujRP%2B%2F2G%2FctMOjbxBZCpKO8HGT4vKldG6%2FvGnPUvtARQKkTg7tdVdGbOSTaEgrXYE9E9Qw0v1%2FTt%2BZcWuiLErf%2FspglM1nbw%2BWJq6aHcNkrxIEepDSqhCU%2FvxJBjMCOCKlHdeFT5kJOPaIhKX78dHAeBhK41wFTro7LHkPm9M1D0KxnSC7chIkz5M1CZ9VJibVf3r9yASUzVkkdwsIm&traceId=2150405f17072840432133026e1b88&skuId=5253834584032&traffic_flag=lm&scm=1007.15348.339263.moon_home-page-recommend-meta_a978f42a-7cf2-456d-b38a-1bad5710a2dc_&union_lens=lensId%3AAPP%401707284034%40moon_home-page-recommend-meta_a978f42a-7cf2-456d-b38a-1bad5710a2dc_%40041Ks9gbLoOgR0RgVfafika6%40eyJmbG9vcklkIjo3NzA2Miiwiic3JjRmxvb3JJZCI6IjgwMDQ3IiiwiiYWlnYyI6MX0ie%3Bscm%3A1007.15348.339263.moon_home-page-recommend-meta_a978f42a-7cf2-456d-b38a-1bad5710a2dc_&un=2ac04af0bb0530934b68d5f77a161062&share_crt_v=1&un_site=0&spm=a2159r.13376465.0.0&sp_tk=Q3dKcVdROVdPSnk%3D&bxsign=tcdVsRPbc28FDyNma8J2kk64Zt4I98AQrR7FzwHuerauXxQ5cp4HGg3dyBTg94UbvwNR6tkNdX6R_dd4n7RyCPzBbaoEAHteb4xUdplXF4PaSE&bc_fl_src=share-594085124792-1-0&sourceType=other&suid=91f40c0e-0446-44e3-b272-1569410014c6&ut_sk=1.Xq2BcE%2BjDlADACVy7teRBT49_21646297_1707284001785.TaoPassword-WeiXin.windvane&sp_abtk=common_windvane_commonInfo", "istaote": 0, "commission_rate": "6.00", "original_para_id": "" }, "request_id": "Q1PYNU3" }

错误码

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

在线
客服

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

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部