API服务

查找api

开放平台提供多种api服务,通过首页顶部的“api”进入列表页面,可以看到所有api服务及其所包含的方法,有官方提供的也有其它开发者提供的,也可以使用搜索来快速查询想要的api服务,如下图所示:

调用api

开发者在自己的网站或应用中需要调用api前,可以在本平台api方法中查看方法所包含的api说明信息、调用示例、参数信息等,以及使用测试按钮来参考api调用,下面将对各部分做说明:

api说明信息

包含各方法的功能解释,涉及的字段、参数、返回值、示例等信息,包含了开发者调用api所需的基本信息,如下图所示:

调用示例

api调用的部分代码示例文档或链接,包括成功、失败返回代码等的示例,对开发者调用api做一个指导,如下图所示:

参数信息

应用级输入参数,包含了参数名称、返回值、类型、描述等信息,使用者可根据需求自行输入相关参数值,如下图所示:

执行按钮

“执行api”,通过此按钮执行测试,给出测试结果让开发者可以对照,开发者自己脚本中调用的api若发现某些错误,则可以通过在平台执行api来参照。

在执行api前,由于本开放平台的api调用是用key来记录请求状态的,而每个key都属于某个应用,所以在执行前需要设置所调用的key,可以使用开发者key,也可以选择自己的应用所包含的key(点击key且无需手动输入,然后关闭弹窗即可),开发者key仅能调用自己发布的api或者个人中心中的基础api,而应用的key则可以调用平台或其它开发者的,如下图所示:

Api执行后,将给出执行示例,并且给出了多语言版本sdk及下载地址,如下图所示:


沪ICP备05002918号

© 2003-2017 ShopEx,Inc.All rights reserved.