管理支援的貨幣

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

簡介

Apigee Edge 設定團隊是營利功能的初始設定過程中 設定貨幣和貴機構支援的預設貨幣。

您可以查看貴機構支援的貨幣、新增支援的貨幣,或 刪除支援的貨幣 (如果開發人員或費率方案未使用這類貨幣)。

透過 UI 管理支援的貨幣

管理支援的貨幣,並設定「稅金和幣別」的預設貨幣 部分中的「機構簡介」部分。詳情請參閱管理 透過使用者介面管理機構資料

使用 API 管理支援的貨幣

按照下列各節所述,使用 API 管理支援的貨幣。

使用 API 查看支援的貨幣

查看貴機構支援的個別貨幣或所有貨幣 享有更多支援

如要查看貴機構支援的個別貨幣,請發出 GET 要求到 /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId},其中 {supportedCurrency_id} 代表支援的貨幣標示 次觀看。例如:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

如要查看貴機構支援的所有貨幣,請傳送 GET 要求至 /mint/organizations/{org_name}/supported-currencies。例如:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

以下提供回應範例:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

使用 API 設定預設貨幣

currency 值設為支援的 ISO 4217 貨幣,為機構設定預設貨幣 新增程式碼,如「管理機構」一節所述 儲存設定檔

使用 API 編輯支援的貨幣

如要編輯支援的貨幣,請發出 PUT 要求到 /mint/organizations/{org_name}/{supportedCurrencyId},其中 {supportedCurrency_id} 代表支援的貨幣標示 已更新。您必須在要求主體中指定已更新的屬性 以及支援的貨幣 ID例如,下列 API 呼叫 編輯支援貨幣的說明和顯示名稱 (更新後的屬性 醒目顯示的部分):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

使用 API 刪除支援的貨幣

如要刪除支援的貨幣,請提出 DELETE 要求給 /mint/organizations/{org_name}/supported-currencies/{currency_id},其中 {currency_id} 是要刪除的支援貨幣。例如:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

API 的幣別設定屬性

下表摘要說明可透過 API 進行設定的設定屬性。

名稱 說明 預設 必填與否
creditLimit

這個屬性僅適用於後付型開發人員。 支援的貨幣。

不適用
說明

支援貨幣的說明。

不適用
displayName

支援幣別的顯示名稱。

不適用
minimumTopupAmount

這個屬性僅適用於預付型開發人員。開發人員能以指定幣別為預付帳戶餘額儲值的最低金額。

不適用
名稱

ISO 4217 代碼 例如美元 (USD) 代表美元。

不適用
機構

支援幣別的機構組織。

不適用
狀態

支援幣別的狀態。有效值包括:

  • ACTIVE:支援的貨幣。
  • 無效:無法使用支援的貨幣。
不適用
virtualCurrency

指出支援的貨幣是否為虛擬貨幣。有效值包括:

  • true:支援的貨幣為虛擬貨幣。
  • false:支援的幣別不是虛擬貨幣。
不適用