颁发赠金

您正在查看的是 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 产品。

例如，以下请求将 2018 年 4 月结算月份的 100 美元赠金发放给标识为 dev1@myorg.com 的开发者。此赠金适用于 payment API 产品套装和 payment_standard_plan 费率方案：

如需查看可在赠金请求中指定的查询参数的完整列表，请参阅赠金 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"
}

赠金 API 的查询参数

以下查询参数可用于额度 API：

名称	说明	默认	是否必需？
billingMonth	赠送金额适用的结算月份，例如 APRIL。	不适用	否
billingYear	赠送金额适用的结算年份，例如 2018。	不适用	否
currencyId	赠送金额使用的币种。币种是在开发者购买的 API 软件包中针对费率方案配置的，无法更改。	不适用	是
developerId	赠送金额适用的开发者或公司名称。	不适用	是
productId	赠送金额适用的 API 产品。如果您未指定产品 ID，则该赠金会应用于 API 产品组合中的所有 API 产品。	不适用	否
transactionAmount	赠送金额（以指定的货币为单位）。指定正值或负值。该值不能为零。	不适用	是
transactionNote	注意：说明收到返还金额的原因。	不适用	是