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

开发者

API 门户就像一个熙熙攘攘的市场,而**开发者(Developers)**是其最重要的客户。他们是构建者、创新者,也是推动 API 取得成功的驱动力。这些拥有技术技能的人员来到你的 API 门户,寻找他们创建出色应用程序、集成系统以及解决实际问题所需的数字工具和资源。

概览

开发者是 API 门户的最终用户。他们有能力执行以下操作:

  • 发现 API:浏览你的 API 目录并找到他们需要的功能。
  • 学习与实验:访问文档、教程和代码示例,以了解如何使用你的 API。
  • 试用 API:在集成 API 之前,使用 API 控制台或沙盒等交互式工具对其进行测试。
  • 订阅 API 产品:获取访问他们项目所需的特定 API 集合的权限。
  • 管理其使用情况:监控其 API 的消耗、跟踪他们的订阅情况并管理他们的 API 密钥。

使用场景

内部开发者

对于内部用例,请利用员工帐户通过单点登录(SSO)安全便捷地访问 API 门户。由于开发者和提供者可以使用他们现有的员工凭据,因此这种方法简化了用户管理。

合作伙伴开发者

对于合作伙伴用户,可以通过 SSO 或电子邮件注册来实现身份验证。

公共开发者

对于公共 API 门户,匿名用户可以查看 API 中心(API Hub)和文档页面。通过电子邮件进行用户注册需要管理员的批准。

开发者与消费者对比

消费者(Consumers)也可以管理 API 凭证,并通过插件利用访问控制,但与开发者相比,他们通常用于不同的场景。

开发者(Developers)消费者(Consumers)
凭证由开发者自行管理;对提供者不可见。由提供者管理。
API 访问控制开发者请求访问,提供者批准订阅。提供者可以直接将消费者添加至白名单/黑名单或从中移除。

开发者和消费者可以同时用于不同的 API,两者独立运作。然而,对于特定的已发布服务及其关联的 API 产品,应该使用 API7 网关的身份验证插件,或者是 API 产品的身份验证配置。

对于私有服务,通过 API7 网关内的消费者管理来限制访问;对于公共服务,将它们分组为定义明确的 API 产品,并通过 API 产品的配置来管理开发者访问。

强烈建议不要为同一个已发布服务同时组合使用 API7 网关身份验证插件和 API 产品身份验证配置(除非在非常特殊的情况下)。这会导致身份验证冲突,需要提供多个凭证才能成功进行 API 请求。

附加资源