自动化SDK使用指南
目录
一、新SDK的介绍 ......................................................................................................... 1 二、为什么要使用最新的SDK ..................................................................................... 1 三、如何使用最新的SDK ............................................................................................. 2
1、新SDK的目录结构 ........................................................................................... 2 2、SDK命名规则 .................................................................................................... 3 3、SDK使用代码示例(java版,php版,.net版) ..................................... 3 4、高级功能 .............................................................................................................. 6 四、下载SDK的地址 ..................................................................................................... 6
一、新SDK的介绍
淘宝开放平台最新的SDK是由程序通过API的结构、业务数据等自动化生成的代码包,目前支持主流的三种语言版本(java、php、.net)。是淘宝开放平台为了减少广大开发者使用API的开发成本而提供的一种开发工具包,其中包含了已经开放的API的请求、加密、返回解析等一些必要的功能(目前java sdk支持1.5及以上,.net sdk支持.net 2.0及以上,php sdk支持php5及以上)
二、为什么要使用最新的SDK
最新的自动化SDK区别之前的版本(前期为人工手写的代码),有着以
下多种优势:
1、 SDK代码全自动化生成,完全和对外公开的API文档一致 2、 自动化生成,避免人工编写产生的Bug
3、 在每次API升级发布后,会及时自动升级各语言SDK版本,并向下保持
兼容
4、 SDK提供了一些基本协议级的封装,提高API访问成功率 5、 错误日志自动打印,错误发生时可完全收集现场数据
三、如何使用最新的SDK
1、新SDK的目录结构
JAVA SDK目录结构
1 2 3 4 目录 com.taobao.api.domain com.taobao.api.request com.taobao.api.response com.taobao.api.internal 功能 API相关的数据结构包 API的请求参数封装类 API的返回结果封装类 SDK内部调用工具类,不保证以后升级不发生变化,不建议用户直接使用 5 com.taobao.api SDK的入口类,如:DefaultTaobaoClient .NET SDK目录结构
1 目录(命名空间) Top.Api.Domain.* 功能 API相关的数据结构包 2 3 4 Top.Api.Request.* Top.Api.Response.* Top.Api.* Top.Api.Util.* Top.Api.Parser.* API的请求参数封装类 API的返回结果封装类 SDK内部调用工具类,不保证以后升级不发生变化,不建议用户直接使用 5 Top.Api.ITopClient SDK的入口类,其实现类为DefaultTopClient
2、SDK命名规则
a) 数据结构类名与API线上文档中完全一样
b) API请求类名:去掉api名字中的”taobao”,把”.”后的首字母大写,
再掉所有的”.”号,并加上”Request”,即为最终的类名。比如taobao.user.get对应的请求类的类名为UserGetRequest。
c) API返回结果类名:去掉api名字中的”taobao”,把”.”后的首字母
大写,再掉所有的”.”号,并加上”Response”,即为最终的类名。比如taobao.user.get对应的响应类的类名为UserGetResponse。 d) 默认超时时间为5秒
3、SDK使用代码示例(java版,php版,.net版)
? JAVA版本
? 不需要登录(sessionKey)的API调用
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);