设置创收功能的步骤

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

准备工作

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

  • 按照创建 Apigee Edge 帐号中的说明，创建 Apigee Edge 帐号。
  • 购买创收功能。Edge 最初并未包含 monetization API，也没有将创收功能集成到管理界面中。您需要购买创收功能，以将 Monetize API 和创收界面组件集成到 Edge 中，以用于您的 Apigee 组织。

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

使用 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 商品套装，对您的 API 商品进行分组。

注意：在传统版 Edge 界面和 monetization API 中，产品捆绑包称为 API 软件包。

如需使用 API 管理 API 商品套装，请参阅：
配置事务记录政策

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

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

制定费率方案，以定义适用于您的 API 的创收方法。例如，您是按固定费率还是可变费率收取 API 使用费。

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

购买已发布的费率方案 使用 API 购买已发布的费率方案，并根据需要将购买的费率方案过期或取消。
在开发者门户中配置创收功能 在开发者门户中配置创收功能，让开发者能够自助访问费率方案订阅、自动付款处理和结算、报告、商品清单以及其他创收专用设置。

管理获利

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

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