淘宝模板开发系列之开放接口详解
SDK是通过php方式对外提供接口的，详细的接口信息，请阅读SDK安装目录下的htdocs/dcsdk_functions.php，提供了全局变量、函数和相关的接口。
目录[隐藏]
|
卖家数据
数据详解
• 卖家ID：id
• 卖家昵称：nick
• 注册时间: registrationDate
• 国家 ： country
• 省份 ： province
• 城市 ： city
• 信用 ： sellerCredit
• 好评率：sellerGoodRate
测试想sss
获取方式
设计师在模板上通过$_user获取当前的卖家信息。
使用实例
credit;
/*获取卖家好评率*/
$_user->goodRate;
/*获取卖家ID*/
$_user->id;
/*获取卖家昵称*/
$_user->nick;
/*获取卖家注册时间*/
$_user->registrationDate;
/*获取卖家国家*/
$_user->country;
/*获取卖家省份*/
$_user->province;
/*获取卖家城市*/
$_user->city;
?>
店铺数据
数据详解
店 铺 id： id
店铺标题： title
店铺域名： domainName
店铺logo： shopLogo（新版头部上用到的那种）
店 标： logoUrl（原先老的80x80的）
店铺主营： mainBusiness
收藏人气： collectedCount
宝贝数量： itemCount
店主昵称： ownerNick
店主标识： ownerId
开店时间： startTime
店铺简介： introduction
店铺公告： bulletin
店铺页面链接： shopPageLinks
数据详解
设计师在模板上通过$_shop获取当前的店铺的信息,其中页面链接信息通过“shopManager”来获取。
此处有细微变动，请设计师认真阅读：
/*获取首页链接*/
$shopManager里面，不再有getShopPageLinks方法
使用实例
id;
/*获取店铺名称*/
$_shop->title;
/*获取店铺简介*/
$_shop->introduction;
/*获取店铺公告*/
$_shop-> bulletin;
/*获取店铺ID*/
$_shop->id;
/*获取店铺标题*/
$_shop->title;
?>
$pageLinks =$shopManager->getShopPageLinks();
foreach($pageLinks as $pageLink){
echo "页面名称".$pageLink->text;
echo "页面链接".$pageLink->href;
echo "页面打开目标".$pageLink->target;
echo "页面是否高亮".$pageLink->highLight;
}
?>
店铺类目数据
数据详解
店铺类目ID : id
店铺类目名称 : name
店铺类目图标 : iconUrl
父类目ID : parentId
类目所属店铺ID ： shopId
获取方式
店铺类目获取通过ShopCategoryManager获取，ShopCategoryManager的说明如下：
1. 查询所有的店铺一级类目：queryAll
参数说明：此接口不需要参数，查询当前店铺的所有店铺类目
2. 查询店铺类目的所有子类目：querySubCategories
参数说明：此方法需要传递父类目id
3. 根据店铺类目标识查询店铺类目：queryById
参数说明：此方法需要传递类目id
使用实例
查询所有的店铺类目：
queryAll();
foreach($allShopCategory as $shopCategory){
echo "店铺类目名称是: ".$shopCategory->name;
}
?>
查询店铺类目的所有子类目：
querySubCategories ($parentId);
foreach($subCategories as $shopCategory){
echo "店铺类目名称是: ".$shopCategory->name;
}
?>
查询店铺类目中的一级类目:此时$parentId=0,即所有一级类目的父类目的id=0
查询店铺类目中的二级类目：把已经查到一级类目的类目id作为$parentId,查询店铺类目的二级类目
根据店铺类目标识查询店铺类目:
queryById ($Id); echo "店铺类目名称是: ".$shopCategory->name; ?>
宝贝数据
数据详解
宝贝ID ： id
宝贝后台类目 ： itemCategoryId
宝贝标题 ： title
宝贝价格 ： price
宝贝图片地址 ： picUrl
宝贝销售量 ： soldCount
宝贝收藏量 ： collectedCount
宝贝所属卖家ID ： ownerId
宝贝评论数 ： commentCount (此属性只有商城店铺有，C店铺没有)
宝贝销售量 ： soldCount
获取方式
设计师通过ItemManager获取宝贝数据，ItemManager的接口说明如下：
1. 根据关键字查询宝贝：queryByKeyword)
参数说明：此接口需要传递3个参数，分别为查询关键字，宝贝排序类型，查询数量，其中宝贝排序类型具体见下表，此接口最多返回20个宝贝。
2. 根据店铺类目ID来查询该类目下的宝贝： queryByCategory
参数说明：此接口需要传递3个参数，分别为店铺类目id，宝贝排序类型，查询数量，其中宝贝排序类型具体见下表，此接口最多返回20个宝贝。
3. 根据指定的宝贝Id查询对应的宝贝数据：queryById
参数说明：此接口需要传递1个参数宝贝ID，如果没有查询到宝贝则返回空
4. 根据一组宝贝ID查询宝贝，返回的宝贝最大个数为20个：queryByIds
参数说明：此接口需要传递2个参数，分别为待查询的宝贝ID列表以及排序类型，其中宝贝排序类型具体见下表，此接口最多返回20个宝贝。
宝贝排序规则：
| 排序标识 | 说明 | 是否默认显示 |
| ceofp | 人气宝贝升序排序 | 是 |
| _ceofp | 人气宝贝降序排序 | 否 |
| hotsell | 热销宝贝升序排序 | 否 |
| _hotsell | 热销宝贝降序排序 | 否 |
| price | 以宝贝价格升序排序 | 否 |
| _price | 以宝贝价格降序排序 | 否 |
| newOn | 以最新上架宝贝升序排序 | 否 |
| _newOn | 以最新上架宝贝降序排序 | 否 |
| HotKeep | 以热门搜藏升序排序 | 否 |
| _HotKeep | 以热门搜藏降序排序 | 否 |
使用实例
根据关键字查询宝贝：
queryByKeyword ("IPad","hotsell",10);
foreach($items as $item){
echo "宝贝标题: ". $item->title;
echo "宝贝价格: ". $item->price;
}
?>
根据店铺类目ID查询该类目下的宝贝：
queryByCategory ($categoryId,"hotsell",10);
foreach($items as $item ){
echo "宝贝标题:". $item->title;
echo "宝贝价格:". $item->price;
}
?>
根据指定的宝贝Id查询对应的宝贝数据:
queryById ($id); echo "宝贝标题:". $item->title; echo "宝贝价格:". $item->price; ?>
根据一组宝贝ID查询宝贝:
queryByIds($ids,"hotsell");
foreach($items as $item ){
echo "宝贝标题:". $item->title;
echo "宝贝价格:". $item->price;
}
?>
宝贝图片大小
现在支持的图片大小有：40x40、60x60、80x80、100x100、120x120、160x160、220x220、310x310、620x10000
获取不同尺寸的图片 queryById ($id); echo “宝贝图片120x120”. $item->getPicUrl(120); echo “宝贝图片220x220”. $item-> getPicUrl(220); ?>
友情链接数据
数据详解
友情链接id ： id
友情链接标题 : title
用户标识 : userId
友情链接URL : url
获取方式
友情链接数据通过FriendLinkManager接口获取，FriendLinkManager的接口说明如下：
1. 查询当前用户的所有友情链接：queryAllLinks
参数说明：此接口不需要参数，获取当前用户的友情链接
使用实例
查询当前用户的所有友情链接：
queryAllLinks ();
foreach($friendLinks as $friendLink ){
echo "友情链接：". $friendLink ->title;
}
?>
URL数据
数据详解
宝贝详情页URI
搜索列表页URI
评价页面URI
店铺介绍页面URI
店铺类目URI
收藏店铺URI
旺旺链接URI
获取方式
1. 生成宝贝详情页的URI: detailURI
参数说明：此接口需要传递宝贝对象作为参数
detailURI($item);?>
2. 生成搜索列表页的URI: searchURI
参数说明：此接口不需要参数
searchURI();?>
3. 生成当前用户的评价页面URI: rateURI
参数说明：此接口不需要参数
rateURI();?>
4. 生成当前店铺介绍页面的URI: shopIntrURI
参数说明：此接口不需要参数
shopIntrURI();?>
5. 生成店铺类目对应的URI:shopCategoryURI
参数说明：此接需要传递店铺类目对象作为参数，当点击生成的uri时,本地sdk会自动跳转到searchList.htm，而此URI最终会渲染searchList.php页面
shopCategoryURI ($shopCategory);?>
6. 生成收藏店铺URI：favoriteLink
参数说明：此接口不需要参数，默认获取收藏当前店铺的URI
favoriteLink();?>
7. 生成旺旺链接URI：contactTag(userNick)
参数说明：此接需要传递用户的旺旺名称
contactTag ('nick');?>
新增子旺旺的数据接口
旺旺客服标签
$uriManager->supportTag 方法和参数详细介绍
提供了四种调用模式,
单个参数模式,参数为客户旺旺的ID.
supportTag("客服旺旺ID号");
?>
两个参数模式,参数为: 客户旺旺ID,旺旺点灯图片提示消息(等价于 ![提示消息]()
)
supportTag("客服旺旺ID号","请点击直接访问");
?>
三个参数模式,参数为: 客户旺旺ID,旺旺点灯图片提示消息(等价于 ![提示消息]()
),旺旺点灯的图片样式(1为默认新样式,二为老样式)
supportTag("客服旺旺ID号","请点击直接访问",1);
?>
四个参数模式,参数为: 客户旺旺ID,旺旺点灯图片提示消息(等价于 ![提示消息]()
),旺旺点灯的图片样式(1为默认新样式,二为老样式),E客服分流.
supportTag("客服旺旺ID号","请点击直接访问",1,false);
?>
相关知识请参考: http://wangwang.taobao.com/2010_fp/world.php
使用实例
生成宝贝详情页的URI：
detailURI($item); ?>
生成搜索列表页的URI：
searchURI(); ?>
生成评价页面的URI:
rateURI (); ?>
生成店铺介绍页面的URI:
shopIntrURI (); ?>
生成店铺类目URI::
shopCategoryURI($shopCategory) ?>
生成收藏店铺URI：favoriteLink
favoriteLink() ?>
生成旺旺链接URI：contactTag(userNick)
contactTag('nickname')
?>