利用京东联盟API获取自定义推广链接

By | 2015年6月28日
去评论本文

本文创建于3年前，内容已经老旧，京东页面也已经改版，请加群了解更多。

欢迎加入京东联盟技术讨论群（379480469）：

JDUnion技术讨论

接口没有权限？请看本文《京东联盟接口调用时的权限问题》

最新：利用联盟API做的一个chrome扩展，京东商品佣金查看，可以直接在商品详情页查看佣金信息。

【有困难的童鞋可以参考最新的文章http://www.coderecord.cn/jd-jos-api.html，把目前的http://devonios.com/app/jd/index.php这个demo的后台代码都贴上了】

本文将简单介绍下京东联盟、京东宙斯两个平台，以及如何利用京东宙斯平台的京东联盟API来快速获取自定义推广链接。

关于京东联盟

京东联盟（去官网看看）是一个CPS模式的营销平台，我们可以使用自己的网站放置联盟的推广链接为京东推销产品，当用户在我们的网站上点击了某个推广链接，并促成了真实的订单，那么我们将获得一定的佣金。

申请京东联盟的条件是必须有一个在国内的备案网站，这个是重点哦。使用京东帐号登录后，填写网站信息，等待审核即可。

强烈推荐先看下联盟的介绍和规则：http://media.jd.com/statc/help/hc.htm

关于京东宙斯

京东宙斯（去官网看看）是一个京东提供的API接口平台（基于oauth2验证），通过使用API，我们可以自己创建各种网站、无线应用来读取京东商品信息、活动信息等。商家可以通过API将自己的信息系统嵌入京东的各种服务系统。

本文将介绍如何使用京东宙斯中的京东联盟API来获取京东联盟自定义推广链接。

京东联盟自定义推广链接

自定义推广链接，可以使用京东上各种商品，各种活动页面的链接，其范围非常的广泛和实用。

在联盟管理界面中，我们可以看到生成自定义推广链接的操作非常简单：

自定义推广链接支持的链接有：京东首页、商品detail页、活动页面、店铺页面。

点击获取代码按钮后，会生成一个union开头的链接，我们把这个链接放置在网站上即可（这个链接只能在注册的网站上使用，通过其他方式打开的无效）。

我们自己可以点击这个链接，当我们自己在京东上购买商品时，也能获得佣金哦！（详细信息请看联盟帮助）

在京东宙斯平台注册为京东开发者

我们可以在京东联盟管理界面获取推广链接，但是每次都要登录，非常的繁琐！幸好，京东开放了京东联盟API，我们可以使用代码来自动获取！

首先，先用您的京东帐号登录京东宙斯平台（打开官网），然后填写开发者基本信息，即可完成注册开发者（不需要认证开发者），接着授权服务页面申请京东宙斯服务。

完成后会显示您已获得授权的服务：

创建一个应用

当我们成为注册开发者，授权京东宙斯服务后，我们需要创建一个应用，因为使用API是需要授权（access_token）的，而这个token是由我们创建的应用的APP key和App Secret生成，我们对API的请求记录都会记录在这个应用下面。

在创建应用界面，我们选择【买家】【无线应用】：

完成后，我们还需要完善下应用信息，填写下回调地址，回调地址的作用是在获取访问API的授权码(accecc_token)时的一个中间地址：

下一步，然后提交审核，应用的状态就变成上线运行中了，这时我们就可以正式开始使用应用证书中的APP key来获取Token了！

使用APPkey和APPSecrect获取Token

首先，奉上官网的文档：http://jos.jd.com/doc/channel.htm?id=152，有能力的你可以自行研究下~

这里，我使用的是第一种：Authorization Code来获取Token，好处是Token有效期能保持1年时间，每天30万次请求！我们现在只需要获取一次即可！

由于是基于Oauth2.0，所以流程很简单，先使用APPKey获取一个Code，然后结合Code再获取Token！

Code的获取是使用京东的登录页面，输入您的京东帐号信息后，得到授权之后会回到我们的回调地址上，此时回调地址上会带有一个code参数，这个参数就是我们需要的！

获取Code的请求（GET请求）链接： 

https://oauth.jd.com/oauth/authorize

有几个参数需要带上：

参数名称 参数选项 描述
response_type 必须 此流程下，该值固定为code
client_id 必须 即创建应用时的Appkey（从JOS控制台->管理应用中获取）
redirect_uri 必须 即应用的回调地址，必须与创建应用时所填回调页面url一致
state 可选 状态参数，由ISV自定义，颁发授权后会原封不动返回
scope 可选 权限参数，API组名串。多个组名时，用”，”分隔，目前支持参数值：read
view 可选

