API文档中心

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

获取京东联盟网站/APP推广链接(慎用)

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

网站/APP来获取的推广链接,通过商品链接、活动链接获取普通推广链接,支持传入subunionid参数,可用于区分媒体自身的用户ID,该参数可在订单查询接口返回


【特别强调】这个接口限制用于APP或者网站,如果通用转链接口传入的APPid和实际下单的 APP不一致 会被判定为违规订单。因此请慎用。

接口请求地址

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

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
materialId String https://item.jd.com/23484023378.html 推广物料,支持多种形式,包括商品ID、商品链接;
siteId String 435676 网站ID/APP ID,入口:京东联盟-推广管理-网站管理/APP管理-查看网站ID/APP ID(1、接口禁止使用导购媒体id入参;2、投放链接的网址或应用必须与传入的网站ID/AppID备案一致,否则订单会判“无效-来源与备案网址不符”)
positionId Number 6 新增推广位id,纯数字(不填的话,为其默认生成一个唯一此接口推广位-名称:微信手Q短链接)
subUnionId String 618_18_ce6a 子渠道标识,仅支持传入字母、数字、下划线或中划线,最多80个字符(不可包含空格),该参数会在订单行查询接口中展示(需申请权限)
ext1 String 100_618_618 系统扩展参数(需申请权限),最多支持40字符,参数会在订单行查询接口中展示
pid String 618_618_6018 联盟子推客身份标识(不能传入接口调用者自己的pid)
autocoupon Number 默认1 如果有券时,是否直接把优惠券合并到推广链接上,可选值1或0,默认1用户先跳到领券页。指定0时推广链接直接跳到产品页,不领券。
couponUrl String http://coupon.jd..... 优惠券领取链接,如果您有指定券,可传入本参数。在使用优惠券、商品二合一功能URL入参时,materialId须为商品详情页链接。本参数需要urlencode编码
giftCouponKey String xxx_coupon_key 礼金批次号
channelId Number 12345 渠道关系ID
rid String 435676 团长的子渠道id,由团长自定义分配。取rid的优先级:入参rid优先materialId中拼接的rid,materialId中拼接的rid优先cps链接后面拼接的rid。
command Number 1 是否生成短口令:1生成,默认不生成
sceneId Number 1 场景ID,支持入参1,2;2需要权限申请
proType Number 5 5:种草版二合一
detail Number 默认0 是否需要更详细信息,传入可选值1,获取产品更多信息。

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/jd/promcommon?detail=1&materialId=10029266893811&siteId=1487944623&positionId=565561&vekey=xxx 

使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/jd/promcommon?detail=1&materialId=10029266893811&siteId=1487944623&positionId=565561&vekey=xxx";

$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/jd/promcommon?detail=1&materialId=10029266893811&siteId=1487944623&positionId=565561&vekey=xxx";
        // 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/jd/promcommon?detail=1&materialId=10029266893811&siteId=1487944623&positionId=565561&vekey=xxx"

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

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

返回值(JSON)

参数名称 参数类型 是否必选 示例值 描述
clickURL String http://union-click.jd.com/jdc?XXXXXXXXXX 生成的目标推广链接,长期有效
jCommand String 6.0复制整段话 http://JhT7V5wlKygHDK京口令内容#J6UFE5iMn*** 京口令(匹配到红包活动有效配置才会返回京口令)
商品detail字段 String[]   当有detail参数且为产品时才有,详情字段请参考,当转链的是店铺推广链接或活动链接,或会场链接时,没有返回详情字段。

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "0", "msg": "查询成功!", "data": { "clickURL": "https://union-click.jd.com/jdc?e=&p=JF8BAYMJK1olWwQHU11ZD0gRM28JGlgdXgEFXVZfAUsXMytXQwVKbV9HER8fA1UJWDdXTQxBAhlZAUEPVhcJWypcR0RMGFpfWhwHTEcXAm4LE1gSWg8KVlddCFxXDxtxaz5iBE9AI1w1WzJ0aDN8Yi9NOWJqEikVVT11Sj1OeC5mK2FbVRcpekpxYSZsWzhnB2VgVTYbfiJnZQ9SeAxjJFRhLT0mSj1uVTdsQStTPmRlNwpedDVnXD1oeAJtVGYAMA0pUTBSYzBoSztPNRIBIykvbC10AhsPeCJlNH9xNFgqVyt-eAxBRy98B1V7NwsBfD9jF219KzNeJlFcE1khazdtQzoKHzNuLgJqDy5RBHsXBmYOE14QWgUAZF5cCUsWAW0PG1MlVA8KXG5dCXtWbWgME14UXTYGU1pZD0snA2gOGVsdXwcDVFlUAHsXC2s4QBJDXgcDXG5tOEgnM18IGGsWbVhsVQ1VCEsUATxmRglKBkBGFw0zCEwWBGcOHF8SbQQDVVxfOHs" }, "request_id": "N5XKSJz" }

错误码

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

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部