API相关工具使用说明

一、API测试工具

 API测试工具,数据环境分为:测试(也称沙箱环境)、正式(包括应用正式测试环境、上线运行)。测试工具链接 

//open.taobao.com/apitools/apiTools.htm

1、 在测试环境下使用API测试工具须注意3点:

1)测试环境下的数据都是模拟线上的测试数据,不能与线上数据混淆。

2)当访问一个访问级别为“须用户登录",或须获取访问级别为"隐私数据须用户登录"的隐私数据时,就需要sessionkey.在测试环境下获取SessionKey,见如何获取sessionkey?

3)可以自定义App Key,用自己申请的App Key和App Secret来测试。

4)如何获取沙箱环境测试帐号?

界面预览

T1c.9eXdJyXXaCwpjX.png

2、在正式环境下使用API测试工具须注意3点:

1)正式环境下的数据都是真实的数据。

2)用系统默认的App Key测试时,通过点击“绑定用户”并用商家账号登录淘宝网来获取SessionKey,SessionKey有效时间为半个小时。如果要换商家测试,那么再次点击“绑定用户”重新获取SessionKey即可。绑定成功后,点击“提交测试”。

3)用自定义的App Key和App Secret测试时,在正式环境下获取SessionKey,见如何获取sessionkey?

【界面预览】

T1XEWeXltzXXaCwpjX.png

3、常见问题:

1)参数传入错误。一般是蓝色星号的参数没有传入。红色星号的参数为必传参数。还可能传入参数格式或者类型不对。错误排查参考错误码一览文档快速排查问题错误码排查工具

2)点击提交测试没反应。清除缓存或者换浏览器,但少数接口确实需要一定时间才能生成返回结果,如taobao.trades.sold.get 搜索当前会话用户作为卖家已卖出的交易数据。

3)接口调用限制只能塔内调用,如何使用测试工具。

在开发者中心后台——聚石塔本地测试添加需要测试的nick,就可以进行塔外IP测试了。

T1samEFA8cXXb1upjX.jpg

 二、API属性工具 

API属性工具,它的主要功能是生成商品属性(props)、销售属性(sku_properties)、自 定义类目属性(input_pids)和自定义属性值(input_str)。首先,选择商品类目,然后填写属性表单,最后点击“提交”就生成各种属性串 了。带*的为商品的必须属性,生成的属性串可作为访问API的参数。属性工具链接  //open.taobao.com/api_tool/props/

1、界面预览

 

T1y4SlXip5XXaCwpjX.png

 

2、使用介绍

 

数据环境可选择测试和正式,测试表示沙箱环境,正式表示正式环境。商品类目,可用taobao.itemcats.get 获取后台供卖家发布商品的标准商品类目获取。关键属性和销售属性以及非关键属性可用taobao.itemprops.get 获取标准商品类目属性获取。填选好相关参数点击提交就可以生成相关参数。显示在右边生成参数区域。一般用于发布产品和发布商品

 

三、错误码排查工具                   

 

 

1、工具介绍

                                                                 

通过API 名称和错误信息,可以快速定位错误原因,从而可以帮助ISV自己快速解决调用TOP接口过程中遇到的问题。访问地址: //open.taobao.com/apitools/errorCodeSearch.htm  。
                                                                                                                                                                                                                                 

2、操作步骤

                                                      

输入API名称(必填)和错误码(或者请求TOP获取完整的错误信息),点击搜索按钮,获取到具体的错误信息

  T1Mp2iXcdrXXaCwpjX.png                                                                       

3、执行逻辑

1)只输入API名称,返回该API下所有的业务错误码信息

2)输入API名称和具体的错误码(错误body),返回该API下具体的错误码信息。

3)如果未搜索到,提示未找到改错误信息。TOP会定期扫描,补充错误码信息。

                                                             

4、具体示例

1)只输入API名称,返回该API下所有的业务错误码信息。

 

 T1iuTkXidhXXaCwpjX.png                                             

 

                                                  

2)输入API名称和具体的错误码(错误body),返回该API下具体的错误码信息。

                       

 

T12EvkXlRXXXaCwpjX.png                                               

 

                                                                           

3)输入API名称和错误Body,即请求top返回的完整的错误信息,json 或xml格式 

 

T15g6iXj0rXXaCwpjX.png                                                   

 

                                                                         

4)点击错误信息链接,调到错误码具体解释页面           

注:我们会不断的对该错误信息进行优化

 T1EZPkXh8iXXaCwpjX.png                                                                               

 

 

FAQ

  • 关于此文档暂时还没有FAQ