调用开放的API

概述

API在发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。

获取API的请求信息

在调用API前，您需要向API提供方获取API的请求信息，包括访问域名、请求协议、请求方法、请求路径以及请求参数。

根据API使用的安全认证方式，还要获取相关的请求认证信息：

• APP认证：
  • 签名认证：向API提供方获取该API所授权集成应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。
  • 简易认证：向API提供方获取该API所授权客户端的AppCode。
  • 其他认证：向API提供方获取该API所授权集成应用的Key和Secret（或客户端的AppKey和AppSecret）。
• IAM认证：通过云服务平台的帐号凭证（帐号密码或者AK/SK）进行认证。如果使用AK/SK进行认证，还需要向API提供方获取用于调用API的SDK。
• 自定义认证：向API提供方获取请求参数中要携带的自定义认证信息。
• 无认证：无需认证信息。

若您使用系统分配的默认子域名访问API，该子域名每天最多可以访问1000次。

调用API

1. 配置请求地址相关参数。

   API调用场景	API请求参数配置
   使用域名调用API	ROMA Connect允许使用分组分配的子域名或分组绑定的域名调用API，无需另外配置。
   使用IP调用DEFAULT分组的API	ROMA Connect允许使用IP地址调用DEFAULT分组下的API，无需另外配置。
   使用IP调用非DEFAULT分组的API	ROMA Connect的实例配置参数“app_route”已设置为“on”，允许通过IP访问API。 ROMA Connect不允许使用IP地址直接调用非DEFAULT分组下的API，需要在请求消息中添加Header参数“X-HW-ID”，参数值为API所授权集成应用的Key或客户端的AppKey。

2. 配置认证参数。

   API认证方式	API请求参数配置
   APP认证（签名认证）	使用获取的SDK对API请求进行签名，具体请参考APP认证开发。
   APP认证（简易认证）	在API请求中添加Header参数“X-Apig-AppCode”，参数值为获取API的请求信息中获取到的AppCode。
   APP认证（app_secret认证）	ROMA Connect的实例配置参数“app_secret”已设置为“on”，开启app_secret认证，且“app_api_key”已设置为“off”，关闭app_api_key认证。 在API请求中添加Header参数“X-HW-ID”，参数值为API所授权集成应用的Key或客户端的AppKey。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API的请求信息中获取到的Secret或AppSecret。
   APP认证（app_basic认证）	ROMA Connect的实例配置参数“app_basic”已设置为“on”，开启app_basic认证。 在API请求中添加Header参数“Authorization”，参数值为"Basic "+base64(appkey+":"+appsecret)，其中appkey和appsecret分别为获取API的请求信息中获取到的Key和Secret（或AppKey和AppSecret）。
   APP认证（双重认证）	在API请求中同时携带APP认证和自定义认证的认证信息。
   IAM认证（Token认证）	先获取云服务平台的认证Token，然后在API请求中携带Token进行认证。
   IAM认证（AK/SK认证）	调用API时，使用获取的SDK对API请求进行签名，具体请参考IAM认证开发（AK/SK）。
   IAM认证（双重认证）	在API请求中同时携带IAM认证和自定义认证的认证信息。
   自定义认证	根据自定义认证的定义，在API请求参数中携带相关认证信息进行认证。
   无认证	无需认证，可直接调用API。