接口使用场景等说明:本接口支持传入唯品会“产品ID”或“链接”(包括商品详情页链接或唯品会联盟推广页链接)生成只为唯享客自己的推广链接。
本接口支持批量转链,但单次请求商品id不超过50个产品。
本接口需要授权,请进入会员中心授权,或使用接口参数授权。
在调用生成链接接口时,可选择传入chanTag或statParam,用户通过该链接下单后,渠道通过订单接口获取此订单时将同时拿到对应的chanTag(channelTag或pid)或statParam。
唯品会小程序APPID为 wxe9714e742209d35f ,可在微信小程序场景下跳转至唯品会小程序商品详情
如果您已经生成了推广链接,在产品ID或链接不变情况下,可以直接通过修改推广链接字段ulUrl、url、noEvokeLongUrl、longUrl、noEvokeUrl,在后面附加“chanTag=xxx&statParam=yy”参数,实现批量修改推广链接,而不需要再度调用接口。比如:https://t.vip.com/pg10RPpH276 直接修改为 https://t.vip.com/pg10RPpH276?chanTag=123&statParam=456
| 环境 | http 地址 | https 地址 |
|---|---|---|
| 正式环境 | http://api.veapi.cn/vip/vip_promitem | 暂无 |
| 参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
| version | String | 否 | 2.0.0 | 唯品会接口版本,当前可选为1.3.0和2.0.0两个值。默认1.3.0 |
| goods | String | 是 | 6918802835351161488,https://t.vip.com/jG9DJ2TfMr5 | 唯品会商品id或链接列表,支持批量查询,用逗号相连。单次批量请求商品不超过50 |
| chanTag | String | 否 | 渠道标识,即推广位PID,无需在唯品会联盟系统中创建即可使用。可用于唯品会跟单。(不能含有特殊字符,仅限字母、数字、下划线, 长度最大64), 如果没有推广位 则传默认推广位标识: default_pid | |
| statParam | String | 否 | 自定义渠道统计参数(最大长度为256字符),无需在联盟系统中创建即可使用。 | |
| evokeQuickApp | Boolean | 否 | false | 是否自动唤起快应用,默认false |
| queryExclusiveCoupon | Boolean | 否 | true | 有隐藏红包时返回领券页,默认true |
| genShortUrl | Boolean | 否 | true | 是否压缩生成的链接,默认false(理论上生成的链接无需压缩也能满足大部分推广情景,如非必要,请勿选择压缩,压缩的链接有有效期(目前是一个月)) |
| detail | Number | 否 | 1 | 是否需要更多产品详情字段,可选值0或1,默认0表示不需要详情字段 |
| sessionkey | String | 否 | 7002 | 多用户专用。如果您的会员卡是多用户版订单查询接口,若要查不同的帐号,请提供该帐号授权的sessionkey值 |
| account_id | String | 否 | 联盟号id | 会员中心有多个授权时,用本参数指定要查询哪一个联盟号id数据,联盟号ID请到会员中心授权页查看 |
| openId | String | 否 | 556599542235 | 自定义的标记渠道用户在渠道侧的用户唯一标识(必传)(如已接入sdk,该值为渠道用户授权绑定唯品会账号的标识,如没接入sdk,该值为渠道用户在渠道侧的用户唯一标识)不能含有特殊字符,仅限字母、数字、下划线,长度最大32,用于识别用户并给用户返利分佣(非常重要!传错影响给用户返利分佣)如果当前调用与用户无关,比如后台job触发拉取商品,则传默认标识:default_open_id (转链接口不论是否实时调用都必须传实际的 open_id)。调转链接口与商品接口时,同一用户openId传参需要一致订单里面会带上转链时所传的openId信息。 |
| realCall | Boolean | 否 | false | 是否实时调用(必传),默认true:由用户实时触发的请求,实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false:不是由用户实时触发,由渠道后台job触发的请求,比如渠道后台job定期调联盟接口拉取商品到渠道自己的库,请按实际情况传该参数。 |
| adCode | String | 否 | 不需要传,接口已固定值为vendoapi。标识获取推广物料的来源,从物料输出接口获取,如当前转链的物料不是从联盟物料接口获取,则传默认值adCode(工具商接口传vendoapi,渠道商接口传unionapi),该参数用于优化用户推荐效果,请勿乱传。 | |
| platform | Integer | 否 | 1 | 平台类型,1:移动端,2:PC端 3:移动端-android 4:移动端-ios 5:移动端-鸿蒙 (备注:不传时默认为移动端,目前用于给链接拼接小把手时拼接上对用平台的scheme,如果调用方是移动端且明确知道自己是安卓还是iso还是鸿蒙,请传3或4或5) |
| rid | String | 否 | 招商团长转链投放渠道(rid的值可以从带rid的链接传入调用vipLinkCheck接口解析出来进行获取,或找合作的招商团长获取) | |
| goodsLandingPageType | Integer | 否 | 1 | 商品落地页:1-商品详情页 2-商品中间页(用于控制转链后的商品跳转商品详情页或商品中间页 默认跳商品详情页) |
| giftCode | String | 否 | 礼金 code 用于生成带唯礼金的商品链接(请使用createGiftCoupon接口进行礼金创建后获取) | |
| genAuthorityUrl | Boolean | 否 | false | 是否生成带授权功能的cps链接(仅2.0版本服务中支持,1.x版本服务不支持该功能,使用本参考请把version设置为2) |
GET/POST http://api.veapi.cn/vip/vip_promitem?vekey=xxx&goods=2805782718872640&chanTag=5566&openId=92B4DCCB036C4CBB2C3&realCall=true&adCode=vendoapi&statParam=wechat【例子】根据链接转链,且PID为12366,推广渠道为微信
http://api.veapi.cn/vip/vip_promitem?vekey=xxx&goods=https://www.vipglobal.hk/detail-1710619984-6918802835351161488.html&chanTag=12366&openId=92B4DCC3&realCall=true&adCode=vendoapi&statParam=wechat【例子】混合ID或链接批量转链4个产品
http://api.veapi.cn/vip/vip_promitem?vekey=xxx&goods=2636308237042259,6918687900033696926,https://www.vipglobal.hk/detail-1710619984-6918802835351161488.html,https://t.vip.com/jG9DJ2TfMr5&chanTag=12366&openId=92B4DCC3&realCall=true&adCode=vendoapi&statParam=wechat
$api="http://api.veapi.cn/vip/vip_promitem?vekey=xxx&goods=2805782718872640&chanTag=5566&openId=92B4DCCB036C4CBB2C3&realCall=true&adCode=vendoapi&statParam=wechat"; $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; //返回值
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/vip/vip_promitem?vekey=xxx&goods=2805782718872640&chanTag=5566&openId=92B4DCCB036C4CBB2C3&realCall=true&adCode=vendoapi&statParam=wechat";
// JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
//System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");
// 发送请求
String result = HttpRequest.get(url)
.timeout(10000)//设置超时,毫秒
.execute().body();
System.out.println(result);
}
}
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/vip/vip_promitem?vekey=xxx&goods=2805782718872640&chanTag=5566&openId=92B4DCCB036C4CBB2C3&realCall=true&adCode=vendoapi&statParam=wechat" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
| 参数名称 | 参数类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| source | String | 否 | 链接生成的数据源:如果根据商品id生成链接,该值商品id, 如果根据链接生成链接,该值为唯品会链接 | |
| url | String | 否 | CPS短链接 | |
| longUrl | String | 否 | CPS长连接 | |
| ulUrl | String | 否 | CPS通用连接 | |
| deeplinkUrl | String | 否 | CPSD eeplink链接,APP类型媒体建议优先使用deeplinkUrl,如唤起失败(可通过检测用户是否跳转)再使用url跳转 | |
| traFrom | String | 否 | 小程序CPS参数:通用小程序跟单参数 | |
| noEvokeUrl | String | 否 | CPS短链接:不唤起快应用 | |
| noEvokeLongUrl | String | 否 | CPS长链接:不唤起快应用 | |
| vipWxUrl | String | 否 | 唯品会小程序链接:仅在根据商品id获取时返回 | |
| vipWxCode | String | 否 | 唯品会小程序码:仅在根据商品id获取时返回,需获取小程序码高级权限 | |
| vipQuickAppUrl | String | 否 | 唯品会快应用链接 | |
| vipZfbUrl | String | 否 | 唯品会支付宝小程序链接 | |
| vipZfbHttpsUrl | String | 否 | 唯品会支付宝小程序scheme链接 | |
| onlyCommand | String | 否 | 唯品会唯口令 | |
| tips | String | 否 | 转链提示信息 | |
| item | Object[] | 否 | 产品详情,仅当入参detail=1时才有此字段,字段含义请参考这里 |