核發抵免額

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

簡介

營利功能可讓您彈性發放開發人員抵免額。

如果是預付開發人員,抵免額會顯示為用量減少,這會增加或減少開發人員日後的預付餘額。與使用簽帳金融卡類似,開發人員購買 API 產品組合時,系統會從預付餘額扣款。開發人員必須維持足夠的餘額,才能進行購買。請參閱「如何計算預付帳戶的剩餘餘額?」一文。

後付型開發人員的抵免額會顯示在月結單的獨立一行,減少月結單中的費用。

瀏覽「抵免額」頁面

存取及瀏覽「抵免額」頁面,方法如下。

邊緣

如要透過 Edge UI 存取「點數」頁面,請按照下列步驟操作:

  1. 登入 apigee.com/edge
  2. 在左側導覽列中,依序選取「發布」>「營利」>「抵免額」

系統隨即會顯示「抵免額」頁面。

如圖所示,「抵免額」頁面可讓您:

  • 查看所有抵免額的摘要資訊,包括收件者名稱、抵免額金額、抵免額生效日期和時間、抵免額適用的 API 產品組合和 API 產品,以及新增的任何附註
  • 核發抵免額
  • 搜尋抵免額清單

Classic Edge (Private Cloud)

如要使用傳統 Edge UI 存取「點數」頁面,請按照下列步驟操作:

  1. 登入 http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 選取頂端導覽列中的「營利」>「營利報表」

「抵免額」頁面可讓您:

  • 查看所有抵免額的摘要資訊,包括收件者名稱、抵免額金額、抵免額生效日期和時間、抵免額適用的 API 產品組合和 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 月的帳單月份,向 ID 為 dev1@myorg.com 的開發人員發放 $100 美元的抵免額。抵免額適用於 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

抵免額適用的帳單月份,例如「4 月」。

N/A
billingYear

抵免額適用的帳單年度,例如 2018 年。

N/A
currencyId

抵免額使用的幣別。貨幣是為開發人員購買的 API 產品組合中的費率方案設定,無法變更。

N/A
developerId

適用抵免額的開發人員或公司名稱。

N/A
productId

抵免額適用的 API 產品。如未指定產品 ID,抵免額會套用至 API 產品組合中的所有 API 產品。

N/A
transactionAmount

抵免額金額 (以指定幣別計算)。指定正數或負數。值不得為零。

N/A
transactionNote

說明抵免額原因的附註。

N/A