文档首页/ API网关 APIG/ 用户指南/ APIG业务使用流程
更新时间:2024-12-02 GMT+08:00

APIG业务使用流程

API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。

API网关支持专享版共享版(存量用户)功能。共享版功能已下线,当前仅存量用户可以使用,共享版功能操作指导请参考共享版操作指导(仅存量用户使用),其余为专享版功能操作指导章节。

使用流程

使用API网关进行API的托管流程如下图所示。

图1 业务使用流程
  1. 创建用户并授权使用APIG

    通过IAM服务创建用户并授权使用API网关,如果系统预置的APIG权限不满足授权要求,您也可以创建自定义策略。

  2. 创建APIG实例

    实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。因此,要开放API对外提供服务,首先需要创建实例。

    实例创建完成后,您可以通过配置实例参数调整组件的相关功能,配置APIG实例标签分组标记实例资源,配置APIG的终端节点信息连接终端节点服务,更多配置操作请参考管理APIG实例章节。

  3. 开放API

    将成熟的业务能力(如服务、数据等)作为后端服务,在API网关中开放API,提供给API调用者使用,实现业务能力变现。

    如果您需要把自己的认证系统用于API调用的认证鉴权,可以通过配置API的自定义认证来实现;需要对API进行参数编排,可以通过配置API的参数编排规则来实现;需要自定义API的错误响应信息,可以通过自定义API的错误响应信息来实现。更多API相关操作,请参考管理API

  4. 配置API调用授权(可选)

    使用APP认证方式的API,需要配置调用授权,把API授权给指定的凭据。API调用者使用凭据的Key和Secret进行API请求的安全认证,也可以使用凭据的AppCode进行简易认证。

    如果您需要限制API调用者在某个时间周期内的API调用次数,可以通过配置API认证凭据的配额控制来实现;如果您需要控制访问API的IP地址(API调用者的IP地址),可以通过配置API认证凭据访问控制来实现。

  5. 调用API

    通过获取API及API访问地址,调用API。根据API使用认证方式的不同,调用API时需要进行不同的认证鉴权操作。