本文主要引导大家通过开放平台官方提供的API测试工具,进行一次API的调用,并对调用的逻辑和结果进行一些简单的讲解。
测试工具地址 点击查看。
调用TOP的API接口时,即是与TOP服务器进行一次数据交互的过程,所有的API都是基于REST基础的接口规范,可兼容多种编程语言,同时大部分API都支持http post和http get两种方法,但对于写操作的接口只支持http post方法,推荐大家使用http post方法。
API测试工具是TOP基于开放的API做成的工具,提供给开发者快速测试TOP接口,如果您刚了解TOP,您可以通过测试工具简单了解TOP API的调用原理;如果您已经在使用TOP API,您可以通过测试工具进行接口调试。
进入API测试工具,如图:
以通过测试环境获取指定淘宝账号的信息为例。
1)选择返回结果(XML或json)和需要测试调用的API。
2)TOP提供测试和正式两种环境,开发者可以现在测试环境调试代码,然后选择到正式环境,此处获取正式nick账号信息,选正式。
3)通常写接口只能用POST,读接口GET,POST都可以。
4)TOP目前提供三种语言的SDK,选择不同的语言点击提交测试相应的示例代码会在SDK调用示例代码显示。
5)此处选择系统分配的appkey appsecret,点击自定义可以自定义输入appkey appsecret sessionkey(说明:当API的访问级别为‘公开’时,sessionkey不需要填写;当API的访问级别为‘须用户登录’时,sessionkey必须填写;当API的访问级别为‘隐私数据须用户登录’时,sessionkey可填可不填)。
6)点击绑定用户,输入你的nick,相当于授权给系统分配的这个appkey获取该用户信息的权限,如果不绑定直接输入nick只能获取该账号的公开信息。
点击提交测试获取返回结果,返回结果解释见下图:
调用API时,API调用端(即用户调用接口运行的程序),调用API服务端的数据(即TOP提供的服务器,可调用淘宝上的数据)时的交互流程。
更多API调用介绍参见:?API调用原理介绍。