您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息
简介
通过创收功能，您可以灵活地发放开发者抵扣金。
对于预付费开发者，返还的信用额度会显示为用量减少，这会增加或减少开发者未来的预付款余额。与使用借记卡类似，当开发者购买 API 产品套装时，系统会从开发者的预付款余额中扣除相应资金。开发者必须保持足够的余额才能进行购买。请参阅如何计算预付款账号的剩余余额？
对于后付费开发者，赠金会显示在账单中的单独一行，从而减少账单中的费用。
探索“积分”页面
访问并探索“积分”页面，如下所述。
Edge
如需使用 Edge 界面访问“积分”页面，请执行以下操作：
- 登录 apigee.com/edge。
- 在左侧导航栏中选择发布 > 创收 > 积分。
系统会显示“积分”页面。
如图所示，您可以通过“积分”页面执行以下操作：
- 查看所有赠金的摘要信息，包括接收者名称、赠金金额、赠金生效日期和时间、赠金适用的 API 产品包和 API 产品，以及添加的任何备注
- 发放积分
- 搜索提供方名单
经典边缘（私有云）
如需使用经典版 Edge 界面访问“积分”页面，请执行以下操作：
- 登录
http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。 - 在顶部导航栏中，依次选择创收 > 创收报告。
通过“积分”页面，您可以执行以下操作：
- 查看所有赠金的摘要信息，包括接收者名称、赠金金额、赠金生效日期和时间、赠金适用的 API 产品包和 API 产品，以及添加的任何备注
- 发放积分
- 搜索积分列表
发放赠金
- 访问“积分”页面。
- 点击 + 积分。
- 输入以下信息：
字段 说明 结算月份 应用相应抵扣的结算月份。从列表中选择月份。
开发者 适用相应积分的开发者或公司名称。在文本框中输入名称。 随着您的输入，下拉列表中会显示包含相应字符串的开发者/公司列表。 在下拉列表中点击开发者或公司的名称。
注意：选择开发者或公司后，系统会显示其余字段。 如果您选择的公司或开发者尚未接受费率方案，则无法发放抵扣。
产品组合 相应积分所适用的 API 产品包。从可用的 API 产品包列表中进行选择。
产品 所选 API 产品包中应用相应积分的 API 产品。从列表中选择所有产品或单个 API 产品。
货币 赠金所用的币种。币种是在开发者购买的 API 产品套装中为费率方案配置的，无法更改。 如果某个费率方案中定义了多种币种，您可以选择其中一种币种。
金额 赠金金额（以指定币种表示）。指定一个正值或负值。值不能为零。
注意 用于说明信用原因的可选备注。
- 点击保存积分。
使用 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 的开发者发放 100 美元的贷项，用于 2018 年 4 月的结算月份。赠金适用于以下 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" }
Credits API 的查询参数
以下查询参数可与 Credits API 搭配使用：
| 名称 | 说明 | 默认值 | 是否必需？ |
|---|---|---|---|
billingMonth |
相应赠金适用的结算月份，例如 APRIL。 |
不适用 | 否 |
billingYear |
赠金适用的结算年份，例如 2018 年。 |
不适用 | 否 |
currencyId |
赠金所用的币种。币种是在开发者购买的 API 产品套装中的费率方案中配置的，无法更改。 |
不适用 | 是 |
developerId |
适用相应积分的开发者或公司名称。 |
不适用 | 是 |
productId |
赠金适用的 API 产品。如果您未指定产品 ID，则相应抵扣将适用于 API 产品套装中的所有 API 产品。 |
不适用 | 否 |
transactionAmount |
赠金金额（以指定币种表示）。指定一个正值或负值。值不能为零。 |
不适用 | 是 |
transactionNote |
说明抵扣原因的备注。 |
不适用 | 是 |