注册应用开发者

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

注册并管理您的应用,如以下几个部分所述。(应用注册是一个单独的流程,如通过注册应用来控制对 API 的访问权限中所述。)

简介

Apigee 提供众多优势,完全取决于知道谁是 API 调用方。例如,API 安全、流量管理和公允的分析量取决于谁是调用方。Apigee 如何知道谁是 API 调用方?通过读取每个 API 调用中的唯一信息,例如用户 ID、API 密钥或 OAuth 令牌。这些唯一信息将锁定或解锁您在 API 代理中构建的功能,让您可完全控制 API 访问和行为。

正因如此,应用开发者需要注册才能使用您的 API。添加后,开发者可注册其应用,选择要使用的 API,并获取访问 API 所需的唯一 API 凭据(使用方密钥和密钥)。

如何注册应用开发者

使用以下某种方法注册应用开发者:

  • 如果您有付费 Apigee 账号,开发者可通过开发者门户自行注册。如需了解详情,请根据开发者门户的类型参阅以下某个部分:
  • 管理员可以使用 API 注册应用开发者。
  • 作为开发者门户管理员,直接在门户上管理开发者,具体如以下几个部分所述:
  • 作为组织管理员,使用 Apigee 界面API 管理开发者,如以下几个部分所述。

关于在开发者门户上管理用户账号的建议

Apigee 建议您直接在开发者门户上管理用户账号。

如果您使用的是集成式门户,则这是确保集成式门户上的用户账号和 Apigee 保持同步的唯一方法。

如果您使用基于 Drupal 的开发者门户,则直接在开发者门户上管理用户账号具有以下优势:

  • 通过门户上的管理员界面添加开发者时,您可以设置门户的开发者密码,并触发自动发送给开发者的电子邮件。

    使用 Apigee 添加或修改开发者时,系统不会向开发者发送电子邮件,而且您无法在门户上设置开发者的密码。因此,开发者必须先在门户上重置其密码,然后才能登录门户。

  • 对门户上的开发者账号所做的任何更改都会自动发送到 Apigee。

如果您决定使用 Apigee 管理基于 Drupal 的用户账号,则必须在门户和 Apigee 之间同步应用开发者

浏览“开发者”页面

使用 Apigee 界面访问和浏览“开发者”页面。

如需访问开发者页面,请执行以下操作:

通过开发者页面,您可以执行以下操作:

添加开发者

如需添加开发者,请执行以下操作:

  1. 访问“开发者”页面。
  2. 点击 + 开发者
  3. 输入开发者详细信息,包括名字、姓氏、电子邮件地址和用户名。
  4. 点击创建

另请参阅管理用户

查看和修改开发者详细信息

查看和修改开发者详细信息。

如需查看和修改开发者详细信息,请执行以下操作:

  1. 访问“开发者”页面。
  2. 点击要查看和修改的开发者所在的行,以打开开发者详细信息。
  3. 详细信息部分会显示以下信息。根据需要修改开发者详细信息。
    详细信息 说明
    详情 开发者的名字、姓氏、用户名和电子邮件地址;注册状态和持续时间;以及开发者 ID
    如需修改开发者详细信息,请点击以下任一字段:
    • 名字
    • 姓氏
    • 电子邮件
    • 用户名
    修改内容,然后按 Enter 键确认更改。
    自定义特性 为开发者定义的自定义属性。根据需要配置自定义属性。 如需了解详情,请参阅管理开发者的自定义特性
    应用 开发者注册的应用。请参阅通过注册应用来控制对 API 的访问权限
  4. 状态字段中激活或停用开发者。
    如需了解详情,请参阅激活和停用开发者

访问实体后,Apigee 会将以下实体缓存至少 180 秒。

  • OAuth 访问令牌。这意味着 OAuth v2 政策上的 ExpiresIn 元素无法在 180 秒之内使访问令牌到期。
  • 密钥管理服务 (KMS) 实体(应用、开发者、API 产品)。
  • OAuth 令牌和 KMS 实体的自定义属性。

管理开发者的自定义属性

为每个开发者添加最多 18 个自定义属性。

如需管理自定义属性,请执行以下操作:

  1. 访问“开发者”页面。
  2. 点击要管理自定义属性的开发者所在的行,以打开开发者详细信息。
  3. 点击自定义特性部分中的 +
  4. 输入属性名称和值。
  5. 点击 绿色对勾标记图片。
  6. 如需删除自定义属性,请将光标放在该属性上,然后点击操作菜单中的 垃圾桶图标

激活和停用开发者

当应用开发者在您的门户中自行注册时,您可以配置这些开发者是否默认处于活动状态。

即使开发者处于非活动状态,开发者仍可登录开发者门户并创建应用,但任何相应的 API 密钥都将不会正常运行。开发者的应用仍保持其已批准(或其他)状态,如同 API 密钥,即使开发者处于非活动时它们无效也是如此。

如需激活或停用开发者,请执行以下操作:

  1. 访问“开发者”页面。
  2. 点击要激活或停用的开发者所在的行,以打开开发者详细信息。
  3. 在“详细信息”部分,根据需要将状态字段设置为活动非活动
  4. 如果开发者位于多个组织中,请重复执行上述步骤。

导出发布数据

以逗号分隔值 (CSV) 文件的形式导出以下发布数据:

  • 开发者详细信息
  • 开发者、应用和 API 产品详细信息

如需导出发布数据,请执行以下操作:

  1. 访问“开发者”页面。
  2. 点击导出 CSV...
  3. 从下拉菜单中选择开发者开发者、应用和产品

所选的发布数据将下载为 CSV 文件。

删除开发者

如需删除开发者,请执行以下操作:

  1. 访问“开发者”页面。
  2. 将光标置于要删除的开发者所在的行上方,以显示操作菜单。
  3. 点击 “删除”图标的图片。
  4. 点击删除以确认删除。

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

如果您使用基于 Drupal 的开发者门户发布 API,则使用 Apigee 对应用开发者所做的更改不会传播到门户。您必须以门户管理员身份登录门户,并将门户与 Apigee 同步,以便在门户上显示这些更改。

如需将开发者门户与 Apigee 中定义的应用开发者同步,请参阅以下部分:

Drupal 10:将开发者与 Apigee 同步

使用 API 管理开发者

使用 Developer API 管理开发者。