<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
简介
借助创收功能，您可以灵活地发放开发者赠金。
对于预付费开发者， 赠金也表现为使用量减少，这会增加或减少开发者未来的预付款余额。非常像 使用借记卡付款时，如果开发者使用借记卡， 开发者购买了 API 产品套装。开发者必须在 购买。请参阅如何计算预付款账号的剩余余额？
对于后付费开发者，退款金额显示为 单独的一行中，从而减少账单中的费用。
探索“赠金”页面
访问并浏览“赠金”页面（如下所述）。
Edge
如需使用 Edge 界面访问“赠金”页面，请执行以下操作：
- 登录 apigee.com/edge。
- 选择发布 >创收 >赠金。
系统随即会显示“赠金”页面。
如图所示，您可以通过“赠金”页面执行以下操作：
- 查看所有赠送金额的摘要信息，包括收款人姓名、赠送金额金额、赠送金额生效日期和时间。 赠送金额适用的 API 产品套装和 API 产品，以及所添加的任何备注
- 发放授信
- 搜索赠金列表
传统 Edge（私有云）
如需使用传统版 Edge 界面访问“赠金”页面，请执行以下操作：
- 登录
http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 选择创收 >创收报告。
通过“赠金”页面，您可以：
- 查看所有赠送金额的摘要信息，包括收款人姓名、赠送金额金额、赠送金额生效日期和时间。 赠送金额适用的 API 产品套装和 API 产品，以及所添加的任何备注
- 发放授信
- 搜索赠金列表
发放赠金
- 访问“赠金”页面。
- 点击 + 赠金。
- 输入以下信息：
字段 说明 结算月份 赠金适用的结算月份。从列表中选择月份。
开发者 赠金适用的开发者或公司名称。在文本框中输入名称。 在您输入时，下拉列表中会显示一个包含该字符串的开发者/公司列表。 在下拉列表中点击开发者或公司的名称。
注意：您选择开发者或公司后，系统会显示其余字段。 如果您选择的公司或开发者尚未接受价格方案，那么您将无法发放赠金。
商品套装 赠送金额适用的 API 产品套装。从可用的 API 产品包列表中进行选择。
产品 赠送金额适用的选定 API 产品套装中的 API 产品。选择 所有产品或列表中的单个 API 产品。
货币 赠金所用的币种。币种是为 且无法更改。 如果费率方案中定义了多种货币，您可以从其中一种货币中进行选择。
金额 赠金金额（以指定货币计）。指定正值或负值。该值不能为零。
备注 用于说明获得赠金原因的可选备注。
- 点击保存功劳。
使用 API 发放赠金
使用 API，针对整个 API 产品包向开发者发放赠金，或 禁止使用某个 API 产品包中的特定 API 产品。
要使用 API 发放返还金额，请向以下账号发出 POST 请求：
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions,
其中，{package_id} 和 {rate-plan_id} 定义
分别对应赠送金额适用的 API 产品套装和费率方案的识别信息。
发出请求时，需要将以下内容指定为查询参数：
- 赠送金额适用的开发者 ID（电子邮件地址）。
- 赠金金额。
- 赠金所用的币种。
- 说明退款原因的说明。
您还可以选择指定以下其他查询参数：
- 赠金适用的结算月份。该值默认为当前的 。
- 赠金适用的结算年份。此值默认为当前年份。
- 赠金适用的 API 产品。如果您未指定 API 产品 ID，则赠送金额适用于 API 产品套装中的所有 API 产品。
例如，以下请求针对 2018 年 4 月的结算月份发放 100 美元的赠金
发送给标识为 dev1@myorg.com 的开发者。赠金适用于
payment 个 API 产品套装和 payment_standard_plan 个费率方案：
如需查看查询参数的完整列表，请参阅 credit 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 |
赠金所用的币种。币种是为需要 且无法更改。 |
不适用 | 是 |
developerId |
赠金适用的开发者或公司名称。 |
不适用 | 是 |
productId |
赠金适用的 API 产品。如果您不指定产品 ID， 赠金适用于 API 产品套装中的所有 API 产品。 |
不适用 | 否 |
transactionAmount |
赠金金额（以指定货币计）。指定正值或负值。该值不能为零。 |
不适用 | 是 |
transactionNote |
请注意，说明获得赠金的原因。 |
不适用 | 是 |