您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
具有社交发布功能的开发者门户正日益用于与开发者社区进行通信。这包括传达静态内容(例如 API 文档、使用条款),以及社区贡献的动态内容(如博客和论坛)。
作为 API 提供方,您需要一种方法来公开 API、向开发者介绍 API、注册开发者,以及让开发者注册应用。向开发者公开您的 API 只是打造真正充满活力的社区的一小部分。您还需要为开发者社区提供一种方式,让他们能够提供反馈、提出支持请求和功能请求,以及提交可供其他开发者访问的自己的内容。
Apigee Edge 为您提供了一个 Developer Services 门户,您可以使用该门户构建和发布自己的自定义网站,以便向开发者社区提供所有这些服务。每个 Edge 客户都可以在云端或本地创建自己的开发者门户。
以下视频介绍了 Apigee 开发者服务门户。
下图显示了默认开发者门户的首页:
开发者门户本质上是基于开源 Drupal (http://www.drupal.org) 项目的内容管理系统 (CMS)。Drupal 以模块的形式提供一组核心功能,可让您轻松构建和管理网站内容。
利用开箱即用的开发者门户,您可以创建 API 文档、支持博客以及提供跟帖式论坛。您还可以自定义开发者门户,以满足您的特定要求。借助自定义功能,您可以修改门户的外观,以及开发者与门户互动的方式。
您可以使用 Drupal 菜单执行大多数自定义操作。如果您以具有管理员权限的用户身份登录门户,则 Drupal 菜单会显示在每个门户页面的顶部:
管理控制开发者请求访问门户的流程、开发者注册访问您 API 的应用的方式、您如何向开发者分配与您的 API 相关的特定角色和权限,以及何时撤消开发者对 API 的访问权限。
您还可以使用开发者门户配置和控制创收功能。借助创收功能,开发者可以通过开发者门户自助访问结算和报告、目录和方案以及创收专用设置。
门户用户类型
下图显示了两种类型的门户用户:
- 开发者是指使用您的 API 构建应用的用户社区。应用开发者可以通过该门户通过 SmartDocs 了解您的 API、在门户上注册账号、注册使用您的 API 的应用、与开发者社区互动,以及在信息中心查看有关其应用使用情况的统计信息。
-
API 团队是指 API 提供方,负责创建门户内容、向应用开发者提供其 API、提供 API 文档,并为开发者提供注册应用和获取 API 密钥的机制。API 团队会对开发者门户进行基本配置,以便:
- 配置 API 密钥的自动或手动请求
- 维护 API 文档、论坛和博客,并可选择修改所有更改
- 处理用户评论和论坛审核
- 强制执行基于角色的访问权限控制 (RBAC),以控制对门户上功能的访问权限。 例如,管理员可以启用控件,允许注册用户创建论坛帖子或使用测试控制台
- 为管理员和开发者自定义有关用户创建和审批的电子邮件通知
- 自定义“与我们联系”页面等网络表单
此图中未显示第三种门户用户:API 产品经理。API 产品经理负责定义 API 团队构建门户的方式,包括:
- 定义 API 如何打包到产品中
- 定义应用审批规则
- 如果在门户上启用了创收功能,请为 API 产品定义定价和结算方案。如需详细了解创收,请参阅创收概览。
自定义开发者门户
作为 API 提供方,您需要考虑如何自定义开发者门户,以便其最适合您的 API,并为开发者社区提供使用您的 API 所需的信息。自定义门户的一些注意事项包括:
- 轻松访问您的 API
- 文档,例如方法指南和参考文档
- 社区贡献的内容,例如博客和讨论论坛
- 示例代码
- 简单的注册流程,可快速审批新开发者、应用和 API
- 受管理的权限和凭据
- 分层访问权限控制
- 与贵组织相符的外观和风格
该门户附带预定义的基本配置。例如,开箱即用的门户配置为允许任何人注册为开发者,但管理员必须批准每项注册,开发者才能登录门户。注册审批通过后,开发者可以注册应用以请求 API 密钥,并使用该门户访问 API 资源。
默认注册流程中的步骤如下:
- 开发者通过开发者门户进行注册。作为回应,该门户会向管理员发送电子邮件,以便他们批准账号。
- 管理员批准账号后,系统会向开发者发送一封电子邮件,告知他们现在可以登录了。
- 开发者注册应用并选择应用使用的 API 产品。作为回应,门户会为应用分配唯一的 API 密钥。
- 开发者在向您的 API 发出请求时传递 API 密钥。
这种开箱即用体验的可定制程度非常高。例如,您可以替换默认的注册和授权方案,以便新开发者在注册后自动获得批准并登录。或者,您也可以要求开发者在首次登录之前接受一组条款及条件。
您还可以完全控制开发者门户上提供的内容。开发者门户会开箱即用,提供 API 文档、博文和论坛讨论等示例内容。您可以提供自己的内容,并自定义每种内容类型的外观。
如需了解详情,请参阅自定义外观。
管理开发者门户
开发者使用您的开发者门户来访问和使用您的 API。管理员执行账号管理任务,例如:
- 自定义开发者注册流程,包括注册字段、内置验证码和自动或手动审批
- 添加或批准开发者。默认情况下,任何开发者都可以通过开发者门户进行注册,但需要管理员通过开发者门户界面批准。管理员还可以在门户上直接创建开发者。然后,该门户会自动向开发者发送电子邮件,告知已为其创建账号。
- 修改开发者账号。例如,管理员可以将用户的账号状态从“活跃”更改为“已屏蔽”,或更改开发者的个人资料信息(例如公司名称)。
- 移除开发者。管理员可以停用或删除开发者的账号。
- 分配角色和权限:管理员可以向开发者账号分配特定角色。角色与各种权限相关联,例如创建图书或其他内容的权限。您还可以更改与角色关联的权限或创建新角色。
如需了解详情,请参阅添加和管理用户账号。
开发者门户功能摘要
下表简要介绍了开发者门户的功能:
功能 | 详细信息 |
---|---|
浏览器支持 |
请参阅支持的软件和支持的版本。 |
用户注册 |
|
用户管理 |
|
门户外观 |
|
内容和社区管理 |
|
权限 |
|
API 密钥管理 |
|
电子邮件 |
|
博客 |
|
论坛 |
|
文档 |
|
菜单 |
|
搜索 |
|
链接检查器 |
|