Skip to main content

申请与审批

概述​

API平台的申请、审批过程比较简单，用户完成申请后，由「API管理员」或上级管理员进行审批，审批通过即可调用，若审批不通过，可再次发起审批。详细的API申请/审批过程可参考申请审批全过程

申请​

在API市场中点击「申请」按钮，在弹窗中补充如下信息：

  • 调用次数：申请此API需要使用多少次，也可勾选「不限制调用次数」。

  • 调用周期：申请者在多长时间范围内可以调用此API。时间范围选择天，表示从开始日期的00:00~结束日期的23:59。也可勾选「不限制调用时间」。

  • 调用次数、调用周期是「且」的关系，二者需同时满足情况下才可以调用API。

  • 申请说明：申请此API的理由，文本信息，不超过200字符。

info

由于API网关的分布式架构，可能会存在实际调用次数略大于申请次数的情况，但不会少于申请次数。

image-20230331170118830

审批​

API管理员及以上角色可进行API审批。审批入口位于「API管理-授权与安全-审批授权」页面，管理员可进行审批通过、拒绝等操作，详细的操作及状态流程可参考下面的申请审批状态流转

申请审批状态流转​

API自发起申请后，其状态流转与主要操作分为以下几类：

  • 管理员：通过，API为「已通过」状态，在此情况下
    • 管理员可以随时「取消授权/恢复授权」来随时控制此用户是否有权限调用。
    • 申请者可以通过「停用/启用」来控制自己是否可以调用此API。
    • 若API调用超出了限制的时间或者次数，则会进入「已过期」状态，需重新申请/审批使用。
  • 管理员：拒绝，API为「已拒绝」状态，需重新申请。
  • 下图为状态流转图，蓝色线条为申请者操作、红色线条为管理员操作。
info

除上述操作外，管理员还可以对API执行「禁用」操作，禁用后，所有已申请的API用户均不能继续调用此API，管理员可通过再次「发布」来恢复。

申请审批全过程