设置创收功能的步骤

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

准备工作

在开始在 Apigee 组织中使用创收功能之前，您需要完成以下前提任务：

  • 创建 Apigee Edge 账号，如创建 Apigee Edge 账号中所述。
  • 购买创收。Edge 最初不包含变现 API，也不会将变现功能集成到管理界面中。您需要购买创收功能，才能将创收 API 和创收界面组件纳入 Apigee 组织的 Edge 中。

购买创收功能后，您需要执行以下任务：

使用 Apigee 进行初始设置

与 Apigee Edge 配置团队合作，完成创收的初始设置。 配置团队将根据您的输入设置以下内容：

  • 贵组织是否为电信公司。
  • 您希望为购买您的费率方案的开发者提供哪种结算方式：预付费、后付费或两者兼有。请参阅预付费账号与后付费账号。
  • 您希望将从创收中提取的数据导入到会计系统中，是详细数据还是摘要数据，以及所需的数据格式。
  • 自定义电子邮件回复地址。对于发送给公司和开发者的创收电子邮件通知，系统会配置默认的 noreply@apigee.com 地址。 您必须为贵组织申请自定义回复名称和地址。

Apigee 配置团队会运行一个脚本，以便将创收功能与您的组织以及您使用 Apigee Edge 创建的所有开发者、应用和 API 产品同步。 Apigee 支持团队日后可能会要求您同步贵组织，如需了解详情，请参阅将 Apigee Edge 数据与创收功能同步。除非 Apigee 指示，否则请勿同步变现数据。

配置创收

下表总结了为 Apigee 组织配置创收功能所需的步骤。
步骤 说明
修改组织付款资料 在初始设置创收过程中，Apigee Edge 配置团队会设置您的组织付款资料。

您需要修改组织付款资料，以根据需要添加或更新贵组织的相关信息。例如，您可能需要更新结算类型、币种设置或税费模型。
管理支持的币种 在初始设置创收功能的过程中，Apigee Edge 配置团队会指定贵组织支持的币种，并设置默认币种。

您可以检索贵组织支持的币种，以及添加或删除支持的币种（以反映开发者或费率方案使用的币种）。

注意：创收功能会自动运行一个每日作业，用于获取每个受支持币种对应的美元汇率。默认情况下，该作业每天凌晨 1 秒运行一次。如需了解详情，请参阅安排创收作业。
指定条款及条件 您可以选择在发布费率方案之前向组织付款资料添加条款及条件。发布费率方案后，开发者门户中会显示条款及条件的当前版本。

注意：条款及条件不在贵组织的付款资料中。在组织付款资料中，您可以指定条款及条件的位置（公开网址）。您可以添加多个版本的条款及条件，以反映随时间推移而发生的变化。
强制执行创收限制 将 MonetizationLimitsCheck 政策附加到 API 代理，以强制执行创收限制。

具体而言，当满足以下条件时，系统会触发此政策：

  • 访问创收 API 的开发者未注册或未订阅费率方案。
  • 开发者已超出所订阅费率方案的交易量上限。
  • 开发者预付费账号余额或后付费信用额度已达到上限。
设置通知 配置通知，以便在有特定事件（例如新发布的费率方案）发生时通知开发者或 API 提供方。

通过 API 创收

通过 API 创收时，您需要将一个或多个 API 产品捆绑到一个 API 产品套装中，并定义关联的费率方案。

在您为软件包发布费率方案（开始日期为当天或未来某天）之前，开发者不会看到该 API 产品软件包。开发者只有购买目前有效的费率方案之一，才能注册其应用以使用 API 产品套餐。如果 API 产品套装没有当前有效的已发布费率方案，则该套装不会用于创收。

下表总结了通过 API 创收所需的步骤。

步骤 说明
管理 API 产品套餐

创建 API 产品套装以对 API 产品进行分组。

注意：在传统版 Edge 界面和变现 API 中，产品套装称为 API 套餐。

如需使用该 API 管理 API 产品套装，请参阅：
配置交易记录政策

为您的每个 API 产品配置交易记录政策。交易记录政策定义了您希望在 API 产品的交易记录中捕获的内容，包括任何自定义属性。

如需使用该 API 配置交易记录政策，请参阅：
管理和发布费率方案

创建费率方案，以定义 API 的创收方式。例如，您是按固定费率还是可变费率向开发者收取 API 使用费。

如需使用 API 管理费率方案，请参阅：

购买已发布的费率方案 使用 API 购买已发布的费率方案，并根据需要让已购买的费率方案到期或取消。
在开发者门户中配置创收功能 在您的开发者门户中配置创收功能，以便开发者能够自行订阅费率方案、处理自动付款和结算、查看报告、浏览产品目录以及设置其他创收专用设置。

管理获利

配置创收功能并通过 API 创收后，您可以执行下表中总结的一个或多个步骤：

步骤 说明
管理公司和开发者 管理使用您的 API 的公司和开发者。开发者是单个实体，由电子邮件地址标识唯一。公司是指作为单个实体管理的开发者集合。
创建报告 创建预付款余额、收入和差异报告。对于预付费开发者，您可以将预付款余额报告与银行存款进行对账。
进行结算调整 例如，进行结算调整以更正记录中的差异。
发放赠金 发放开发者功劳（如果需要）。对于预付费开发者，赠送的预付费会显示为使用量减少，这会增加开发者的预付费余额。 对于后付费开发者，赠送金额会在账单中显示为单独的一行，从而减少账单中的扣款金额。
管理预付费账号余额 查看当前的预付费账号余额，并通过使用第三方付款服务提供商设置自动充值来为预付费账号充值。
使用信用额度管理后付费余额 为组织添加受支持的币种后，您可以为后付费开发者设置信用额度。此信用额度适用于组织中的所有后付费开发者。 此外，您还可以为单个后付费开发者设置信用额度。在这种情况下，赠送金额上限仅会替换为指定开发者针对相应币种设置的任何上限。
发布退款 向开发者退还购买交易的款项。
安排创收作业 创收功能提供了一个作业调度器和一组预先安排在指定时间运行的作业。使用 API 管理创收作业时间表。
查看交易状态 使用 API 查看在指定时间范围内发生的交易的状态。
将 Apigee Edge 数据与创收同步 如果 Apigee 指示您这样做，请重新同步数据与创收功能，以确保数据同步。 您可以同步以下内容：组织、API 产品、开发者和应用。
删除贵组织的创收数据 您可能需要删除组织中的创收数据，以清除测试组织或删除组织。