API申请

开发人员及管理员可点击顶部的“API市场”，进入后，可通过单击API名称，进行API详情查看，并通过右边的“数据预览”服务在线测试API是否符合需求，随后点击“申请”进行API申请。

API详情查看

image.png

  • 基本信息：包括支持格式，请求协议，请求方式，超时时间，API ID等

    • API path: API测试URL(用于第三方工具测试，测试无误后可发布API至生产环境）中将包含 API path，不影响正式调用API的URL。
      API测试URL：…​/api/gateway/{项目英文名称}/{API path}/{API名称}
      API正式调用URL：…​/api/gateway/{项目英文名称}/{API名称}

    • 单用户单秒调用次数：限制单用户每秒对API的调用次数;

  • 参数配置：输入参数与返回参数。

  • 请求示例：不同调用方式下提供的request url,headers,body。

  • 返回结果：调用该API返回的json样例。

API数据预览

API市场为用户提供了数据预览的功能，用户可以点击任意所需查询的API右侧的数据预览按钮，便可进入数据预览的功能页面，在该页面中用户可以根据配置的输入参数输入相应的参数内容，点击结果查询便可在右侧的返回结果中浏览查询结果。

image.png

  • data[]：返回的数据

  • errorCode：返回状态码，对应的具体释义详见返回状态码

  • errorInfo：具体错误信息

  • Space：调用耗时（毫秒）

  • Success：调用状态（true/false）
    返回状态码对应的具体释义详见API返回状态码

注册API返回查询数据库后得到的直接结果，上述返回结果的部分字段不显示。
1、用户可以对任意状态（包括未申请、审批中和已审批状态）的API进行数据预览
2、数据预览中的输入参数为生成API时的配置信息，其中包含必填或非必填项

API申请

步骤一：API申请者查看API基础信息和对API数据进行预览判断此API是否符合使用需求，若符合，点击“API申请”按钮进行申请。

步骤二：API申请者填写申请次数、申请周期及申请原因。

主要功能及操作方式-df746.png

“API申请”根据申请次数、申请周期划分成多种申请方式：

  • 在限定周期内申请限定的API总使用次数：例如三天内对该API的总使用次数累计为1000次；

  • 不限周期内申请限定的API使用次数：对该API的总使用次数为N次，不限制次数的使用时间；

  • 限定周期内不限API使用次数：对该API的使用时限为N天，不限制时限内的使用次数，可无限次使用；

  • 不限制周期不限制API使用次数：可永久无限次使用该API；

1.目前系统暂不支持周期性申请限定的API使用次数，例如每天可使用N次。
2.用户可根据业务对API的需求选择合适的申请方式，当用户提交申请后，API管理者将会接收到该申请，进行授权审批。审批后，申请者可在我的API模块查看API的审批状态及详情。
如有多个需要申请的API，可勾选想要的申请的多个API点击批量申请，注意不支持跨页批量选择，只能同时处理同一页下的API。批量申请情况下，已申请或者申请中的API不会再重复申请。

步骤三：等待API管理员审批，审批后API申请者可在"API管理-我的API-API申请"模块查看审批状态，若通过后，可开始API调用。

image.png
审批通过

步骤四：管理已审批API，对于“已通过”状态的API，API申请者若不想使用，可点击“停用”停止使用该API。

已审批的API具有以下状态：

  • 已通过：表示授权审批通过，且仍在申请有效期内；

  • 已拒绝：表示授权审批未通过，API管理者拒绝该申请；

  • 已停用：表示API申请者主动停用了该API；

  • 取消授权：表示API管理者取消了对该申请者的授权，该申请者此API将不能调用；

  • 已过期：表示该申请者的API已经过期，需要重新申请。

取消授权后，申请者无法再次申请使用该API，需联系管理员审批页面中恢复该申请者权限。
恢复授权
← API测试
API授权 →