更新时间:2024-04-03 GMT+08:00

调用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认证:通过云服务平台的账号凭证(账号和密码获取Token或者AK/SK)进行认证。如果使用AK/SK进行认证,还需要向API提供者获取用于调用API的SDK。
  • 自定义认证:向API提供者获取请求参数中要携带的自定义认证信息。
  • 无认证:无需认证信息。

调用API

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

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

    API调用场景

    API请求参数配置

    使用域名调用API

    使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。

    使用IP调用非DEFAULT分组的API

    使用IP地址直接调用非DEFAULT分组下的非APP认证的API,需要在请求消息中添加Header参数“host”。

  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。