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

API 门户(API Portal)

API7 门户是 API7 企业版推出的 API 门户产品, 是一个集中式的在线平台,充当 API 提供者和 开发者 之间的桥梁。

概述

API7 门户主要用于:

  • 展示 API: 就像商店橱窗一样,它展示了可用的 API、它们的功能以及如何使用它们。
  • 提供文档: 提供详细的指南、教程和代码示例,以帮助开发者理解和集成 API。
  • 方便访问: 允许开发者自行注册、订阅 API 并管理其使用情况。
  • 支持测试: 通常包括 API 控制台或沙盒等交互式工具,供开发者在集成 API 之前进行试用。

对于 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 门户。

提供者门户 vs 开发者门户

API7 门户包含两个不同的控制台:

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

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

开发者门户提供者门户
用户内部或外部用户,非 API7 网关用户内部用户,也是 API7 网关用户
域名独立域API7 企业域,与 API7 网关相同
自定义 UI支持不支持

相关阅读