您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
如需注册新应用，开发者需要在“我的应用”页面上选择“添加新应用”按钮。
然后，门户会显示默认的应用注册表单：
默认情况下，开发者只需指定应用名称、回调网址以及要添加到应用中的 API 产品列表。
作为 API 提供方，您可以完全控制应用注册流程。例如，您可以配置：
- 门户上提供的 API 产品列表
- 是否有默认的 API 产品
- 回调网址是否为必填项
- API 密钥是手动还是自动批准的 API 产品
- 在“添加应用”页面上是否需要提供任何其他信息才能注册应用
本主题介绍了如何为您的门户配置应用注册流程。不过，本主题未介绍如何创建 API 产品。如需了解详情，请参阅：
您可以根据为开发者分配的角色，配置门户网站以禁止开发者创建、删除或修改应用。例如，您可以将门户配置为在开发者注册时为所有开发者创建一个默认应用。然后，您只允许部分开发者添加新应用，可能基于开发者的费用结构或其他特征。使用角色和权限来控制哪些开发者可以创建、删除和修改应用。如需了解详情，请参阅添加和管理用户账号。
指定门户上提供的 API 产品
您可以通过以下两种方式指定开发者访问门户时可用的 API 产品：
在创建 API 产品时指定访问权限级别
创建 API 产品时，您需要指定该产品的访问权限级别选项，如下所示：
如需详细了解访问权限级别如何影响 Drupal 7 开发者门户中 API 产品的可用性，请参阅访问权限级别。
根据角色限制对 API 产品的访问权限
通过启用 API 产品角色访问权限 Drupal 模块，您可以指定可以访问每个 API 产品的角色。
如需根据开发者角色限制对 API 产品的访问权限，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 查看开发者门户角色和用户分配：
- 在 Drupal 管理菜单中，依次选择人员 > 权限 > 角色，然后根据需要添加或修改开发者角色和权限。
- 在 Drupal 管理菜单中选择用户，然后根据需要修改用户和角色分配。
- 在 Drupal 管理菜单中，依次选择配置 > 开发者门户 > API 产品角色访问权限。
- 选择您希望能够访问每个 API 产品的角色。
- 点击 Save configuration（保存配置）。
配置开发者如何将 API 产品与应用相关联
如需注册新应用，开发者可以选择“我的应用”页面上的“添加新应用”按钮，以打开“添加应用”表单：
根据您配置门户的方式，开发者可以在注册应用时选择一个或多个要与应用关联的 API 产品。或者，您也可以指定分配给所有应用的默认产品。
门户上提供了以下配置选项，用于在注册应用时控制 API 产品的选择：
- 请勿将应用与任何 API 产品相关联。
- 将所有应用与一个或多个默认 API 产品（见下文）相关联。开发者无法向应用添加任何其他 API 产品。
- 允许选择单个 API 产品，但不强制要求。
- 要求选择单个 API 产品。
- 允许选择多个 API 产品，但不要求必须选择任何 API 产品。
- 允许选择多个 API 产品，并且至少需要选择一个。
您还可以控制开发者用于选择 API 产品的表单中显示的 HTML 元素。选项包括：
- 下拉列表。
- 复选框或单选按钮。如果开发者可以选择多个 API 产品，则系统会显示复选框；如果开发者只能选择单个 API 产品，则系统会显示单选按钮。
如需设置 API 产品选择选项，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中，依次选择配置 > 开发者门户设置 > 应用设置。
- 在“应用设置”页面上，展开 API 产品设置区域。
- 在 API 产品处理下，选择用于控制 API 产品选择的选项。
- 如果您指定了“将所有应用与一个或多个默认 API 产品相关联（详见下文）”选项，请在默认 API 产品下设置默认产品。
- 在 API 产品 widget 下，选择开发者用于选择 API 产品的 HTML 元素。
- 保存配置。
配置回调网址处理方式
如果您的 API 产品中的 API 代理使用“三足式 OAuth”（授权代码授权类型），则开发者需要在注册应用时指定回调网址。回调网址通常指定要代表客户端应用接收授权代码的应用的网址。此外，此网址字符串还用于验证。 在请求授权代码和访问令牌时，客户端必须将此网址发送到 Apigee Edge，并且 redirect_uri 参数必须与已注册的参数匹配。如需了解详情，请参阅实现授权代码授权类型。
如需控制 API 产品选择的回调网址，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中，依次选择 Configuration > Dev Portal Settings > Application Attributes。
- 在“应用设置”页面上，展开回调网址设置区域。
- 在 Callback 网址 Handling（回调网址处理）下，选择以下选项之一。
- 所有开发者应用都必须指定回调网址。
- 回调网址对所有开发者应用都是可选的。
- 回调网址既不是必填项，也不会显示。
- 保存配置。
显示应用使用情况分析
该门户可以显示有关应用使用情况的分析信息。如果启用了分析数据的显示，应用开发者可以在“我的应用”页面上查看每个应用的分析数据。例如，开发者可以显示应用的以下分析数据：
- 吞吐量
- 响应时间上限
- 最短响应时间
- 消息数量
- 错误数
如需在门户上启用分析，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中，依次选择配置 > 开发者门户 > 应用设置。
- 在“应用设置”页面上，展开应用性能设置区域。
- 选中显示“开发者应用分析”标签页复选框。
- 为要查询分析数据的环境选择测试或生产。对于面向公众的门户，您通常会选择生产环境。
- 保存配置。
如需在门户上显示应用的分析数据，请执行以下操作：
- 在“我的应用”页面上选择应用名称。
- 选择相应应用的 Analytics 链接。
- 选择要显示的分析类型和日期范围：
- 系统会显示所选信息：
手动批准或撤消 API 产品的 API 密钥
当开发者向应用添加 API 产品并注册该应用后，门户会将该应用的 API 密钥返回给开发者。然后，开发者使用该 API 密钥访问与应用关联的 API 产品捆绑的 API 代理。
您可以在创建 API 产品时控制每个 API 产品的密钥审批流程：
审批流程可能如下：
- 自动 - 当开发者注册应用时，门户会针对 API 产品返回已批准的 API 密钥。您稍后可以撤消自动批准的密钥。
- 手动 - 在开发者注册应用时，门户会返回一个 API 密钥，但对于使用“手动”密钥审批方式的任何 API 产品，该密钥都不会激活。管理员必须在 Edge 管理界面或 API 中手动批准 API 密钥，开发者才能使用该密钥访问 API 产品。您稍后可以撤消手动批准的密钥。
如需了解详情，请参阅创建 API 产品。
如果您的门户允许开发者向应用添加多个 API 产品，开发者可能会采用“自动”密钥审批方式添加一些产品，采用“手动”密钥审批方式添加一些产品。开发者可以立即针对所有自动获批的 API 产品使用返回的 API 密钥，同时等待需要手动批准的 API 产品获得最终批准。
如需查看应用的 API 产品列表以及 API 产品的密钥审批状态，开发者可以在“我的应用”页面上选择应用的名称，然后选择“产品”链接：
在此示例中，“付费版 Weather API”产品使用“手动审批”模式，并正在等待管理员批准密钥。免费 API 产品使用自动批准，并且使用密钥访问该产品已获批准。
如需手动批准或撤消密钥，请执行以下操作：
- 以拥有贵组织管理员权限的用户身份登录 Edge 管理界面。
- 在右上角的下拉框中选择 API 平台。
- 依次选择发布 > 开发者应用，打开开发者应用列表。
- 选择待处理按钮，查看有待处理的密钥请求的应用列表：
- 选择您要批准的应用名称。
- 在应用详情页面上，选择右上角的修改按钮。
- 在应用的 API 产品列表中，点击“操作”下方的相应按钮：
-
如需批准密钥，请为需要手动批准的每个 API 产品选择批准按钮。
-
如需撤消已批准的密钥，请选择 API 产品对应的“操作”下方的撤消按钮，以撤消访问权限。
-
如需批准密钥，请为需要手动批准的每个 API 产品选择批准按钮。
- 保存应用。API 密钥现已获得批准。
控制 API 产品和应用缓存
API 产品和开发者应用的相关信息会远程存储在 Apigee Edge 上的门户中。这意味着，您可以通过 Edge 界面或 API 更改 API 产品和应用，而无需通过门户。例如，当后端管理员添加新的 API 产品时，门户不会立即更新该信息。
为确保门户与 Edge 后端保持同步，您可以手动触发门户缓存的更新，也可以在门户的 Cron 作业运行时自动更新缓存，或者同时执行这两项操作。例如，如果您将 Cron 作业配置为频繁运行（例如每 5 或 10 分钟运行一次），则可能不希望 API 产品和开发者应用缓存的更新开销如此频繁。在这种情况下，您可以手动触发缓存更新。但是，如果 cron 作业每小时或每两个小时运行一次，更新缓存所需的时间可能不会产生太大影响。
默认情况下，门户会配置为在每次运行 cron 时重新构建 API 产品和开发者应用缓存。
如需指定是否在每次运行 cron 时重新构建 API 产品和开发者应用缓存，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 菜单中，依次选择配置 > 开发者门户设置 > 应用设置。
- 选中或取消选中每次运行 cron 时重新构建 API 产品和开发者应用缓存。
- 保存您的设置。
如需手动更新缓存，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 菜单中，依次选择“Home”图标 >“Flush all caches”。
自定义用于注册应用的表单字段
当开发者注册应用时，门户会显示默认表单：
作为 API 提供方，您可能需要修改此表单，以提示开发者提供其他信息，例如客户 ID、应用的目标平台或其他信息。您可以通过该门户向此表单添加新字段。这些字段可以是：
- 必填或可选
- 通过不同的 HTML 元素（例如文本框、单选按钮、复选框等）显示
- 可设置为显示在表单上的“回调网址”字段和“商品”字段之间的任意位置
如需了解如何自定义开发者门户提供的应用注册表单，请观看此视频。
例如，以下表单显示了客户 ID 的必填字段和目标平台的可选字段：
当您向表单添加新字段后，当开发者提交表单时，这些字段的值会与所有其他字段一起自动上传到 Edge。这意味着，您可以在 Edge 上查看或修改这些字段，也可以使用 Edge 管理 API 通过脚本访问这些字段。
例如，在 Edge 管理界面中查看新的表单字段，方法是依次选择“发布”>“开发者应用”，然后选择应用名称。新字段值会显示在页面的“自定义属性”区域下，其名称与字段的内部名称相对应：
这些字段值也会显示在开发者的“我的应用”页面上应用的“详情”区域中：
开发者还可以在“我的应用”页面上选择相应应用的“修改”链接来修改这些值。
以下步骤介绍了如何使用管理控制台配置应用创建表单。Drupal 开发者可以使用自定义钩子执行其他自定义操作，包括修改“我的应用”页面。如需详细了解如何通过代码更改行为，请参阅文件 /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php 中的应用 API 示例。
如需向应用注册表单添加字段，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 确保已启用 DevConnect 应用属性管理模块。
- 在 Drupal 管理菜单中，依次选择配置 > 开发者门户设置 > 开发者门户应用属性。
- 选择页面顶部的 Add Dev Portal App Attribute（添加开发者门户应用属性）按钮。
- 配置该字段。例如，对于上面显示的“客户 ID”字段，请使用以下设置：
- 内部名称 = cust_id。这是用于存储字段值的变量的名称。
- 公开名称 = 客户 ID
- Description（说明）= 输入您的客户 ID。
- 选中“要求提供此属性”对应的复选框
- 选中“显示此属性”复选框。
- Widget = Text Box
- 选择“保存”以返回开发者门户“应用属性”页面。
- 选择保存更改。
- 从 Drupal 菜单中依次选择“Home”图标 >“Flush all caches”。
您可能需要清除浏览器缓存，表单中才会显示新字段。
如需添加可选字段以供开发者指定应用的平台，请将字段属性设置为：
- 内部名称 = intended_platforms
- 公开名称 = 平台
- 说明：为应用指定一个或多个平台。
- 取消选中“要求提供此属性”对应的复选框
- 选中“显示此属性”对应的复选框。
- Widget = 复选框列表
- 选择“保存”以返回开发者门户“应用属性”页面。
如需对表单上的属性进行重新排序，请执行以下操作：
- 以拥有管理员权限或内容创建权限的用户身份登录您的门户。
- 在 Drupal 管理菜单中，依次选择配置 > 开发者门户设置 > 开发者门户应用属性。
- 选择“名称”列下的加号 + 符号，然后将该属性拖动到您希望在表单中显示该属性的位置。
- 保存更改。