更新时间:2025-10-16 GMT+08:00
分享

调用API流程

API调用者获取并调用在API网关中开放的API,减少开发时间与成本。

图1 调用API基本流程
  1. 获取API及文档
    • 获取API:从云商店购买,或者通过线下传递(如企业内部或者企业间合作)。
    • 获取文档:API的提供方会在云商店或者通过线下提供自己的参考文档,描述每个API的请求与响应参数详情、示例。华为云服务的API文档还可以从华为云帮助中心获取。
  2. 创建凭据并获取授权(APP认证)
    • 对于已发布到应用市场的API,可以直接通过购买获得凭据和授权,购买后可以直接调用API。
    • 对于未发布到应用市场且使用APP认证的API,需要在API网关中创建一个凭据,以生成应用ID和密钥对(AppKey、AppSecret)。将创建的凭据绑定API后,才可以使用APP认证调用API。您需要联系API提供者,提供您的凭据信息,获得授权。在API调用过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。
  3. 调用API
    调用接口有如下认证方式,选择其中一种进行认证鉴权。
    表1 API调用认证

    API认证方式

    方式说明

    APP认证

    通过API网关提供的AppKey和AppSecret进行签名认证。详情请参考使用APP认证调用API

    • 支持发布到应用市场。
    • 使用对象为API网关服务租户。

    华为IAM认证

    支持Token认证和AK/SK认证两种。详情请参考使用IAM认证调用API

    Token认证:通过Token认证调用请求。Token认证无需使用SDK签名,优先使用Token认证。

    AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)签名调用请求。其签名方式和APP认证相似。

    • IAM认证不支持发布到应用市场。
    • 使用对象为API网关服务租户。

    自定义认证

    如果您希望使用自己的认证方式,可以在函数服务中编写一个函数,将其作为您的认证服务。详情请参考配置API的自定义认证

    • 自定义认证不支持发布到应用市场。
    • 使用对象为API网关服务租户。

    无认证

    API网关对请求不进行认证。

    • 此方式不支持对API进行访问权限控制。
    • 不支持发布到应用市场。
    • 使用对象为任何公网用户。

相关文档