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

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

开发者服务门户充当 Apigee Edge 的客户端。这意味着门户并非独立系统运行。相反，门户使用的大部分信息实际上存储在 Edge 上。必要时，门户会发出 HTTP 或 HTTPS 请求，以从 Edge 检索信息或将信息发送到 Edge。

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

配置门户与 Edge 之间的连接

门户需要三条信息才能与 Edge 通信，如下所述。

  • 边缘网址 端点

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

    对于 Private Cloud 安装，网址格式为：http://EdgePrivateCloudIp:8080/v1 或 https://EdgePrivateCloudIp:TLSport/v1。

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

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

    从门户到 Edge 的调用均需经过身份验证，并需要拥有开发者管理员权限的用户。为您预配开发者门户后，您的组织将添加 Developer Administrator 角色。此角色（包括一个名为 devadmin+{org_name}@apigee.com 的用户）仅用于将您的开发者门户连接到 Edge 组织。由于门户会显示您的 Edge 开发者应用、API 产品等，因此必须通过执行需要身份验证的管理 API 调用来与 Edge 组织保持同步。开发管理员“用户”拥有必要的权限。

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

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

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

更改配置的方式取决于门户安装和门户版本：

  • 基于云的门户安装 15.01.06 及更高版本：您必须向 Apigee Edge 支持团队发出请求，以更改连接信息。例如，要更改组织的名称。
  • 版本 15.01.06 之前的本地安装和云端门户：按如下所述更改连接信息：
  1. 在 Drupal 管理菜单中，依次选择配置 > 开发门户设置。
  2. 在 Management API 组织中输入您的组织名称。
  3. 在 Management API 端点网址中输入 Edge 端点的网址。
  4. 在 Endpoint Authenticated User 和 Authenticated User's Password 中输入组织管理员凭据。
  5. 选择测试连接，确保连接成功。
  6. 选择保存配置。

确保从门户访问 Edge

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

Edge 和门户都可以部署在云端或本地，还可以混合部署类型。例如，您可以同时在云端和本地部署，也可以同时在云端和本地部署：

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

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

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

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

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

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

例如，开发者登录门户并导航到其“我的应用”页面。为了填充“我的应用”页面，该门户会向 Edge 发出请求，以检索有关开发者的应用和 API 密钥的信息。然后，该信息会显示在开发者门户中“我的应用”页面上：

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

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

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

下方显示的是管理员在 Edge 界面中看到的同一应用，即“My Weather App”：

通过门户管理开发者

当开发者注册为新门户用户时，系统会在 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 上的应用开发者同步。