设置创收功能的步骤

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

准备工作

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

  • 按照创建 Apigee Edge 帐号中的说明创建 Apigee Edge 帐号。
  • 购买创收功能。Edge 最初未包含变现 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 界面和 Monetize API 中，商品套装称为 API 软件包。

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

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

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

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

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

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

管理获利

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

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