配置应用注册

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

开发者可使用开发者服务门户上的“我的应用”页面注册应用。 开发者可通过该门户的主菜单访问“我的应用”页面：

要注册新应用程序，开发者需要在“我的应用程序”页面上选择“添加新应用程序”按钮。

然后，该门户会显示默认的应用注册表单：

默认情况下，开发者只需指定要添加到应用的应用名称、回调网址和 API 产品列表。

作为 API 提供方，您可以完全控制应用注册流程。例如，您可以配置：

  • 门户上可用的 API 产品列表
  • 是否有默认的 API 产品
  • 回调网址是否是必需的
  • 某个 API 产品是手动还是自动批准 API 密钥的
  • 注册应用时是否需要在“添加应用”页面上提供任何其他信息

本主题介绍了如何为您的门户配置应用注册流程。不过，本主题不介绍如何创建 API 产品。如需了解详情，请参阅：

您可以配置门户，以禁止开发者根据分配给开发者的角色创建、删除或修改应用。例如，您可以将该门户配置为在开发者注册时为所有开发者创建一个默认应用。然后，根据费用结构或开发者的其他特征，仅允许部分开发者添加新应用。使用角色和权限来控制哪些开发者可以创建、删除和修改应用。如需了解详情，请参阅添加和管理用户帐号。

指定门户上可用的 API 产品

您可以通过以下两种方式指定开发者访问门户时可用的 API 产品：

创建 API 产品时指定访问权限级别

创建 API 产品时，您需要指定产品的访问权限级别选项，如下所示：

如需详细了解访问权限级别如何影响 Drupal 7 开发者门户中 API 产品的可用性，请参阅访问权限级别。

根据角色限制对 API 产品的访问权限

通过启用 API Product Role Access Drupal 模块，您可以指定可以访问每个 API 产品的角色。

如需根据开发者角色限制对 API 产品的访问权限，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 查看开发者门户角色和用户分配情况：
    • 在 Drupal 管理菜单中，依次选择用户 > 权限 > 角色，然后根据需要添加或修改开发者角色和权限。
    • 在 Drupal 管理菜单中选择人员，然后根据需要修改用户和角色分配。
  3. 在 Drupal 管理菜单中，依次选择配置 > 开发门户 > API 产品角色访问权限。
  4. 选择您希望能够访问每个 API 产品的角色。
  5. 点击 Save configuration（保存配置）。

配置开发者将 API 产品与应用关联的方式

要注册新应用，开发者可在“我的应用”页面上选择“添加新应用”按钮，以打开“添加应用”表单：

根据您配置门户的方式，开发者可以选择一个或多个 API 产品，以便在注册应用时与应用相关联。或者，您也可以指定分配给所有应用的默认商品。

门户上提供了以下配置选项，以便在注册应用时控制 API 产品的选择：

  • 请勿将应用与任何 API 产品相关联。
  • 将所有应用与一个或多个默认 API 产品（配置如下）相关联。开发者无法向应用添加任何其他 API 产品。
  • 允许选择单个 API 产品，但不强制要求选择。
  • 需要选择一个 API 产品。
  • 允许选择多个 API 产品，但不要求选择任何产品。
  • 允许选择多个 API 产品（至少必须选择一款）。

您还可以控制开发者用于选择 API 产品的表单中显示的 HTML 元素。可供选择的选项包括：

  • 下拉列表。
  • 复选框或单选按钮。如果开发者可以选择多个 API 产品，系统会显示复选框；如果开发者只能选择一个 API 产品，系统会显示单选按钮。

如需设置用于选择 API 产品的选项，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中，依次选择 Configuration > Dev Portal Settings > Application Settings。
  3. 在“应用设置”页面上，展开 API 产品设置区域。
  4. 在 API 产品处理下，选择用于控制 API 产品的选择的选项。
  5. 如果您指定“将所有应用与一个或多个默认 API 产品（配置如下）关联”选项，请在默认 API 产品下设置默认产品。
  6. 在 API 产品微件下，选择开发者用来选择 API 产品的 HTML 元素。
  7. 保存配置。

配置回调网址处理

