HTTP(s) API

使用本章节内容要求你的AWS PaaS平台 bin/conf/aws-portal.xml中 url属性值为实际的AWS PaaS平台访问地址

HTTP(s) API又叫Web API，开发者可以通过HTTP形式发起请求，获取JSON或XML的处理结果。由于HTTP被广泛的编程语言支持，开发者可以基于此HTTP形式与各种语言的企业应用进行交互。

在调用这类API之前，开发者需要向管理员申请API密钥，该秘钥由AWS CC的身份策略进行管理。包括访问凭证 ( access_key ) 和 私钥 ( secret )。

access_key将作为参数包含在每一个请求中发送，而secret负责生成请求串的签名，secret需要妥善保管，请勿外传。

技术规格

API请求结构

具体请求结构可在AWS PaaS控制台 > 连接服务 > 文档，Web API列表中查看。

API请求样例

一个典型的API请求如下所示

这是一个 app.install.check 的API请求

https://b2b.awspaas.com/api
?timestamp=1439277618461
&sig_method=HmacMD5
&cmd=app.install.check
&appId=com.actionsoft.apps.notification
&access_key=Salesforce#1
&format=json
&sig=DE90336BEDB0C3D3FE6DEE2FF0DF11AC

API返回结构

由请求参数format指定的数据格式，默认为json串。例如在Java客户端中，该参数运用如下：

//返回JSON结构
OpenApiClient client = new OpenApiClient(apiServer, accessKey, secret);
//或者
OpenApiClient client = new OpenApiClient(apiServer, accessKey, secret,
OpenApiClient.FORMAT_JSON);

//返回XML结构
OpenApiClient client = new OpenApiClient(apiServer, accessKey, secret,
OpenApiClient.FORMAT_XML);

API返回样例

一个典型的API请求返回结果如下所示

这是一个 app.install.check API的JSON结果

{
  "data" : true,
  "result" : "ok"
}

这是一个 app.install.check API的XML结果

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<boolResponse>
    <data>true</data>
</boolResponse>

如结果中无result标签项，等同于result值为ok