移动端授权，该值固定为wap；非移动端授权，无需传值

整理后完整的请求链接为： 

https://oauth.jd.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID& redirect_uri=YOUR_REGISTERED_REDIRECT_URI

只需要修改下client_id（即APP Key）和redirect_uri（回调地址，必须和创建应用时写的一样）即可。

使用浏览器访问这个链接，会定向到登录页面：

登录成功后，会跳转到我们写的回调地址上，此时我们可以获得code参数值！

现在我们可以使用Code值来获得token了。

获取token的请求链接： 

https://oauth.jd.com/oauth/token

参数有：

参数名称 参数选项 描述
grant_type 必须 授权类型，此流程下，该值固定为authorization_code
code 必须 授权请求返回的授权码
redirect_uri 必须 应用的回调地址，必须与创建应用时所填回调页面url一致
client_id 必须 即创建应用时的Appkey（从JOS控制台->管理应用中获取）
client_secret 必须 即创建应用时的Appsecret（从JOS控制台->管理应用中获取）
state 可选 状态参数，由ISV自定义，颁发授权后会原封不动返回

整理后完整的请求链接为： 

https://oauth.jd.com/oauth/token?grant_type=authorization_code&client_id=YOUR_CLIENT_ID&
redirect_uri=YOUR_REGISTERED_REDIRECT_URI&code=GET_CODE&client_secret= YOUR_APP_SECRET

使用浏览器访问这个链接，返回的是标准的json格式：

{
     "access_token": "您的Token值",
     "code": 0,
     "expires_in": 31622400,
     "refresh_token": "4a07031d-5122-4100-a60d-4ab982a55307",
     "time": "1435499129281",
     "token_type": "bearer",
     "uid": "您的京东帐号ID",
     "user_nick": "您的京东帐号昵称"
}

自此一个理论流程完成了！现在我们用php自动下，即获取code后自动发送获取token的请求，然后显示token内容。

PHP实现自动获取token的简单Demo

直接看代码把，非常简单哦，一个php文件： 

<?php

$response_type = "code";
$grant_type = "authorization_code";
$client_id = "这里改为您的APP Key";
$client_secret = "这里改为您的APP Secret";
$redirect_uri = "这里改为你的回调地址";
$state = "jdunion";
$codeurl = 'https://oauth.jd.com/oauth/authorize';
$tokenurl = "https://oauth.jd.com/oauth/token?";

$code = $_GET["code"];

if ($code != "")
{
  $fields = [
      "grant_type" => urlencode($grant_type),
      "client_id" => urlencode($client_id),
      "redirect_uri" => urlencode($redirect_uri),
      "code" => urlencode($code),
      "state" => urlencode($state),
      "client_secret" => urlencode($client_secret)
  ];

  $fields_string = "";
  foreach($fields as $key=>$value) {
     $fields_string .= $key.'='.$value.'&';
  }
  rtrim($fields_string, '&');

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $tokenurl.$fields_string);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  $result = curl_exec($ch);
  curl_close($ch);

  echo "Response：<br />".mb_convert_encoding($result,"UTF-8","GBK");

}
else
{
  header("Location: ".$codeurl."?response_type=".$response_type."&client_id=".$client_id."&redirect_uri=".$redirect_uri."&state=".$state);
}

您只需要将开头的几个值修改为自己的，然后访问这个php文件。

使用京东联盟API获取自定义推广链接

得到token后，妥善保管，现在开始的每个API请求都需要带上这个token值。

首先，我们要知道的是，访问API有个BaseUrl，这是整个宙斯（JOS）平台所有API的主链接，只是不同API的参数不同： 

https://api.jd.com/routerjson

JOS API里面有两种参数大类，一个是系统参数，即APP Key、Token这些验证信息，这是所有API都通用的，另一个是应用参数，即不同API它有自己的参数列表。

系统参数有下面这些：

名称

类型

必须

描述

method

String

是

API接口名称

access_token

String

是

采用OAuth授权方式为必填参数

app_key

String

是

应用的app_key

sign

String

是

签名

timestamp

String

是

时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟

v

String

是

API协议版本，可选值:2.0.

其中的method参数为API接口的名称，京东联盟API接口的名称是： 

jingdong.service.promotion.getcode

sign参数是对完整的请求链接md5加密后的字符串，加密规则如下：

  1. 所有参数名称按字母先后排序
  2. 将参数名与参数值拼起来，去掉&和=两个字符
  3. 在第2步中得到的字符串两端拼上App Secret值
  4. 对第3步中得到的字符串计算md5
  5. 把计算得到的MD5值转为大写形式
  6. 最后这个大写的MD5值即为我们要使用的sign参数的值