如果您的 API 产品中的 API 代理使用“三足式 OAuth”（授权代码授权类型），则开发者在注册其应用时需要指定一个回调网址。回调网址通常会指定代表客户端应用接收授权代码的应用的网址。此外，此网址字符串也用于验证。 客户端在请求授权代码和访问令牌时需要将此网址发送到 Apigee Edge，并且 redirect_uri 参数必须与注册的参数匹配。如需了解详情，请参阅实现授权代码授权类型。

如需控制用于选择 API 产品的回调网址，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中，依次选择 Configuration > Dev Portal Settings > Application Attributes。
  3. 在“Application Settings”页面上，展开 Callback 网址 settings 区域。
  4. 在 Callback 网址 Handling（回调网址处理）下，选择以下选项之一。
    • 所有开发者应用都需要回调网址。
    • 对于所有开发者应用，回调网址都是可选的。
    • 系统既不需要也不显示回调网址。
  5. 保存配置。

显示应用使用情况分析数据

门户可以显示有关应用使用情况的分析信息。如果启用显示分析数据的功能，则应用开发者可以在“我的应用”页面上查看每个应用的分析数据。例如，开发者可以显示应用的以下分析数据：

  • 吞吐量
  • 响应时间上限
  • 最短响应时间
  • 消息数量
  • 错误数

如需在该门户上启用分析功能，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中，依次选择配置 > 开发门户 > 应用设置。
  3. 在“应用设置”页面上，展开应用性能设置区域。
  4. 选中显示“开发者应用分析工具”标签页复选框。
  5. 对于要查询分析数据的环境，选择测试或生产。对于可公开访问的门户，您通常应选择正式版。
  6. 保存配置。

如需在门户上显示某个应用的分析数据，请执行以下操作：

  1. 在“我的应用”页面上选择应用名称。
  2. 选择应用的 Google Analytics（分析）链接。
  3. 选择要显示的分析类型和日期范围：
  4. 系统会显示所选信息：

手动批准或撤消 API 产品的 API 密钥

如果开发者将 API 产品添加到应用，然后注册该应用，该门户会将该应用的 API 密钥返回给开发者。然后，开发者会使用该 API 密钥来访问与应用关联的 API 产品绑定的 API 代理。

在创建 API 产品时，您可以控制每个 API 产品的密钥审批流程：

审批流程可以是：

  • 自动 - 当开发者注册应用时，门户会为 API 产品返回已获批准的 API 密钥。您可以在以后撤消自动批准的密钥。
  • Manual - 当开发者注册应用时，门户会返回 API 密钥，但对于任何使用手动密钥审批的 API 产品，该密钥未激活。管理员必须在边缘管理界面或 API 中手动批准 API 密钥，开发者才能使用该密钥访问 API 产品。您可以稍后撤消手动批准的密钥。

如需了解详情，请参阅创建 API 产品。

如果您的门户允许开发者向应用添加多个 API 产品，那么开发者可能会添加一些具有自动密钥审批的产品，一些产品采用手动方式。开发者可以立即为所有自动获批的 API 产品使用返回的 API 密钥，同时等待那些需要手动审批的产品的最终审批。

要查看应用的 API 产品列表以及 API 产品的密钥批准状态，开发者在“我的应用”页面上选择应用名称，然后选择“产品”链接：

在此示例中，Premium Weather API 产品使用手动批准，并等待管理员批准密钥。免费 API 产品使用自动批准功能，并且使用密钥进行访问已获得批准。

如需手动批准或撤消密钥，请执行以下操作：

  1. 以对贵组织拥有管理权限的用户身份登录 Edge 管理界面。
  2. 在右上角的下拉框中选择 API 平台。
  3. 依次选择发布 > 开发者应用以打开开发者应用列表。
  4. 选择待处理按钮以查看具有待处理密钥请求的应用列表：

  5. 选择您要批准的应用名称。
  6. 在应用详情页面上，选择右上角的修改按钮。
  7. 在应用的 API 产品列表中的操作下：
    • 要批准密钥，请为需要手动审批的每个 API 产品选择批准按钮。

    • 如需撤消已批准的密钥，请为相应 API 产品选择“操作”下的撤消按钮以撤消访问权限。

  8. 保存应用。API 密钥现已获得批准。

控制 API 产品和应用缓存

API 产品和开发者应用的相关信息从 Apigee Edge 上的门户远程存储。这意味着您可以通过 Edge 界面或 API 对 API 产品和应用进行更改，而无需通过门户。例如，当后端管理员添加新的 API 产品时，门户不会立即使用此信息进行更新。

