跳到主要内容
版本:3.10.x

应用程序

应用程序是开发者在开发者门户中创建的容器,用于对特定项目或用例的订阅凭证进行分组。应用程序在开发者和他们使用的 API 产品之间提供了一个组织层。

目的

应用程序有多种用途:

  • 逻辑分组:处理多个项目的开发者可以为每个项目创建单独的应用程序,从而使凭证和订阅保持井井有条。
  • 凭证隔离:每个应用程序都有自己的一组凭证。撤销或轮换一项申请的凭证不会影响其他申请。
  • 订阅管理:订阅是在应用程序级别创建的。开发者将应用程序订阅到 API 产品,而不是直接订阅开发者账户。
  • 使用情况跟踪:可以跟踪每个应用程序的 API 使用情况统计信息,从而了解哪个项目正在使用哪些 API。

结构

一个应用程序包含以下字段:

领域描述
姓名应用程序的人类可读名称。
描述应用程序用途的可选描述。
标签用于分类的可选键值对。

每个应用程序都属于单个开发者,并且仅限于单个门户。应用程序由创建时生成的唯一 ID 来标识。

与其他实体的关系

  • 一个开发者可以拥有多个应用程序。
  • 一个应用程序可以订阅多个 API 产品。
  • 一个应用程序可以包含多个凭证(不同类型)。
  • 订阅将应用程序链接到 API 产品。

生命周期

  1. 创建:开发者在开发者门户中创建应用程序,提供名称和可选描述。
  2. 订阅:开发者向应用程序订阅一件或多件 API 产品。根据产品的配置,订阅可能需要批准。
  3. 添加凭证:开发者在应用程序内创建凭证。凭证类型必须与订阅的 API 产品上启用的身份验证类型之一匹配。
  4. 使用:开发者使用凭证通过网关发出经过身份验证的API 请求。
  5. 删除:删除应用程序也会删除其所有凭证并取消其所有订阅。

其他资源