京东联盟API接口的应用参数有下面这些：

名称 类型 必须 示例值 描述
promotionType  Number  是  7 推广类型 1：商品推广，2：店铺推广，3：专柜推广，4：频道推广，7：自定义推广 系统目前暂时只支持自定义推广。 
materialId  String  是  http://www.jd.com 物料ID 1、推广类型是商品推广，推广物料ID对应着”skuid” 2、推广类型为店铺推广，推广物料ID对应着”shopID” 3、推广类型为频道页推广，推广物料ID对应着”频道页类目ID” 4、推广类型为自定义推广时，则该物料ID对应着”着陆页URL” 5、推广类型为专柜推广时，则该物料ID对应着“类目ID_类目ID_类目ID…” 
unionId  Number  是   联盟ID(京东客ID) 
subUnionId  String  否   子联盟Id（不能超过16个字符） 
siteSize  String  否   推广位尺寸，具体尺寸见FQA 
siteId  String  否   推广位ID 
channel  String  是   推广渠道 PC：pc推广，WL：无线推广 
webId  String  是   网站ID 
extendId  String  否   扩展ID 
ext1  String  否   扩展字段1 

promotionType参数这里目前只支持自定义推广，值为7。

materiaId参数为我们需要转换的京东网站链接（推广类型4，自定义推广），比如京东首页。

unionID参数为您的京东联盟帐号的ID，这个可以登录京东联盟网站后查看到。

webId参数为您在京东联盟网站注册的网站编号，也可以在联盟网站上找到。

知道这些参数后，我们需要开始构建请求的链接了。

首先应用参数在使用时需要构建成json格式拼接在BaseUrl上，使用的参数名叫： 

360buy_param_json

php实例：

$_360buy_param_json =
'{"channel":"'.$channel.'","materialId":"'.$sourceurl.'","promotionType":'.$type.',"unionId":"'.$unionId.'",
  "webId":"'.$webId.'"}';

现在根据以上系统和应用参数信息，拼接成完整的请求链接，使用浏览器请求即可，返回的格式是json。

下面是我写好的php代码： 

<?php

$sourceurl = $_GET["u"];

if($sourceurl == ""){

  echo "error:请输入url参数";
  exit();
}

$method = "jingdong.service.promotion.getcode";
$channel = "PC";
$type = 7;
$unionId = "您的京东联盟ID";
$webId = "您在京东联盟注册的网站的ID";
$token = "您的Token";
$appkey = "您的APPKey";
$appSecret = "您的APPSecret";
$v = "2.0";
$time = date('Y-m-d H:i:s',time());

$baseurl = "https://api.jd.com/routerjson?";

//应用参数，json格式
$_360buy_param_json =
'{"channel":"'.$channel.'","materialId":"'.$sourceurl.'","promotionType":'.$type.',"unionId":"'.$unionId.'",
  "webId":"'.$webId.'"}';

//系统参数
$fields = [
    "360buy_param_json" => urlencode($_360buy_param_json),
    "access_token" => urlencode($token),
    "app_key" => urlencode($appkey),
    "method" => urlencode($method),
    "timestamp" => urlencode($time),
    "v" => urlencode($v)
];

$fields_string = "";

//用来计算md5，以appSecret开头
$_tempString = $appSecret;

foreach($fields as $key=>$value)
{
    //直接将参数和值拼在一起
    $_tempString .= $key.$value;
    //作为url参数的字符串
    $fields_string .= $key.'='.$value.'&';
}

//最后再拼上appSecret
$_tempString .= $appSecret;

//计算md5，然后转为大写，sign参数作为url中的最后一个参数
$sign = strtoupper(md5($_tempString));

//加到最后
$fields_string .= ("sign=".$sign);

//最终请求的url
$link = $baseurl.$fields_string;

//发送get请求
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $link);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);

//转换为json
$jsonArray = json_decode($result,true);
$queryjs_result= $jsonArray["jingdong_service_promotion_getcode_responce"]["queryjs_result"];

$url = json_decode($queryjs_result,true);
echo urldecode($url["url"]);
?>

修改文件中的几个参数值，然后访问这个php文件，带上参数：u=京东链接（比如u=http://www.jd.com）。

最后页面将直接输出union打头的推广链接。

结束

到目前为止，我们已经有了一个php文件，通过参数u=京东链接形式，即可快速的得到推广链接。

注意，得到推广链接，直接访问它是没有任何效果的，需要将链接添加在京东联盟注册的网站中去，从这个网站点击跳转才能生效。

查看Demo：http://devonios.com/app/jd/index.php