颁发赠金

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

简介

通过启用创收功能，您可以灵活地发放开发者赞助。

对于预付费开发者，赠金表现为使用量减少，这会增加或减少开发者未来的预付款余额。与使用借记卡类似，当开发者购买 API 产品套装时，系统会从开发者的预付费余额中扣款。开发者必须拥有充足的余额，以便用户购物。请参阅如何计算预付费账号的剩余余额？

对于后付费开发者，赠送金额会在账单中显示为单独的一行，从而减少账单中的扣款金额。

探索“赠金”页面

访问并探索“抵用金”页面，如下所述。

发放赠金

1. 访问“赠金”页面。
2. 点击 + 演职员表。
3. 输入以下信息：

   字段	说明
   结算月份	赠金适用的结算月份。从列表中选择一个月份。
   开发者	赠金适用的开发者或公司名称。在文本框中输入名称。 在您输入字符串时，下拉列表中会显示包含该字符串的开发者/公司的列表。 点击下拉列表中的开发者或公司名称。 注意：选择开发者或公司后，系统会显示其余字段。 如果您选择的公司或开发者尚未接受费率方案，则无法发放抵用金。
   产品套装	适用于抵用金的 API 产品套装。从可用 API 产品套件列表中进行选择。
   产品	所选 API 产品套件中适用抵用金的 API 产品。从列表中选择所有商品或单个 API 产品。
   币种	赠送金额所用的币种。币种是针对开发者购买的 API 产品套装中的费率方案配置的，无法更改。 如果费率方案中定义了多种货币，您可以从其中一种货币中进行选择。
   金额	赠金金额（以指定货币计）。指定正值或负值。该值不能为零。
   备注	可选备注，用于说明赠送抵用金的原因。

4. 点击保存功劳。

使用 API 发放抵用金

使用此 API，您可以针对整个 API 产品套件或 API 产品套件中特定 API 产品的使用情况向开发者发放积分。

要使用 API 发放赠送金额，请向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions 发出 POST 请求，其中 {package_id} 和 {rate-plan_id} 分别定义要应用赠送金额的 API 产品套装和费率方案的标识。

发出请求时，您需要指定以下查询参数：

• 赠送金额的适用开发者 ID（电子邮件地址）。
• 赠送金额。
• 赠送金额所用的币种。
• 说明赠送抵用金原因的备注。

您可以选择指定以下其他查询参数：

• 赠金适用的结算月份。此值默认为当月。
• 赠送金额适用的结算年度。此值默认为当前年份。
• 抵用金适用的 API 产品。如果您未指定 API 产品 ID，则赠金将应用于 API 产品套装中的所有 API 产品。

例如，以下请求会向标识为 dev1@myorg.com 的开发者针对 2018 年 4 月的账单月份发放 100 美元的赠金。这笔赠金适用于 payment API 产品套装和 payment_standard_plan 费率方案：

如需查看您可以在抵用金请求中指定的查询参数的完整列表，请参阅 credits API 的查询参数。

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

以下是响应的摘录示例：

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

用于 credits API 的查询参数

以下查询参数可用于 Credits API：

名称	说明	默认值	是否必需？
billingMonth	赠金适用的结算月份，例如 APRIL。	不适用	否
billingYear	赠金适用的结算年份，例如 2018 年。	不适用	否
currencyId	赠送金额所用的币种。币种是为开发者购买的 API 产品套装中的费率方案配置的，无法更改。	不适用	是
developerId	获得抵用金的开发者或公司名称。	不适用	是
productId	抵用金适用的 API 产品。如果您未指定产品 ID，则抵用金会应用于 API 产品套装中的所有 API 产品。	不适用	否
transactionAmount	抵用金金额（以指定币种表示）。指定正值或负值。该值不能为零。	不适用	是
transactionNote	说明赠送抵用金的原因的备注。	不适用	是