API文档中心

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

生成唯品会微信小程序码推广链接

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

本接口用于生成跳转到唯品会微信小程序的推广链接。


2023年7月1号以后,V1.3版新增参数openId,realCall,adCode,genShortLink,genWxCode。

接口请求地址

环境 http 地址 https 地址
正式环境 http://www.veapi.cn/vip/vip_getwxcode 暂无

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
targetValue String 6917940288052200145 可以是URL,也可以是唯品会产品ID,要和targetType配合使用。
targetType String HOME 跳转类型值。targetType可选值有:要跳到微信小程序首页-传入HOME,跳到商品页-GOODSID,专场页-BRAND,店铺页-STORE,品牌-BRANDSTORE,专题页-WEBVIEW,其他类型链接-URL。比如您要跳到小程序这个产品页:https://www.vipglobal.hk/detail-1710620913-6917940288052200145.html,那么targetValue就传入6917940288052200145,targetType则传入GOODSID,如果要跳到小程序主页,则直接targetType传入HOME,这时targetValue可以是任意的唯品会链接均可。
openId String 556599542235 自定义的标记渠道用户在渠道侧的用户唯一标识(必传)(如已接入sdk,该值为渠道用户授权绑定唯品会账号的标识,如没接入sdk,该值为渠道用户在渠道侧的用户唯一标识)不能含有特殊字符,仅限字母、数字、下划线,长度最大32,用于识别用户并给用户返利分佣(非常重要!传错影响给用户返利分佣)如果当前调用与用户无关,比如后台job触发拉取商品,则传默认标识:default_open_id (转链接口不论是否实时调用都必须传实际的 open_id)。调转链接口与商品接口时,同一用户openId传参需要一致订单里面会带上转链时所传的openId信息。
realCall Boolean false 2023.7.1后新增的参数:是否实时调用(必传),true:由用户实时触发的请求,实时给用户展示联盟返回的商品信息或者实时给用户转链生成推广链接。 false:不是由用户实时触发,由渠道后台job触发的请求,比如渠道后台job定期调联盟接口拉取商品到渠道自己的库,请按实际情况传该参数。
adCode String   标识获取推广物料的来源,从物料输出接口获取,如当前转链的物料不是从联盟物料接口获取,则传默认值adCode(工具商接口传vendoapi,渠道商接口传unionapi),该参数用于优化用户推荐效果,请勿乱传。
genShortLink Boolean false 是否需要生成小程序短链,为null时默认false
genWxCode Boolean true 是否需要生成小程序码,为null时默认true,兼容历史接口默认值

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://www.veapi.cn/vip/vip_getwxcode?vekey=xxx&targetValue=6917940288052200145&targetType=GOODSID&statParam=232&chanTag=66899 
【例子】跳转到唯品会小程序首页
http://www.veapi.cn/vip/vip_getwxcode?vekey=xxx&targetValue=https://www.vip.com&targetType=HOME&chanTag=66899
使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://www.veapi.cn/vip/vip_getwxcode?vekey=xxx&targetValue=6917940288052200145&targetType=GOODSID&statParam=232&chanTag=66899";

$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://www.veapi.cn/vip/vip_getwxcode?vekey=xxx&targetValue=6917940288052200145&targetType=GOODSID&statParam=232&chanTag=66899";
        // 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://www.veapi.cn/vip/vip_getwxcode?vekey=xxx&targetValue=6917940288052200145&targetType=GOODSID&statParam=232&chanTag=66899"

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

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

返回值(JSON)

参数名称 参数类型 是否必选 示例值 描述
source String   链接生成的数据源:如果根据商品id生成链接,该值商品id,如果根据链接生成链接,该值为唯品会链接
url String   CPS短链接
longUrl String   CPS长连接
shortLink String   小程序短链
ulUrl String   CPS通用连接
deeplinkUrl String   CPS Deeplink链接
traFrom String   小程序CPS参数:通用小程序跟单参数
noEvokeUrl String   CPS短链接:不唤起快应用
noEvokeLongUrl String   CPS长链接:不唤起快应用
vipWxUrl String pages/productDetail/productDet... 唯品会小程序链接:仅在根据商品id获取时返回
vipWxCode String   唯品会小程序码:仅在根据商品id获取时返回,需获取小程序码高级权限
vipQuickAppUrl String   唯品会快应用链接

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "0", "msg": "接口调用成功!", "data": { "wxCodeInfo": { "vipWxUrl": "pages/productDetail/productDetail?brandId=1710620913&goodsId=6917940288052200145&tra_from=adp%3AC01V4m56b8y8mydr%3A%3Amig_code%3A%3Aac03164m56b80000kf05um06ldewqoq3&chl_type=wxk" } }, "request_id": "rUqf9Ni" }

错误码

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

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部