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

开发者

开发者是发现、订阅和使用 API 的开发者门户用户。开发者不同于 API7 网关用户(管理网关基础设施)和消费者(用于访问控制的提供商管理的身份)。

注册方式

开发者可以通过多种方法加入:

方法描述
自助注册开发者使用电子邮件和密码直接在开发者门户上注册。需要内置身份认证选项才能启用自注册。
邀请在默认门户实现中,组织所有者和管理员通过电子邮件邀请用户加入组织。根据产品版本和部署方式,Provider Portal UI 中也可能提供开发者邀请流程。
SSO开发者通过在门户上配置的外部身份提供商(OIDC、SAML、LDAP 或 CAS)进行身份认证。请参阅配置 SSO
SCIM 预配用户账户使用 SCIM 2.0 协议从身份提供商(例如 Okta)自动同步。

账户状态

开发者账户有两种可能的状态:

状态描述
Pending(待审批)开发者已注册,但账户尚未获批。处于待审批状态的开发者无法访问受保护的 API 产品或创建订阅。
Active(活动)开发者账户已获批,可以使用全部功能。

当自助注册需要审批时(已禁用 registration_auto_approval),新账户将进入 Pending(待审批) 状态。管理员必须先在 Provider Portal 中批准注册,开发者才能使用门户。

如果启用注册自动审批,新账户将立即进入 Active(活动) 状态。

组织

在基于 API7 Developer Portal Boilerplate 的默认开发者门户实现中,开发者属于某个组织。每个组织与 Provider Portal 中的开发者身份一一对应。

组织支持三种角色:

角色权限
Owner(所有者)完全访问权限,包括管理组织成员和设置。
Admin(管理员)与所有者权限相同。
Member(成员)对组织资源拥有只读访问权限。
备注

组织模型来自默认开发者门户实现使用的身份认证系统(Better Auth)。如果你在没有 Better Auth 的情况下构建自定义开发者门户,则组织概念可能不适用。

开发者与消费者

开发者和 消费者 都代表访问 API 的实体,但它们有不同的用途:

方面开发者消费者
管理方开发者通过开发者门户管理自己的凭证。提供商通过控制台或 Admin API 管理消费者凭证。
访问控制开发者通过订阅 API 产品请求访问权限,提供商负责审批订阅。提供商直接将消费者分配到允许列表或拒绝列表。
用例面向内部、合作伙伴或公共开发者的自助 API 访问。由提供商控制的内部服务访问或系统间集成。

开发者和消费者可以共存于同一部署中。但是,对于给定服务,请使用 API 产品身份认证(开发者凭证)或网关插件身份认证(消费者凭证),而不是同时使用两者。在同一服务上混合使用身份认证方法可能会导致冲突,每个请求需要多个凭证。

级联删除

删除开发者账户后,以下资源也会被删除:

  • 开发者拥有的所有应用程序
  • 与这些应用程序相关的所有凭证
  • 所有订阅(有效和待审批)
  • 所有待审批请求

其他资源