如需确保门户与边缘后端保持同步，您可以手动触发门户缓存的更新和/或门户缓存时自动更新缓存。例如，如果您将 Cron 作业配置为频繁运行（例如每 5 分钟或 10 分钟运行一次），那么您可能不希望因频繁更新 API 产品和开发者应用缓存而产生开销。在这种情况下，您可以手动触发缓存更新。但是，如果 Cron 作业每一小时或每两个小时运行一次，那么更新缓存所需的时间可能就不会产生太大影响。

默认情况下，门户配置为每次 cron 运行时重新构建 API 产品和开发者应用缓存。

如需指定是否在每次运行 Cron 时重新构建 API 产品和开发者应用缓存，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 菜单中，依次选择 Configuration > Dev Portal Settings > Application Settings。
  3. 选中或取消选中每次 cron 运行时重新构建 API 产品和开发者应用缓存。
  4. 保存设置。

如需手动更新缓存，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 从 Drupal 菜单中，依次选择首页图标 > 清空所有缓存。

自定义用于注册应用的表单字段

开发者注册应用时，该门户会显示默认表单：

作为 API 提供方，您可能需要修改此表单，以提示开发者提供更多信息，例如客户 ID、应用的目标平台或其他信息。通过该入口，您能够将新字段添加到此表单。这些字段可以是：

  • 必填还是选填
  • 由不同的 HTML 元素（如文本框、单选按钮、复选框等）显示
  • 可以设置为显示在表单上的“回调网址”字段和“产品”字段之间的任意位置

如需了解如何自定义开发者门户提供的应用注册表单，请观看此视频。

例如，以下表单显示了客户 ID 的必填字段和目标平台的选填字段：

当您向表单中添加新字段时，当开发者提交表单时，各个字段值会自动与所有其他字段一起上传到 Edge。这意味着您可以在 Edge 上查看或修改这些字段，或者使用 Edge Management API 通过脚本访问这些字段。

例如，在 Edge 管理界面中，依次转到“发布”>“开发者应用”，然后选择应用名称，即可查看新的表单字段。新的字段值会显示在页面的“自定义属性”区域下方，其名称对应于字段的内部名称：

字段值也会显示在开发者的“我的应用”页面上的应用“详细信息”区域中：

开发者还可以通过在“我的应用”页面上为应用选择“修改”链接来修改这些值。

以下过程介绍了如何使用管理员界面配置应用创建表单。Drupal 开发者可以使用自定义钩子执行其他自定义操作，包括修改“我的应用”页面。如需详细了解如何通过代码更改行为，请参阅以下文件中的应用 API 示例：/profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php。

如需向应用注册表单添加字段，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 确保已启用 DevConnect App Attribute Management 模块。
  3. 在 Drupal 管理菜单中，依次选择 Configuration > Dev Portal Settings > Dev Portal App Attributes。
  4. 选择页面顶部的添加开发门户应用属性按钮。
  5. 配置字段。例如，对于上面显示的客户 ID 字段，使用以下设置：
    • 内部名称 = cust_id。这是用于存储字段值的变量的名称。
    • 公开名称 = 客户 ID
    • Description = 输入您的客户 ID。
    • 选中“需要此属性”复选框
    • 选中“显示此属性”复选框。
    • 微件 = 文本框
    • 选择“Save”（保存）以返回到“Dev Portal App Attributes”（开发门户应用属性）页面。
  6. 选择保存更改。
  7. 从 Drupal 菜单中选择首页图标 > 清空所有缓存。
    您可能需要清除浏览器缓存，新字段才会显示在表单中。

要添加可选字段以便开发者指定应用平台，请将字段属性设置为：

  • 内部名称 = intent_platforms
  • 公开名称 = 平台
  • 说明 = 为您的应用指定一个或多个平台。
  • 取消选中“需要此属性”对应的复选框
  • 选中“显示此属性”复选框。
  • 微件 = 复选框列表
  • 选择“Save”（保存）以返回到“Dev Portal App Attributes”（开发门户应用属性）页面。

如需对表单上的属性重新排序，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 在 Drupal 管理菜单中，依次选择 Configuration > Dev Portal Settings > Dev Portal App Attributes。
  3. 在“名称”列下选择加号 (+)，然后将属性拖动到表单中显示的位置。
  4. 保存更改。