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需要妥善保管,请勿外传。
技术规格
项 | 说明 |
---|---|
访问协议 | HTTPS/HTTP |
提交方式 | POST/GET,推荐POST |
业务参数 | JSON |
返回结果 | JSON/XML |
编码格式 | UTF-8 |
API请求结构
项 | 说明 |
---|---|
API入口 | Portal URL + /api,例如:https://b2b.awspaas.com/api |
公共参数 | - cmd api名称(必须) - access_key 访问凭证(必须) - sig 请求消息的签名(必须),见下说明 - sig_method 签字算法,支持:HmacMD5 - format 处理结果数据格式。支持json和xml,默认为json - timestamp 请求时间,long型毫秒值,默认和服务器事件不能超过6分钟 |
业务参数 | 一个json串,见相关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);
项 | 说明 |
---|---|
result | 状态码。ok代表成功,error代表失败 |
errorCode | 错误码。如果result值为error时,提供错误代码 |
msg | 结果信息。如果result值为error时,提供错误描述信息 |
data | 业务数据 |
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
![](https://docs.awspaas.com/help/userimages/user.png)
Seven
![](https://docs.awspaas.com/help/userimages/tel.png)
010-62962343-690
![](https://docs.awspaas.com/help/userimages/mail.png)
liujx@actionsoft.com.cn
感谢您对该文档的关注!如果您对当前页面内容有疑问或好的建议,请与我联系。如果您需要解答相关技术问题请登录AWS客户成功社区