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

API 门户

API7 门户(API Portal)是一个集中式的在线平台,充当 API 提供者(API Providers)与开发者(Developers)之间的桥梁。

概览

API7 门户主要用于:

  • 展示 API:就像商店橱窗一样,它展示了可用的 API、其功能以及如何使用它们。
  • 促进访问:允许开发者自行注册、订阅 API 并管理其使用情况。
  • 支持测试:提供交互式 API 参考(API Reference),允许开发者在集成 API 之前,直接使用其 API key 对 API 进行测试。

下图展示了 API7 门户的架构,说明了 API 提供者和开发者如何交互,以及门户如何与 API7 企业版的其他组件及其数据库集成。

面向 API 提供者

  • 提高 API 采用率:使开发者更容易发现和使用他们的 API。
  • 提升开发者体验:为所有与 API 相关的信息和支持提供一个中心枢纽。
  • 更好的 API 管理:允许对 API 的访问、使用和文档进行集中控制。
  • 货币化潜力:可用于打包和销售 API 访问权限。

面向开发者

  • 简化的 API 发现:在一个集中的位置轻松找到他们所需的 API。
  • 更快的集成:访问全面的文档和测试工具有助于加快集成过程。
  • 提高生产力:通过快速获取所需信息、减少在研究和集成上花费的时间,从而简化开发工作流。
  • 连接社区:与其他开发者建立联系、分享知识并获得支持。

使用场景

API7 门户主要有三个使用场景:

  • 内部 API 门户:专供组织内部使用,促进团队之间的 API 共享与协作。这有助于保持 API 设计的一致性、防止重复开发,并实现内部 API 的集中管理。
  • 合作伙伴 API 门户:用于安全地与合作伙伴组织的开发者共享 API,同时限制公众访问。可以为每个合作伙伴定制 API 产品的可见性。
  • 公共 API 门户:充当向外部开发者提供 API 的市场,通过 API 订阅实现货币化机会。

你还可以实施混合方法,结合内部、合作伙伴和公共 API 门户的元素。这种灵活性使你能够:

  • 定制开发者管理策略:针对内部开发者、外部合作伙伴和公共用户实施不同的身份验证和授权机制。
  • 自定义 API 可见性和访问控制:为不同用户组定义细粒度的访问级别和可见性规则。
  • 提供免费和付费 API 产品的组合:在货币化公共 API 的同时,提供对内部和合作伙伴 API 的免费或受限访问。

这种混合方法提供了极大的灵活性,并使你能够根据特定的需求和业务目标来定制 API 门户。

提供者门户与开发者门户对比

API7 门户由两个不同的控制台组成:

  • 提供者门户(Provider Portal):专为管理员和 API 提供者设计。此控制台与 API7 网关共享相同的域名和入口点,简化了用户体验和访问。它使管理员能够有效地创建、管理和监控 API。
  • 开发者门户(Developer Portal):专为开发者发现、探索和使用 API 而设计。

这种双控制台结构明确分离了职责,并增强了提供者和开发者的整体用户体验。

开发者门户(Developer Portal)提供者门户(Provider Portal)
用户内部或外部用户(独立于网关用户)同时也是 API7 网关用户的内部用户
域名独立域名API7 企业版域名(与 API7 网关相同)
自定义 UI支持不支持

附加资源