注册应用开发者

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

注册并管理您的应用开发者，如以下几个部分所述。（应用注册是一个单独的流程，如注册应用和管理 API 密钥中所述）。

简介

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

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

如何注册应用开发者

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

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

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

如果您使用的是集成式门户，这是确保集成式门户和 Edge 上的开发者账号保持同步的唯一方法。

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

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

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

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

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

浏览“开发者”页面

使用 Edge 界面和新 Edge 界面访问和探索“开发者”页面。

Edge

如需使用 Edge 界面访问“开发者”页面，请执行以下操作：

  1. 登录 apigee.com/edge。
  2. 在左侧导航栏中选择发布 > 开发者。

系统会显示“开发者”页面。

如上图所示，您可以通过“开发者”页面执行以下操作：

新版 Edge 界面（私有云）

如需使用新版 Edge 界面访问“开发者”页面，请执行以下操作：

  1. 在 http://host:3001/edge 中登录 New Edge 界面，其中 host 是运行 New Edge 界面的主机的 IP 地址或 DNS 名称。
  2. 在左侧导航栏中选择发布 > 开发者。

系统会显示“开发者”页面。

新版 Edge 界面中的“开发者”页面

如图中突出显示的部分所示，您可以通过“开发者”页面执行以下操作：

添加开发者

如需添加开发者，请执行以下操作：

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

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

查看和修改开发者详细信息。对于已启用创收功能的组织，您可以修改配置创收属性中定义的创收自定义属性。

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

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

使用适用于公有云的 Apigee Edge 时，Edge 会将以下实体缓存至少 180 秒（自实体被访问起）。

  • OAuth 访问令牌。这意味着，撤消的令牌可能仍会在长达三分钟内有效，直到其缓存限制过期为止。
  • 密钥管理服务 (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. 再次点击删除，确认删除该规则。

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

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

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

将开发者分组到公司

在变现方面，公司是指作为单个实体进行管理的一组开发者。公司可以是适合您组织的任何分组，例如业务单位、产品线或部门。如果您需要将多位开发者与单个公司实体相关联，则将开发者分组到公司中会很有用。例如，您可能需要出于结算目的设置不同的公司。不过，您组织中的开发者无需与公司相关联。请注意，开发者始终是单个实体，由电子邮件元素唯一标识。如果开发者隶属于某家公司，您会在“开发者”页面上看到该公司名称。

如需详细了解如何管理公司和开发者以实现创收，请参阅管理公司和开发者。

配置创收属性

使用界面修改开发者或使用 API 创建/修改开发者时，您可以配置下表中定义的创收属性。 最初，您可以在修改组织资料时为组织配置创收属性。

字段名称 自定义属性名称 说明
地址 MINT_DEVELOPER_ADDRESS

开发者的地址，包括以下字段：地址（第 1 行和第 2 行）、城市、州/省/直辖市/自治区、邮政编码和国家/地区。
结算资料 MINT_BILLING_PROFILE

组织的结算周期。有效值包括：

  • PRORATED：结算依据是 API 产品在日历月中的使用天数。
  • CALENDAR_MONTH：按月结算。
结算类型 MINT_BILLING_TYPE

用于结算的开发者付款模式。可以是以下值之一：

  • 预付费：开发者预先支付 API 产品的使用费。当开发者使用 API 产品时，系统会从开发者的余额中扣除相应款项。开发者必须保持足够的预付款余额才能购买 API 产品。
  • POSTPAID：开发者按月（通过账单）支付 API 产品使用费。开发者根据账单中包含的方案所设置的付款条件支付 API 产品使用费。
  • BOTH：支持任一结算类型。默认值为 PREPAID。

请参阅使用 API 配置预付费和后付费结算类型。

类别 MINT_DEVELOPER_CATEGORY 您要将开发者添加到的开发者类别。开发者类别是指具有相似特征的开发者或公司的分组。如需了解详情，请参阅管理开发者类别。
公司 ID MINT_COMPANY_ID 公司 ID（如果适用）。如需了解详情，请参阅将开发者分组到公司。
开发者类型 MINT_DEVELOPER_TYPE Apigee 不使用此属性。

开发者类型。有效值包括：TRUSTED 或 UNTRUSTED
是否为经纪商 MINT_IS_BROKER 一个标志，用于指定收入是否基于净收入。
法定全名 MINT_DEVELOPER_LEGAL_NAME 开发者的法定全名，将用于所有报告。
注意：如果开发者未与公司分组，但想要订阅已发布的费率方案，则必须使用此属性。
自开账单 MINT_HAS_SELF_BILLING 用于指定是否启用自开账单的标志。如果启用 (true)，变现会生成自开账单，而不是收益分成对账单。自开账单是一种财务文件，其中详细列出了应付给开发者的金额。它代表开发者充当 API 提供商的账单。
免税授权编号 MINT_TAX_EXEMPT_AUTH_NO 政府免税号（如果适用）。
税率 MINT_APPROX_TAX_RATE 开发者的近似税率。指定一个十进制值，小数点前最多 3 个字符，小数点后最多 4 个字符。

使用 API 管理开发者

使用 Developer API 管理开发者。

使用 API 创建和更新开发者时，您可以根据需要配置配置创收属性中所述的创收属性。