开发者门户简介
API7 开发者门户是一个连接 API 提供商和 API 消费者的平台。提供商可以发布 API 产品并管理开发者访问权限;开发者则可以通过自助服务发现、订阅和使用 API。
架构
开发者门户由两个组件组成:
- Provider Portal:内置于 API7 控制台中,管理员可以在其中管理 API 产品、门户设置、开发者账户和订阅审批。
- 开发者门户:一个独立的 Web 应用程序,开发者可以在其中浏览 API、创建应用程序、管理凭证以及订阅 API 产品。
Provider Portal 和开发者门户通过门户 API 连接。当管理员发布需要身份认证的 API 产品时,门户 API 会将身份认证配置推送到网关数据面。随后,开发者使用凭证通过网关访问 API。
关键概念
| 概念 | 描述 |
|---|---|
| API 产品 | 面向开发者发布的一组 API 服务,以及相关文档、身份认证要求和订阅策略。 |
| 开发者 | 在开发者门户中发现、订阅和使用 API 的用户。 |
| 应用程序 | 开发者创建的容器,用于对特定项目或用例的订阅和凭证进行分组。 |
| 订阅 | 开发者应用程序与 API 产品之间的关系,用于授予应用程序使用 API 的权限。 |
| 凭证 | 开发者用于对 API 请求进行身份认证的凭证,例如 API Key(API 密钥)、基本身份认证凭证或 OAuth 客户端凭证。 |
用例
开发者门户支持三种主要部署模型:
- 内部 API 门户:在组织内共享 API。开发者使用企业 SSO 进行身份认证,API 产品的范围仅限于内部服务。
- 合作伙伴 API 门户:通过受控访问向受信任的合作伙伴公开 API。可以使用 SSO,也可以使用需要管理员审批的电子邮件注册方式。
- 公共 API 门户:通过具有自助注册和订阅管理功能的面向公众的门户向外部开发者提供 API。
你可以同时运行多个门户实例,每个实例为不同的受众提供不同的 API 产品目录和访问策略。
提供商与开发者工作流程
| 方面 | 提供商(管理员) | 开发者 |
|---|---|---|
| 访问入口 | API7 控制台 | 独立部署的开发者门户 |
| 主要操作 | 创建 API 产品、管理开发者、审批订阅、配置 SSO | 浏览 API、创建应用程序、订阅产品、管理凭证 |
| 身份认证 | API7 网关用户账户 | 门户专用账户(电子邮件、SSO 或 SCIM 预配) |
| 定制能力 | 不可定制 | 可全面定制品牌、主题和域名 |