1)开发者注册一个账号。
2)然后为每个淘宝应用注册一个应用程序键(App Key) 。
3)下载淘宝API的SDK并掌握基本的API基础知识和调用。
4)利用SDK接口和对象,传入AppKey或者必要的时候获取并传入SessionKey来进行程序开发。
5)利用淘宝平台的文档中心和API测试工具,对接口进行测试。从而了解返回信息,方便程序获取。
6)无需以上五点,可直接注册账号调用接口,点击开通(Key和Secret)测试。
以上是一般淘宝API应用开发的关键流程,其中通过淘宝文档中心和API测试工具,进行概念了解和接口信息查询很重要。支持平台有淘宝、天猫、1688、京东、阿里巴巴、阿里妈妈、亚马逊、Eaby、lazada、拼多多、翻译接口等25个平台数据。
公共参数
请求地址:
环境 | HTTP地址 | HTTPS地址 |
---|---|---|
正式环境 | http://gw.api.taobao.com/router/rest | https://eco.taobao.com/router/rest |
沙箱环境 | http://gw.api.tbsandbox.com/router/rest | https://gw.api.tbsandbox.com/router/rest |
公共请求参数:
名称 | 类型 | 必须 | 描述 |
---|---|---|---|
method | String | 是 | API接口名称 |
app_key | String | 是 | TOP分配给应用的AppKey |
target_app_key | String | 否 | 被调用的目标AppKey,仅当被调用的API为第三方ISV提供时有效 |
sign_method | String | 是 | 签名的摘要算法,可选值为:hmac,md5,hmac-sha256。 |
sign | String | 是 | API输入参数签名结果,签名算法介绍请点击这里 |
session | String | 否 | 用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里。当此API的标签上注明:“需要授权”,则此参数必传;“不需要授权”,则此参数不需要传;“可选授权”,则此参数为可选 |
timestamp | String | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟 |
format | String | 否 | 响应格式。默认为xml格式,可选值:xml,json。 |
v | String | 是 | API协议版本,可选值:2.0 |
partner_id | String | 否 | 合作伙伴身份标识 |
simplify | Boolean | 否 | 是否采用精简JSON返回格式,仅当format=json时有效,默认值为:false |
公共响应参数:
名称 | 类型 | 描述 |
---|---|---|
request_id | String | 平台颁发的每次请求访问的唯一标识 |
error_response | String | 请求访问失败时返回的根节点 |
code | String | 请求失败返回的错误码 |
msg | String | 请求失败返回的错误信息 |
sub_code | String | 请求失败返回的子错误码 |
sub_msg | String | 请求失败返回的子错误信息 |
***_response | String | 请求成功返回的根节点,'***' 为API名称的下划线模式 |
请求参数
名称
类型
必须
示例值
描述
fields
String
true
tid,type,status,payment,orders
需要返回的字段列表,多个字段用半角逗号分隔,可选值为返回示例中能看到的所有字段。
tid
Number
true
123456789
交易编号
响应参数
名称
类型
示例值
描述
trade
Trade
搜索到的交易信息列表,返回的Trade和Order中包含的具体信息为入参fields请求的字段信息
请求示例
JAVA
PHP
.NET
CURL
Python
NodeJS
C/C++
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TradeGetRequest req = new TradeGetRequest();
req.setFields("tid,type,status,payment,orders");
req.setTid(123456789L);
TradeGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());
响应示例
<trade_get_response>
<trade>
<seller_nick>我在测试</seller_nick>
<pic_path>http://img08.taobao.net/bao/uploaded/i8/T1jVXXXePbXXaoPB6a_091917.jpg</pic_path>
<payment>200.07</payment>
<seller_rate>true</seller_rate>
<post_fee>200.07</post_fee>
<consign_time>2000-01-01 00:00:00</consign_time>
<received_payment>200.07</received_payment>
<order_tax_fee>0</order_tax_fee>
<tid>2231958349</tid>
<num>1</num>
<num_iid>3424234</num_iid>
<status>TRADE_NO_CREATE_PAY</status>
<title>麦包包</title>
<type>fixed(一口价)</type>
<price>200.07</price>
<discount_fee>200.07</discount_fee>
<total_fee>200.07</total_fee>
<created>2000-01-01 00:00:00</created>
<pay_time>2000-01-01 00:00:00</pay_time>
<modified>2000-01-01 00:00:00</modified>
<end_time>2000-01-01 00:00:00</end_time>
<buyer_message>要送的礼物的,不要忘记的哦</buyer_message>
<buyer_memo>上衣要大一号</buyer_memo>
<seller_memo>好的</seller_memo>
<buyer_nick>我在测试</buyer_nick>
<shipping_type>free</shipping_type>
<adjust_fee>200.07</adjust_fee>
<buyer_rate>true</buyer_rate>
<service_tags>
<logistics_tag>
</logistics_tag>
</service_tags>
<o2o>crm</o2o>
<o2o_guide_id>123456</o2o_guide_id>
<o2o_shop_id>123456</o2o_shop_id>
<o2o_guide_name>西湖门店导购员1</o2o_guide_name>
<o2o_shop_name>西湖门店</o2o_shop_name>
<o2o_delivery>inshop</o2o_delivery>
<orders>
<order>
</order>
</orders>
<eticket_service_addr>地址信息</eticket_service_addr>
<o2o_et_order_id>193753681999224</o2o_et_order_id>
<order_tax_promotion_fee>0</order_tax_promotion_fee>
<pmtp>GAP_MCARD^1001|</pmtp>
</trade>
</trade_get_response>
异常示例
如何获得此API测试, 点击注册账号测试
拥有此API的权限组 | 可获得/可申请此API权限组的应用类型 |
---|---|
获取单笔交易信息 | 进销存软件 ERP软件 商家后台系统 订单管理 商家应用-订单管理 国际商家后台系统 商家应用-ERP软件 商家应用-进销存软件 |
来源:oschina
链接:https://my.oschina.net/u/4242237/blog/4479891