简介

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

作为 API 提供商,您已开发一组 API 来提供对后端服务的访问权限。下一步是构建开发者门户,让应用开发者能够:

  • 了解您的数据和服务产品
  • 通过查看全面的文档(包括示例用例、教程和参考文档)了解如何使用您的 API
  • 使用自助流程进行注册,以便构建使用您的 API 的应用

开发者门户解决方案概览

Apigee 支持多种开发者门户解决方案,下表对此进行了汇总,从简单的交钥匙到可完全自定义和可扩展。选择解决方案时,您需要根据实施门户所需的时间和知识来平衡自定义要求。

解决方案 功能 由 Apigee 托管? 支持
(需要许可订阅)
Apigee 集成式门户 简单的自助服务门户开发。
仅限 Apigee Edge 公有云客户
Apigee 全天候支持
Drupal 9 门户 使用 Drupal 9 开源项目开发可完全自定义的自助服务门户。使用 Apigee Edge 模块与 Apigee 集成。 Apigee 全天候支持故障修复问题
自定义门户 使用 Apigee 平台 API 进行可全面自定义的 DIY 门户开发。 仅为 Apigee 平台 API 提供 Apigee 全天候支持

选择开发者门户解决方案

为帮助您决定选择哪种开发者门户解决方案,请考虑以下决策树并查看开发者门户功能比较

显示何时使用 Drupal 以及何时使用 Apigee 集成门户的流程图

如果您是适用于公有云的 Apigee Edge 客户,并计划为门户开发的常见使用场景(例如标准注册和应用创建流程)以及比功能更改更具样式,请考虑构建 Apigee 集成门户

对于面向私有云和变现客户的 Apigee Edge,基于 Drupal 的门户目前是目前唯一的选择。

开发者门户功能比较

下表对 Apigee 集成式门户基于 Drupal 的开发者门户的功能进行了对比。

功能 集成式门户 Drupal
使用 Markdown 开发门户内容 绿色对勾图标 绿色对勾图标
使用 HTML 开发门户内容 绿色对勾图标 绿色对勾图标
从 OpenAPI 规范渲染的 API 参考文档 绿色对勾图标 绿色对勾图标
OpenAPI 规范版本 3 支持 绿色对勾图标 绿色对勾图标
从 API 参考文档发送实时请求 绿色对勾图标 绿色对勾图标
自定义主题背景 绿色对勾图标 绿色对勾图标
自定义菜单 绿色对勾图标 绿色对勾图标
第三方代码,如 Google Analytics(分析) 绿色对勾图标 绿色对勾图标
自定义 JavaScript 代码 绿色对勾图标 绿色对勾图标
自定义域名 绿色对勾图标 绿色对勾图标
启用了 HTTPs 绿色对勾图标 绿色对勾图标
账号创建的条款及条件 绿色对勾图标 绿色对勾图标
移动设备展示广告优化 绿色对勾图标 绿色对勾图标
与自定义脚本和脚本标记集成 绿色对勾图标 绿色对勾图标
SMTP 配置 绿色对勾图标 绿色对勾图标
电子邮件模板配置 绿色对勾图标 绿色对勾图标
CAPTCHA 阻止垃圾邮件 绿色对勾图标 绿色对勾图标
开发者/使用方账号的角色和权限 绿色对勾图标 绿色对勾图标
联合登录 绿色对勾图标 绿色对勾图标
内容管理 API 使用 Drupal
获利 即将发布 绿色对勾图标
搜索配置 * 绿色对勾图标
博客和论坛 ** 绿色对勾图标
用于创建内容的页面模板 绿色对勾图标
门户上的应用分析 绿色对勾图标
基于规则的事件管理 绿色对勾图标
可使用插件模块进行扩展 绿色对勾图标
自定义应用注册流 绿色对勾图标
自定义开发者注册流 绿色对勾图标
门户日志 绿色对勾图标
链接检查器 绿色对勾图标
Microsoft Internet Explorer/Microsoft Edge 支持 仅限 Microsoft Edge 绿色对勾图标
Apigee 支持 参见上表 参见上表

构建集成式门户

如果您是适用于公有云的 Apigee Edge 客户,则可以在 Edge 界面中快速创建轻量级开发者门户。前往 https://apigee.com/edge,登录,然后在 Edge 界面的侧边导航栏中依次选择 Publish > Portals。如需了解完整详情,请参阅构建集成式门户

下图显示集成式门户的着陆页。

门户简介

构建基于 Drupal 的门户

您可以使用 Drupal 门户开发工具构建可完全自定义的开发者门户。Drupal 提供一组丰富的功能和 Drupal 的所有 CMS 功能,并提供 Apigee 开发的附加 Drupal 模块。但是,实施基于 Drupal 的门户需要投入更多时间和精力。

Apigee Edge 与以下 Drupal 版本兼容:

版本 说明
Drupal 9 提供可靠的、由客户管理的开源企业级内容管理系统 (CMS)。 由于 Drupal 9 是开源的,您可以扩展 Drupal 9 门户开发框架和为之做贡献,并且可利用 Drupal 社区的知识。如需了解详情,请参阅使用 Drupal 9 构建门户

使用 Apigee Edge API 构建自定义门户

利用下表总结的 Apigee Edge API 构建您自己的完全自定义门户。如需了解详情,请参阅以下主题:

类别 Apigee API 说明
分析 统计信息 查看 API 的分析信息。
API 密钥 应用密钥:开发者

应用密钥:公司

管理用于授权在应用中使用 API 的 API 密钥。
API 产品 API 产品 管理您发布到开发者门户的 API 产品。
应用 应用

应用:开发者

应用:公司

管理开发者注册的应用以使用您的 API。
开发者 开发者

公司

公司开发者

管理在您的开发者门户上注册的开发者。
获利 变现 通过 API 获利。

使用适用于 PHP 的 Apigee Edge 客户端库简化门户客户端的集成。SDK 让您可轻松编写使用上表所述的 Apigee API 的 PHP 模块。如需详细了解 PHP 版 Apigee API 客户端库,请参阅: