调用API

获取API及文档

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

调用API

本章节仅提供请求地址和认证参数的配置指导，客户端的其他参数配置需要用户自行调整，如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损，建议参考业界标准进行配置。

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

   API调用场景	API请求参数配置
   使用域名调用API	使用服务分配的调试域名或服务绑定的域名调用API，无需另外配置。
   使用IP调用DEFAULT分组的API	API允许使用IP地址调用DEFAULT分组下的API，无需另外配置。
   使用IP调用非DEFAULT分组的API	使用IP地址直接调用非DEFAULT分组下的APP认证的API： 将实例的配置参数“app_route”和“app_secret”设置为“on”。开启“app_route”之后，同一凭据不能授权给相同请求路径和方法的API。 在请求消息中添加Header参数“X-HW-ID”和“X-HW-APPKEY”，参数值为API所授权凭据的Key和Secret或客户端的AppKey和AppSecret。 使用IP地址直接调用非DEFAULT分组下的非APP认证的API，需要在请求消息中添加Header参数“host”。

2. 配置认证参数。

   API认证方式	API请求参数配置
   APP认证（签名认证）	使用获取的SDK对API请求进行签名，具体请参考《API网关开发指南》的“使用APP认证调用API”章节。
   APP认证（简易认证）	在API请求中添加Header参数“X-Apig-AppCode”，参数值为获取API及文档中获取到的AppCode。具体请参考快速入门。
   APP认证（app_secret认证）	实例的配置参数“app_secret”已设置为“on”，开启app_secret认证。 在API请求中添加Header参数“X-HW-ID”，参数值为API所授权的Key或客户端的AppKey。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API及文档中获取到的Secret或AppSecret。
   APP认证（app_basic认证）	实例的配置参数“app_basic”已设置为“on”，开启app_basic认证。 在API请求中添加Header参数“Authorization”，参数值为"Basic"+base64(appkey+":"+appsecret)，其中appkey和appsecret分别为获取API及文档中获取到的Key和Secret（或AppKey和AppSecret）。
   IAM认证（Token认证）	先获取云服务平台的认证Token，然后在API请求中携带Token进行认证，具体请参考《API网关开发指南》的“Token认证”章节。
   IAM认证（AK/SK认证）	调用API时，使用获取的SDK对API请求进行签名，具体请参考《API网关开发指南》的“AK/SK认证”章节。
   自定义认证	在API请求参数中携带认证信息进行认证。
   无认证	无需认证，可直接调用API。