使用 Drupal 7 构建门户

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

具有社交发布功能的开发者门户越来越多地用于与开发者社区交流。这包括传达静态内容（如 API 文档和使用条款）以及社区提供的动态内容（如博客和论坛）。

作为 API 提供方，您需要一种方法来公开您的 API、向开发者介绍您的 API、注册开发者以及让开发者注册应用。向开发者公开您的 API 只是打造真正动态社区的一部分。此外，您还需要让开发者社区有办法提供反馈、提出支持和功能请求，以及提交可供其他开发者访问的自己的内容。

Apigee Edge 为您提供了开发者服务门户，您可以使用该门户构建和发布自己的自定义网站，为开发社区提供所有这些服务。每个 Edge 客户都可以在云端或本地创建自己的开发者门户。

下面的视频介绍了 Apigee Developer Services 门户。

下图显示了默认开发者门户的首页：

默认开发者门户的首页

开发者门户本质上是一个基于开源 Drupal (http://www.drupal.org) 项目的内容管理系统 (CMS)。Drupal 以模块的形式提供了一系列核心功能，让您可以轻松为网站构建内容和管理网站。

借助开发者门户，您可以通过开箱即用的方式创建 API 文档、支持博客以及提供会话式论坛。您还可以自定义开发者门户，以满足您的特定要求。通过自定义，您可以修改门户外观以及开发者与门户互动的方式。

您可以使用 Drupal 菜单执行大多数自定义操作。如果您以拥有管理员权限的用户身份登录门户，则每个门户页面的顶部都会显示 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 资源。

默认注册流程的步骤如下：

  1. 开发者通过开发者门户注册。作为响应，该门户会向管理员发送电子邮件以批准帐号。
  2. 管理员批准该帐号后，系统会向开发者发送一封电子邮件，告知他们现在可以登录了。
  3. 开发者注册应用，并选择应用使用的 API 产品。作为响应，门户会向应用分配一个唯一的 API 密钥。
  4. 开发者在向您的 API 发出请求时传递 API 密钥。

这种开箱即用的体验是高度可定制的。例如，您可以替换默认的注册和授权方案，以便新开发者在注册后会自动获得批准并登录。或者，您也可以要求开发者接受一系列条款及条件，然后才能进行首次登录。

您还可以完全控制开发者门户上提供的内容。开发者门户开箱即提供示例内容，例如 API 文档、博文和论坛讨论。您可以提供自己的内容，并自定义每种内容类型的外观。

如需了解详情，请参阅自定义外观。

管理开发者门户

开发者可通过您的开发者门户访问和使用您的 API。管理员可以执行帐号管理任务，例如：

  • 自定义开发者注册流程，包括内置人机识别系统验证的注册字段以及自动或手动审批
  • 添加或批准开发者。默认情况下，任何开发者都可以通过开发者门户注册，但需要管理员通过开发门户界面进行批准。管理员还可以直接在门户上创建开发者。然后，该门户会自动通过电子邮件告知开发者已为其创建帐号。
  • 修改开发者帐号。例如，管理员可以将用户的帐号状态从“有效”更改为“已屏蔽”，也可以更改开发者的资料信息（例如公司名称）。
  • 移除开发者。管理员可以停用或删除开发者帐号。
  • 分配角色和权限：管理员可以为开发者帐号分配特定角色。角色与各种权限相关联，例如创建图书或其他内容的权限。您还可以更改与角色关联的权限或创建新角色。

如需了解详情，请参阅添加和管理用户帐号。

开发者门户功能摘要

下表包含开发者门户功能的摘要：

功能 具体说明
浏览器支持

请参阅支持的软件和支持的版本。

用户注册
  • 手动或自动批准新的开发者账号
  • OpenID 集成
  • 为 Twitter、Google 和 GitHub 提供单点登录 (SSO) 支持
  • 人机识别系统
  • 自定义字段

用户管理
  • 创建和修改用户
  • 分配角色

门户外观
  • 按 CSS、图片和 Drupal 模块进行自定义

内容和社区管理
  • 基于开源 (Drupal)
  • 基于模板的内容创建
  • API 文档、博客、论坛和常见问题解答中开箱即用的内容类型
  • Del.icio.us、Digg、Twitter 的自动链接
  • 内容的修订版本控制
  • 博客的标签、关键字和归档
  • 与 Google Analytics（分析）集成
  • 可自定义的内容热门程度标准
  • 管理员审核了论坛帖子和评论
  • 基于自定义角色、已登录用户和匿名用户的不同访问权限

权限
  • 基于角色的访问规则

API 密钥管理
  • 内置应用注册
  • 支持自动或手动 API 密钥审批
  • 管理员可以撤消密钥

Email
  • 指定您的 SMTP 服务器
  • 配置门户向开发者发送电子邮件的时间
  • 控制门户生成的电子邮件的内容和格式

博客
  • 创建、修改和公开博文
  • 基于角色的权限，可将创建博客的权限限制为特定用户类型

论坛
  • 创建消息串式开发者论坛
  • 根据需要创建其他论坛类别
  • 基于角色的审核

文档
  • 提供 API 文档
  • 常见问题解答
  • 示例
  • 教程

菜单
  • 控制菜单的外观和内容

搜索
  • 内置 Apache Solr 搜索
  • 搜索特定内容。例如，论坛或博客
  • 控制 Google 索引编制

链接检查器
  • 检查网页中是否有损坏的链接。
  • 控制链接检查列表