在基于 Drupal 的门户与 Edge 之间通信

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息

开发者服务门户用作 Apigee Edge 的客户端。这意味着该门户无法作为独立系统运行。事实上，门户使用的大部分信息都存储在 Edge 上。必要时，该门户会发出 HTTP 或 HTTPS 请求，以从 Edge 检索信息或向 Edge 发送信息。

Edge 不向门户发出请求，它仅响应从门户发出的请求。 因此，门户与 Edge 之间的所有互动均由门户发起。

配置门户与 Edge 之间的连接

门户需要与 Edge 通信以下三项信息，如下所述。

  • Edge 端点的网址

    基于云的 Edge 版本的默认端点为 https://api.enterprise.apigee.com/v1。

    对于私有云安装，网址的格式为：http://EdgePrivateCloudIp:8080/v1 或 https://EdgePrivateCloudIp:TLSport/v1。

    其中，EdgePrivateCloudIp 是 Edge 管理服务器的 IP 地址，TLSport 是 Edge 管理 API 的 TLS/SSL 端口。例如 8443。
  • Apigee 组织名称

    这是您在 Edge 中的组织名称。您可以在 Edge 上创建账号时设置组织。
  • 开发者管理员的用户名和密码

    从门户到 Edge 的调用需要经过身份验证，并且需要具有开发者管理员权限的用户。为您预配开发者门户后，系统会向贵组织添加“开发者管理员”角色。此角色包含一个名为 devadmin+{org_name}@apigee.com 的用户，其目的仅为将您的开发者门户与 Edge 组织相关联。由于该门户会显示您的 Edge 开发者应用、API 产品等，因此必须通过发出需要身份验证的管理 API 调用，与您的 Edge 组织保持同步。devadmin“用户”具有必要的权限。

如需查看连接信息，请执行以下操作：

  1. 在 Drupal 管理菜单中，依次选择配置 > 开发者门户 > 应用设置。

如需更改配置，请执行以下操作：

具体更改方式取决于您的门户安装方式和门户版本：

  • 基于云端的门户版本 15.01.06 及更高版本的安装：您必须向 Apigee Edge 支持团队提出请求，才能更改连接信息。例如，如果您想更改组织的名称。
  • 15.01.06 之前的版本的本地安装和基于云的门户：请按照以下说明更改连接信息：
  1. 在 Drupal 管理菜单中，依次选择配置 > 开发者门户设置。
  2. 在 Management API 组织中输入您的组织名称。
  3. 在 Management API 端点网址中输入 Edge 端点的网址。
  4. 在“端点经过身份验证的用户”和“经过身份验证的用户的密码”中输入组织管理员凭据。
  5. 选择测试连接，确保连接成功。
  6. 选择 Save Configuration（保存配置）。

确保能够通过门户访问 Edge

由于门户使用的许多信息都存储在 Edge 上，因此您必须确保门户可以访问 Edge。门户通过 HTTP 和 HTTPS 发出 REST 请求，以便与 Edge 建立通信。例如，当开发者在门户上注册新应用时，门户会向 Edge 发出请求，以将该应用的相关信息发送到 Edge。

Edge 和门户都可以在云端或本地部署，您也可以混合部署类型。例如，您可以将两个模型都部署在云端，也可以都部署在本地，或者将一个模型部署在云端，另一个模型部署在本地：

  • 如果门户和 Edge 均由 Apigee 在云端部署，则从门户向 Edge 发出请求应该不会出现问题。
  • 如果您在本地部署门户，则必须确保门户可以向 Edge 发出请求，无论 Edge 是部署在云端还是本地。
  • 如果您在本地部署 Edge，则必须确保该门户有权访问 Edge。也就是说，无论门户是部署在云端还是在本地，边缘服务器都必须接受来自门户的请求。

视频：观看一段简短视频，详细了解开发者门户如何与 Apigee Edge 通信，以及如何确保连接正常运行。

通过门户管理应用和 API 密钥

开发者在门户上完成应用注册流程后，门户会向 Edge 发送应用相关信息，包括应用名称和应用关联的 API 产品。

如果 Edge 成功注册应用，则会向门户返回单个 API 密钥。然后，开发者使用该 API 密钥访问与应用关联的 API 产品。

门户网站上实际上不会存储任何与应用和 API 密钥相关的信息。相反，所有这些信息都存储在 Edge 上。因此，每当开发者使用门户查看应用的相关信息时，门户都会向 Edge 发出请求以访问这些信息。每当开发者修改应用时，门户都会自动将这些修改发送到 Edge。

例如，开发者登录门户并前往“我的应用”页面。为了填充“我的应用”页面，门户会向 Edge 发出请求，以检索开发者的应用和 API 密钥的相关信息。然后，这些信息会显示在开发者的门户“我的应用”页面上：

之后，如果开发者添加、移除或修改应用，门户会将这些修改发送到 Edge。

由于有关应用和 API 密钥的所有信息都存储在 Edge 上，因此 Edge 管理员可以使用 Edge 界面操控这些信息。例如，管理员可以：

  • 添加、移除或修改开发者的应用
  • 撤消或批准应用的 API 密钥

下图显示了同一应用“我的天气应用”在 Edge 界面中向管理员显示的样子：

通过门户管理开发者

当开发者注册为新的门户用户时，系统会在 Edge 和门户上创建该开发者。因此，与应用和 API 密钥不同，开发者相关信息实际上存储在 Edge 和门户网站上。

存储在 Edge 上的开发者信息包括：

  • 名字
  • 姓氏
  • 电子邮件地址
  • 从门户发送的其他可选信息

该门户会存储与 Edge 相同的信息，但还会存储其他信息，包括：

  • 门户密码
  • 门户账号状态：有效或已屏蔽
  • 门户角色：经过身份验证的用户、管理员、其他
  • 基于角色的权限：确定开发者可以在门户上执行的操作

当开发者登录门户时，门户负责对开发者进行身份验证并强制执行基于角色的权限。

由于该门户会存储有关开发者的所有信息，因此请将该门户视为开发者信息的记录系统，而不是 Edge。当开发者在门户上修改其信息时，这些信息会存储在门户上，并在适用的情况下发送到 Edge。例如，如果开发者更改了名字，系统会将此信息发送到 Edge。 不过，如果开发者更改了密码，该信息只会存储在门户的本地。

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

在门户和 Edge 之间同步应用开发者

Edge 不会发起与门户的通信。如果您（作为 Edge 管理员）在 Edge 界面中操控开发者相关信息，我们无法保证这些信息何时会推送到门户。因此，请使用门户的管理功能创建、修改和删除开发者，而不是使用 Edge。

门户管理员可以强制门户与 Edge 之间同步，以便从 Edge 下载信息到门户。不过，如果您只在门户上修改开发者，而不在 Edge 上修改，则永远无需执行此同步。此外，由于 Edge 不允许您在创建开发者时设置密码，因此在 Edge 上创建的所有开发者的门户密码都会设置为随机值。因此，开发者必须先完成密码恢复流程，然后才能登录门户。

如需将门户与 Edge 上的应用开发者同步

：
  • 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
  • 在 Drupal 管理菜单中，选择用户。
  • 选择页面顶部的 Dev Portal Developer Sync 按钮，即可与 Edge 上的应用开发者同步。