一些云服务提供商及其OpenStack,vCloud,OnApp等服务提供平台正越来越多地通过API或Web服务进行编程。要使用这些API / Web服务,我们需要开发一个接口。对于如今大部分的云平台或者云服务,我们在开发API接口方面有着丰富的经验。本博客旨在分享我们的经验,并提供为云服务或者云平台开发web服务接口的一些方案
API接口是必需的,原因如下:
以下是为云平台/服务开发高效和有效接口的一系列步骤
API特性包括API类型,认证机制和请求/响应方式。
通常,API通过REST(Representational State Transfer,表述性状态传递)或SOAP(Simple Object Access Protocol,简单对象访问协议)公开。REST正在逐渐成为标准,并且取代了一些旧的SOAP API。根据文章后面的表1中的数据,这一点非常明显。
每个云平台都使用不同类型的认证机制来访问API,了解这些认证机制很重要。典型的例子如下:
基本身份验证使用用户名和密码的经典组合,并通过base64编码方式进行编码,这是在授权HTTP头中提供的。
示例: 授权:Base64(用户名:密码)
请求:
Headers: Content-type: application/xml
Authorization: Basic dG9ib3RyYXM6cTE=
Method: GET
API: http://api.xyzcloud.com:4465/paci/v1.0/ve
IPaddress | host - api.xyzcloud.com
PortNo – 4465
Path – paci/v1.0/ve
响应:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ve-list>
<ve-info subscription-id='100001' name='web' state='created' description='Web Server'/>
</ve-list>
基于令牌的认证提供基于用户认证的临时令牌。资源到期时需要刷新临时令牌。内部认证处理程序根据请求头中提供的令牌进行认证。
请求:
Headers: Content-type : application/json
Method: POST
API: https://api.myapplication.com/user/accessToken
请求体
{
userName:'my username',
password:'my password',
token_type:'mac'
}
响应:
{
“access_token”: “okKXxMWOEhnM78Rie02ZjWjP7eQqpp6V”,
“mac_key”:”vV6xEfVgQZv4ABJ6VZDHlQfCaqKgFZuN”,
“mac_algorithm”:”hmac-sha-1”,
“token-type”:”mac”,
“expires_in”:3600,
“refresh_token”:”nZSiH3L5K4febMlELguILucrWpjRud56”
}
安全套接字层是一种标准的安全技术,用于在服务器和客户端之间建立加密链接 - 通常是web服务器(网站)和浏览器。SSL认证需要在订阅下将SSL证书上传到平台。API终端需要通过SSL证书进行认证。
多重身份验证(MFA)在用户名和密码之上添加了一层额外的保护。MFA支持的API需要第一因子的用户名和密码以及来自MFA设备的验证码作为第二因子。这些多重因素为API端点提供了更高的安全性。
API的请求和响应类型需要考虑馈送输入和消耗输出。API请求和响应可以是XML或JSON。接口需要根据接口要求转换响应
云平台/服务的API接口可以通过以下选项进行开发
下表显示了一些领先的云服务提供商和平台的API支持。
注意: Google表格中提供了这些 云服务API的详细信息。鼓励服务提供商和其他读者更新其云端的API端点,以便作为开发人员的简单参考。
通过API文档了解您的平台支持的API操作,并确定您想要使用的操作。在你开始使用API之前,最好通过管理门户或仪表板进行操作去了解它们的运行原理。您使用API需要做的第一件事是进行身份验证,然后您可以在执行创建选项之前尝试基本的读取操作。
API端点与云平台管理网址不同。API端点通常包括主机,端口和路径。如果它是一个REST API,它还包含一个认证key和密钥。使用POSTMAN,RESTClient等工具验证这些平台或服务的API端点的可访问性。对于基于令牌的身份验证,我们需要生成令牌并在RESTClient中提供令牌。
在API验证之后,我们需要知道云平台或服务对给定用户的授权情况。
云平台/服务为用户帐户使用的资源强加限额。最好先了解配额限制。OpenStack管理员可以定义用户使用的每个项目中资源的限制。
云服务提供商检查资源定价非常重要。云服务提供商针对每月,每小时或每分钟收取资源费用。消费前了解定价非常重要,否则我们的账单会有惊喜。详细了解服务提供商提供的免费服务也是非常重要的,这样我们才不会感到意外。
希望这对你有所帮助。享受API接口的开发过程吧...