4.2.4 SDK调用接口
SDK是通过php方式对外提供接口的, 详细的接口信息, 请阅读SDK安装目录下的htdocs/dcsdk_functions.php, 提供了全局变量、 函数和相关的接口。
(1)卖家数据; (2)店铺数据; (3)店铺类目数据; (4)宝贝数据; (5)友情链接数据; (6)URL数据;
链接地址:http://wiki.zx.taobao.com/index.php/SDK%E5%BC%80%E6%94%BE%E6%8E%A5%E5%8F%A3%E8%AF%A6%E8%A7%A3#.E5.8F.8B.E6.83.85.E9.93.BE.E6.8E.A5.E6.95.B0.E6.8D.AE
一: 卖家数据
(1)数据详解; (2)获取方式; (3)使用实例;
1. 数据详解
卖家ID:id;
卖家昵称: nick;
注册时间: registerationDate;
国家:country;
省份: province;
城市: city;
信用: sellerCredit;
好评率: sellerGoodRate;
2. 获取方式
在模板上通过$_user获取当前的卖家信息;
3. 使用实例
<?php
$_user->credit; ??
?>
二: 店铺数据
(1)数据详解; (2)获取方式; (3)使用实例;
1. 数据详解
店铺id:id;
店铺标题: title;
店铺域名: domainName;
店铺logo: shopLogo(新版头部上用到的那种);
店标: logoUrl(原先老的80x80的);
店铺主营: mainBusiness;
收藏人气: collectedCount;
宝贝数量: itemCount;
店主昵称: ownerNick;
店主标识: ownerId;
开店时间: startTime;
店铺简介: introduction;
店铺公告: bulletin;
店铺页面链接: shopPageLinks;
2. 获取方式
$_shop;
页面链接信息通过“shopManager”来获取;
3. 使用实例
<?php
$_shop->id;
/*获取首页链接*/
$pageLinks = $shopManager->getShopPageLinks();
foreach ( $pageLinks as $pageLink)
{
echo "页面名称".$pageLink->text;
echo "页面链接".$pageLink->href;
echo "页面打开目标".$pageLink->target;
echo "页面是否高亮".$pageLink->highLight;
}
?>
三: 店铺类目数据
(1)数据详解; (2)获取方式; (3)使用实例;
1. 数据详解
店铺类目ID: id;
店铺类目名称: name;
店铺类目图标: iconUrl;
父类目ID: parentId;
类目所属店铺ID: shopId;
2. 获取方式
通过shopCategoryManager获取, shopCategoryManager的说明如下:
(1)查询所有的店铺的一级类目: queryAll;
(2)查询店铺类目的所有子类目: querySubCategories; 注: 此方法需要传递父类目id;
(3)根据店铺类目标识查询店铺类目: queryById; 注: 此方法需要传递类目id;
3. 使用实例
<?php
/* 查询所有的店铺一级类目数据 */
$allShopCategory = $shopCategoryManager->queryAll();
foreach($allShopCategory as $shopCategory)
{
echo "店铺类目名称是".$shopCategory->name;
}
/* 查询店铺类目的所有子类目 */
$subCategories = $shoCategoryManager->querySubCategories ($parentId);
foreach($subCategories as $shopCategory)
{
/* 查询店铺类目中的一级类目: 此时$parentID = 0, 即所有一级类目的父类id=0 */
/* 查询店铺中的二级类目: 把已经查到一级类目的类目id作为parentId, 查询店铺类目中的二级类目 */
echo "店铺类目的名称是".$shopCateory->name;
}
/* 根据店铺类目标识查询店铺类目 */
$shopCategory = $shopCategoryManager->queryById($Id);
echo "店铺类目名称是".$shopCategory->name;
?>
四: 宝贝数据
(1)数据详解; (2)获取方式; (3)使用实例;(4)宝贝图片尺寸
1. 数据详解
宝贝id: id;
宝贝后台类目: itemCategoryID;
宝贝标题: title;
宝贝价格: price;
宝贝图片地址: picUrl;
宝贝销售量: soldCount;
宝贝收藏量: collectedCount;
宝贝所属卖家id: ownerId;
宝贝评论数: commentCount(此属性只有商城店铺有, C店铺没有);
宝贝销售量:
2. 获取方式
设计师通过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 | 以热门搜藏降序排序 | 否 |
3. 使用实例
(1)根据关键字查询宝贝:
<?php
/* 查询关键字为IPAD的10个宝贝, 按照热销降序排列 */
$itmes = $itemManager->queyByKeyword("IPAD","hotsell",10);
foreach($itmes as $item)
{
echo "宝贝标题".$item->title;
echo "宝贝价格".$itme->price;
}
?>
(2)根据店铺类目ID查询该类目下的宝贝:
<?php
/* 根据类目ID查询10个宝贝, 按照热销降序排列 */
$itmes = $itmeManager->queryByCategory($categoryId, "hotsell", 10);
foreach($itmes as $item)
{
echo "宝贝标题".$item->title;
echo "宝贝价格".$itme->price;
}
?>
(3)根据指定的宝贝Id查询对应的宝贝数据:
<?php
/* 根据ID查询宝贝 */
$item = $itemManager->queryById($id);
echo "宝贝标题".$item->title;
echo "宝贝价格".$item->price;
?>
(4)根据一组宝贝ID查询宝贝:
<?php
/* 根据ID列表查询宝贝 */
$ids = array(123456, 654321);
$itmes = $itemManager->queryByIds($ids, "hotsell");
foreach($items as $item)
{
echo "宝贝标题".$item->title;
echo "宝贝价格".$item->price;
}
?>
4. 宝贝图片大小
现在支持的图片大小有: 40x40、60x60、80x80、100x100、120x120、160x160、220x220、310x310、620x10000
获取不同尺寸图片
<?php
/* 根据ID查询宝贝 */
$item = $itemManager->queryById($id);
echo "宝贝图片120x120".$item->getPicUrl(120);
echo "宝贝图片220x220".$item->getPicUrl(220);
?>
五: 友情链接数据
1. 数据详解
友情链接:id
友情链接标题: title
用户标识: userId
友情链接URL: url
2. 获取方式
FriendLinkManager 接口说明如下:
查询当前用户所有友情链接: queryAllLinks
参数说明此接口不需要参数, 获取当前用户的所有友情链接。
3. 使用实例
<?php
/* 查询当前用户所有的友情链接 */
$friendLinks = $friendLinkManager->queryAllLinks();
foreach($friendLinks as $friendLink)
{
echo "友情链接".$friendLind->title;
}
?>
六: URL数据
(1)数据详解; (2)获取方式; (3)使用实例;
1. 数据详解
宝贝详情页URI;
搜索列表页URI;
评价页面URI;
店铺介绍页面URI;
店铺类目URI;
收藏店铺URI;
旺旺链接URI;
2. 获取方式
(1)生成宝贝详情页的URI:detailURI
参数说明:此接口需要传递宝贝对象作为参数
<?php
$uriManager->detailURI($item);
?>
(2) 生成搜索列表页的URI:searchURI
参数说明: 此接口不需要参数
<?php
$uriManager->searchUri();
?>
(3) 生成当前用户的评价页面URI: rateURI
参数说明: 此接口不需要参数
<?php
$uriManager-rateURI();
?>
(4)生成当前店铺介绍页面的URI:shopIntrURI
参数说明: 此接口无需参数
<?php
$uriManager->shopIntrURI();
?>
(5)生成店铺类目对应的URI: shopCategoryURI
参数说明: 此接口需要传递店铺类目对象作为参数, 当点击生成uri时, 本地sdk会自动跳转到searchList.htm, 而此URI最终会渲染searchList.php页面。
<?php
$uriManager->shopCategoryURI($shopCategory);
?>
(6)生成收藏店铺URI:favoriteLink();
参数说明: 此接口不需要参数, 默认获取收藏当前店铺的URI;
<?php
$uriManager->favoriteLink();
?>
(7) 生成旺旺链接URI: contactTag()
参数说明: 此接口需要传递用户的旺旺名称;
<?php
$uriManager->contactTag("nick");
?>
链接地址:http://wiki.zx.taobao.com/index.php/SDK%E5%BC%80%E6%94%BE%E6%8E%A5%E5%8F%A3%E8%AF%A6%E8%A7%A3#.E5.8F.8B.E6.83.85.E9.93.BE.E6.8E.A5.E6.95.B0.E6.8D.AE

浙公网安备 33010602011771号