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

管理应用程序

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

应用程序管理由独立的开发者门户后端对外提供,而不是由控制台或 Provider Portal Admin API 提供。默认的开发者门户前端通过该后端读写应用程序,也可以直接调用这些端点。

应用程序结构

每个应用程序包含:

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

应用程序生命周期

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

  1. Created(已创建):由开发者在开发者门户中创建。
  2. Active(活动):开发者使用该应用程序订阅 API 产品并调用 API 时,应用程序处于此状态。
  3. Deleted(已删除):由开发者手动删除,或在删除开发者账户时级联删除。

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

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

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

以编程方式管理应用程序

应用程序端点运行在独立的开发者门户后端(默认为 :4321)上,而不是运行在 :7443 上的控制台管理 API。调用时,使用由 Provider Portal > Portal Settings > Tokens 颁发的门户令牌(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

参考页面列出了完整的参数、请求体和响应 Schema。/api/applications/api_calls 端点可多次使用 application_idapi_product_idcredential_id 过滤器,并且必须传入以 Unix 秒为单位的 start_atend_at 时间戳。

对于 JavaScript 和 TypeScript 集成,@api7/portal-sdk 包提供根据同一 OpenAPI 规范生成的类型化客户端。本参考页面固定使用 portal-sdk@1.1.0 附带的规范。安装相同版本(npm install @api7/portal-sdk@1.1.0)可与本文记录的 API 契约保持一致;如果要支持更新版本,请同时升级规范和 SDK。

信息

后端端点是固定的,并由 API7 控制面所有。门户前端获取门户令牌和解析当前开发者上下文的方式可能因实现而异,但端点本身不会变化。

其他资源