API文档中心

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

京东联盟礼金效果数据查询接口

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

您可以通过礼金批次ID或礼金商品SKUID实时查询礼金面额、剩余数量、有效期等基础信息,以及礼金的实时推广数据。

调用说明

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

接口请求地址

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

请求方式:GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数,接口秘钥,请在会员中心获取
skuId Number 是 7443197 查询该SKU您创建的推客礼金,以及该SKU您可推广的联盟礼金。 skuId和giftCouponKey二选一,不可同时入参。仅有sceneId=2权限时支持入参
giftCouponKey String 是 4f70ed5a367c94bf 根据礼金批次ID精确查询礼金信息,请勿和createTime同时传入。 skuId和giftCouponKey二选一,不可同时入参。
createTime String 否 2019-10-18 可查询此日期及以后创建的礼金,如不传则不限日期。 格式:yyyy-MM-dd
startTime String 否 2019-10-18 可查询此日期及以后下单的礼金效果数据,如不传则不限日期。 格式:yyyy-MM-dd
key String 否 1 工具商传入推客的授权key,可帮助该推客查询礼金效果数据。(需联系运营开通工具商权限才能拿到数据)
targetType Number 否 1 推广类型:默认为1;1:本账号创建礼金 2:合作推广礼金(本账号可推广的联盟礼金和其他账号定向给本账号或本账号下PID推广的礼金)
itemId String 否 Q9Z2ZdyMsa9g7jpsfgQNVA0R_3SD7M7ISbsR0zCKPoF 联盟商品ID

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.vepai.cn/jd/jd_coupongiftstop?vekey=xxx&giftCouponKey=b22c7c7f14f6cXXX 

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

$api="http://api.vepai.cn/jd/jd_coupongiftstop?vekey=xxx&giftCouponKey=b22c7c7f14f6cXXX";

$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.vepai.cn/jd/jd_coupongiftstop?vekey=xxx&giftCouponKey=b22c7c7f14f6cXXX";
        // 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.vepai.cn/jd/jd_coupongiftstop?vekey=xxx&giftCouponKey=b22c7c7f14f6cXXX"

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

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

返回值(JSON)

参数名称 参数类型 是否必选 示例值 描述
giftCouponKey String 否 4f70ed5a367c94bf 礼金批次ID
amount Number 否 100 礼金总张数
receiveNum Number 否 10 已发放数量
costNum Number 否 10 已使用数量
ygCommission Number 否 50 预估佣金
status Number 否 1 礼金状态(1:正常,2:停止)
receiveStartTime String 否 2019-10-14 00:00:00 领取开始日期(yyyy-MM-dd HH:mm:ss)
receiveEndTime String 否 2019-10-18 00:00:00 领取结束日期(yyyy-MM-dd HH:mm:ss)
effectiveDays Number 否 1 消费者领取后的有效期天数
costAmount Number 否 80 礼金实际消耗金额,订单中使用的礼金券面额总和
type Number 否 2 礼金类型 1.联盟礼金;2.推客礼金
skuIdList Number[] 否 [11144230] skuIdList
share Number 否 -1 是否限制每个推广链接仅可领取1张礼金:-1不限,1限制
contentMatch Number 否 0 是否允许通过内容平台推广,0:不允许,1:允许;默认为0
expireType Number 否 1 时间类型:1.相对时间,2.绝对时间
useStartTime String 否 2020-10-14 00:00:00 使用开始时间(yyyy-MM-dd HH:mi:ss)
useEndTime String 否 2020-10-20 23:59:59 使用结束时间(yyyy-MM-dd HH:mi:ss)
denomination Number 否 5 礼金面额
couponTitle String 否 礼金2020 礼金名称
showStatus Number 否 1 礼金状态(1:已停止,2:未开始,3:发放中,4:已结束,5:当天已结束,6:已抢光,7:当前时段已抢光,8:到达发放限额)
limitPlatforms Number[] 否 [1] 限制使用平台:1-京东APP,1033-京东极速版
contentMatchMedias Number[] 否 [17,18] contentMatch = 1 时此字段方生效,允许推广的媒体类型 -1:全部, 其他枚举值:17: 抖音,18: 快手,21: 微博,22: 知乎, 35: 斗鱼 ,38 : 手机QQ/全民K歌,43: 百家号图文,49: 微信小商店/腾讯微视,-1与其他枚举值互斥

返回示例

【提示】推广链接或口令有时效性,示例中链接与口令为创建文档时生成,仅用于展示返回结果,有可能已失效。

错误码

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

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部