Skip to main content

API市场

API市场是所有用户申请API、浏览已开放的API的入口，从首页进入API产品后，点击「API市场」即可进入。

API浏览​

进入API市场后，可通过搜索、过滤等各类条件查看API信息，如下图所示。点击某个API，可查看其入参、出参、调用方式、返回结果样例等详细信息。

image-20230914143246175

点击左侧类目管理的不同按钮，其功能为：

  • ①：将所有类目收起至第一层级。
  • ②：进入类目管理页面，可对类目的层级、顺序进行调整。
  • ③：将类目管理区域收缩起来，便于浏览API内容。

类目管理

类目管理​

如上文的截图，点击「类目管理」icon，进入类目管理页面。与「API管理」页面的类目管理类似，同样仅支持3层目录，可编辑目录层级，但目前不支持调整API类目的顺序。

info

API市场中的类目与API管理中的目录是单独管理的，二者没有关系。

Q：如何指定API在API市场中的所属类目？

A：在创建/编辑API时，API市场目录是单独指定的，详情可查看API生成-API市场分类

数据预览​

若在API创建/编辑时开启了「允许用户在API市场进行数据预览」，在API市场中可以预览此API的调用返回结果。在API市场的列表中，点击每个API最右侧的...扩展菜单中的「数据预览」按钮即可。

数据预览页面类似API创建过程中的测试，便于申请方以JSON或者CSV方式预览查询结果。

image-20230914144640993

API申请​

在API市场中点击「申请」按钮，在弹窗中补充信息后，完成申请。详细的API申请、审批过程可参考API申请与审批

两种API市场模式​

API市场支持项目级市场和租户级市场两种模式，两种模式的差异如下：

  • 租户级市场（默认值）：每个项目是独立的API开发及管理团队，可能会涉及跨项目的API申请、使用。适用于API数量较多、业务方较多、管理复杂的场景。
  • 项目级API市场：开发、使用在某个项目内可完成。适用于API数量较少，业务需求简单的场景。

我的API​

已审批​

已审批中包含所有已经做过审批操作的API,包括通过审批和未通过审批.

image-20230914141938362

文档导出​

我的API已审批界面支持授权状态为已授权、停用状态的API导出.导出可选择想要导出的内容 image-20230914145959418

未审批​

未审批界面可查看在身处审批流程中的API

image-20230914142913863

调用说明​

调用说明包含用到的所有加密手段的详细说明.可查看USER-TOKEN,AK-SK,身份签名,RSA+AES,SM2+AES加密等多种方式的具体信息

image-20230914143124019