在调用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认证:通过云服务平台的帐号凭证(帐号和密码获取Token或者AK/SK)进行认证。如果使用AK/SK进行认证,还需要向API提供者获取用于调用API的SDK。
自定义认证:向API提供者获取请求参数中要携带的自定义认证信息。
无认证:无需认证信息。
步骤 1配置请求地址相关参数。
API调用场景 | API请求参数配置 |
---|---|
使用域名调用API | 使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。 |
使用IP调用DEFAULT分组的API | 专享版API允许使用IP地址调用DEFAULT分组下的API,无需另外配置。 |
步骤 2配置认证参数。
API认证方式 | API请求参数配置 |
---|---|
APP认证(签名认证) | 使用获取的SDK对API请求进行签名,具体请参考《开发指南》的“使用APP认证调用API”章节。 |
APP认证(简易认证) | 在API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API及文档中获取到的AppCode。 |
IAM认证(Token认证) | 先获取云服务平台的认证Token,然后在API请求中携带Token进行认证,具体请参考《开发指南》的“Token认证”章节。 |
IAM认证(AK/SK认证) | 调用API时,使用获取的SDK对API请求进行签名,具体请参考《开发指南》的“AK/SK认证”章节。 |
自定义认证 | 在API请求参数中携带认证信息进行认证。 |
无认证 | 无需认证,可直接调用API。 |