设置创收功能的步骤

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

准备工作

在开始将 Monetization 与 Apigee 组织搭配使用之前，您需要执行以下前提任务：

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

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

Apigee 的初始设置

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

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

Apigee 配置团队会运行一个脚本，以将 Monetization 与您的组织以及您使用 Apigee Edge 创建的任何开发者、应用和 API 产品同步。 Apigee 支持人员日后可能会要求您同步组织，详情请参阅将 Apigee Edge 数据与 Monetization 同步。除非 Apigee 另有指示，否则请勿同步创收数据。

配置创收

下表总结了为 Apigee 组织配置 Monetization 所需的步骤。
步骤 说明
修改组织资料 在创收功能的初始设置过程中，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 数据与 Monetization 同步 如果 Apigee 指示您这样做，请重新同步数据与创收，以确保数据处于同步状态。 您可以同步以下内容：组织、API 产品、开发者和应用。
删除组织中的创收数据 您可能希望删除组织中的创收数据，以清理测试组织或删除组织。