调用API

约束与限制

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

前提条件

在调用API前，确保您所在网络与API的访问域名或地址互通。

获取API的调用信息

在调用API前，您需要向API提供方获取API的调用信息。

• 获取API的请求信息

  向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。

• 获取API的调用凭据

  根据API使用的安全认证方式不同，还要获取相关的请求认证信息，具体参考表1。

  表1 认证信息

  认证方式	认证信息
  APP认证（签名认证）	向API提供方获取该API所授权凭据的Key和Secret，以及认证签名所使用的SDK。
  APP认证（简易认证）	向API提供方获取该API所授权凭据的AppCode。
  APP认证（app_secret认证）	向API提供方获取该API所授权凭据的Key和Secret。
  APP认证（app_basic认证）	向API提供方获取该API所授权凭据的Key和Secret。
  IAM认证（AK/SK认证）	获取云服务平台的用户账号的AK/SK，以及认证签名所使用的SDK。
  无认证	无需认证信息。

调用API

1. 构造API请求，示例如下：

   POST https://{Address}/{Path}?{Query}
   {Header}
   
   {
     {Body}
   }

   • POST：请求方法，需替换为获取API的请求信息中获取的请求方法。
   • {Address}：请求地址，需替换为获取API的请求信息中获取的域名地址。
     

     API网关代理使用分组分配的子域名或分组绑定的域名调用API，无需另外配置。

   • {Path}：请求路径，需替换为获取API的请求信息中获取的URL。
   • {Query}：查询参数，可选，格式为“参数名=参数取值”，例如limit=10，多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。
   • {Header}：请求头参数，格式为“参数名: 参数取值”，例如Content-Type: application/json。需根据获取API的请求信息中获取的Headers进行设置。
   • {Body}：请求消息体，JSON格式。需根据获取API的请求信息中获取的请求参数进行设置。

2. 为API请求添加认证信息。

   API认证方式	API请求参数配置
   APP认证（签名认证）	使用获取的SDK对API请求进行签名。
   APP认证（简易认证）	在API请求中添加Header参数“X-Apig-AppCode”，参数值为获取API的认证信息中获取到的AppCode。
   APP认证（app_secret认证）	在API请求中添加Header参数“X-HW-ID”，参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API的认证信息中获取到的Secret。
   APP认证（app_basic认证）	在API请求中添加Header参数“Authorization”，参数值为"Basic "+base64(appkey+":"+appsecret)，其中appkey和appsecret分别为获取API的认证信息中获取到的Key和Secret。
   IAM认证（AK/SK认证）	使用获取的SDK对API请求进行签名。
   无认证	无需认证，可直接调用API。