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

管理应用程序

应用程序是开发者创建的用于对 订阅凭证 进行分组的容器。每个应用程序都属于一个开发者(或者,在组织模式下,属于一个活动的组织上下文)。

应用程序管理由独立的 开发者门户后端公开,而不是仪表板/提供商门户管理 API。默认的开发者门户前端通过该后端读写应用程序,同样可以直接调用端点。

应用程序结构

每个应用程序包含:

组件描述
订阅指向 API 产品的链接,这些产品授予应用程序使用 API 的访问权限。
凭证身份验证令牌(API 密钥、基本身份验证凭证、OAuth 客户端)用于通过网关对 API 请求进行身份验证。
标签用于分类和过滤的可选键值对。

应用程序生命周期

应用程序遵循以下生命周期:

  1. 由开发者门户中的开发者创建
  2. 活跃,开发者使用其订阅的 API 产品并进行 API 调用。 3、被开发者删除或者开发者账号删除时级联。

删除应用程序也会删除其所有凭证并取消其所有订阅。对于 OAuth (DCR)凭证,注册的客户端也会从身份提供商中删除。

从开发者门户 UI 管理应用程序

用于创建、查看和删除应用程序的最终用户工作流程记录在面向开发者的指南中:

以编程方式管理应用程序

应用程序端点运行在独立的开发者门户后端(默认 :4321)上,而不是 :7443 上的仪表板管理 API 上。它们使用从 提供商门户 > 门户设置 > 令牌 颁发的门户令牌 (a7prt-…) 和标识活动开发者或组织上下文的 X-Portal-Developer-ID 标头进行身份验证。

对应用程序的所有操作都记录在 开发者门户 API 参考 中,包括:

运营端点
创建应用程序POST /api/applications
列出应用程序GET /api/applications
获取应用程序GET /api/applications/{application_id}
更新应用程序PUT /api/applications/{application_id}
删除应用程序DELETE /api/applications/{application_id}
获取 API 调用统计GET /api/applications/api_calls

参考页面列出了完整的参数、请求正文和响应架构。 /api/applications/api_calls 端点特别接受可重复过滤器(application_idapi_product_idcredential_id)和所需的 start_at / end_at Unix 秒时间戳。

对于 JavaScript 和 TypeScript 集成,@api7/portal-sdk 包根据相同的 OpenAPI 规范生成类型化客户端。此参考页固定到 portal-sdk@1.1.0 附带的规格;安装该确切版本 (npm install @api7/portal-sdk@1.1.0) 以与此处记录的合同保持一致,或者在支持较新版本时一起升级。

:::信息

后端端点已固定并归 API7 控制面所有。门户前端如何获取门户令牌并解析活动开发者上下文可能因实现而异;端点本身没有。

:::

其他资源