API测试

API测试可通过Postman测试工具来实现,Postman是一款强大的Http发包测试工具,可实现API的签名功能以及请求发送,充分验证API的可用性。
AK/SK、API-Token调用方式的使用步骤如下:

步骤一:准备请求内容

  • Request URL:在“API管理-API管理-API-点击API名称”中查看API详情,找到调用测试URL。

  • Body:填写位于Body位置的输入参数,请到「API管理-API-API详情」的请求示例中查看;

  • Headers:AK/SK、API-Token认证方式所需准备的Headers有所差异:

    • AK/SK准备内容

X-Auth-Key = "APP Key"; //请求的APP Key。请到「我的API-API调用」页面查看APP Key;
X-Auth-ActionId = "API Id"; //请求API的API Id。每个API拥有唯一的API Id,请到「API管理-API-API详情」中查看API ID;
X-Auth-Signature = "X-Auth-Signature"; //请求的签名,于[API签名]中配置完毕。
X-Auth-Timestamp = "X-Auth-Timestamp"; //时间戳;
  • Token准备内容

API-TOKEN: {API-TOKEN};//请求的API Token,请到「API管理-API-API详情」中查看。 +
APPID
APP KEY

步骤二:在Postman中发送请求。根据API的请求示例,填写Query、Header、Body中的内容,发送请求。

  • 请求示例

image.png
  • AK/SK示例

AKSK
AKSK调用
  • Token示例

AKSKTOKEN

步骤三:查看返回结果与数据库核对。

image.png
  • data[]:返回的数据

  • errorCode:返回状态码,对应的具体释义详见返回状态码

  • errorInfo:具体错误信息

  • Space:调用耗时(毫秒)

  • Success:调用状态(true/false)
    返回状态码对应的具体释义详见API返回状态码

注册API返回查询数据库后得到的直接结果,上述返回结果的部分字段不显示。