核發抵免額

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

簡介

營利設定可讓您彈性核發開發人員抵免額。

如果是預付開發人員,抵免額會顯示為減少用量,往後開發人員的預付餘額會隨之增減。與使用簽帳金融卡類似,當開發人員購買 API 產品套裝組合時,款項會從開發人員的預付餘額中扣除。開發人員必須維持足夠的購買交易餘額。請參閱如何計算剩餘的預付帳戶餘額?

如果是後付開發人員,抵免額會在月結單中單獨列為一行,以減少月結單費用。

探索抵免額頁面

存取及探索「抵免額」頁面,方法如下所述。

Edge

如何使用 Edge UI 存取「抵免額」頁面:

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

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

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

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

傳統邊緣 (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 月的帳單月份核發 $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 的查詢參數

下列查詢參數可與 Credit API 搭配使用:

名稱 說明 預設 必填與否
billingMonth

套用抵免額的帳單月份,例如 APRIL。

不適用
billingYear

套用抵免額的計費年,例如 2018 年。

不適用
currencyId

抵免額所使用的貨幣。開發人員購買的 API 產品套裝組合中,費率方案的幣別設定完畢,因此無法變更。

不適用
developerId

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

不適用
productId

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

不適用
transactionAmount

抵免額金額 (以指定幣別表示)。請指定正值或負值。此值不能為零。

不適用
transactionNote

請注意抵免額的原因。

不適用