管理房價方案

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

使用 UIAPI 來管理費率方案 (如下所述)。

探索費率方案頁面

存取費率方案頁面,說明如下。

邊緣

如要在 Edge UI 中查看費率方案,請前往「費率方案」頁面:

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

「顯示企劃書」頁面隨即顯示。

如圖所示,費率方案頁面可讓您執行下列操作:

傳統版 Edge (私有雲)

如要使用傳統版 Edge UI 查看費率方案,請前往「API Packages」(API 套件) 頁面:

  1. 登入 http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端的導覽列中依序選取「發布」>「套件」

「API 套件」頁面會顯示各套件定義的費率方案。

「費率方案」頁面可用於:

正在建立房價方案

如何建立房價方案:

  1. 前往「房價方案」頁面
  2. 按一下「+ 費率方案」
  3. 在頂端面板中設定下列欄位:
    欄位 說明 預設 必要
    房價方案名稱 房價方案名稱。

    注意:API 產品套裝組合中的名稱不得重複。同一個產品組合中的兩個方案不能使用相同的名稱。

    房價方案類型 房價方案類型。從下拉式清單中選取所需值。如需有效費率方案類型的清單,請參閱支援的費率方案類型
    產品套裝組合 API 產品套裝組合。從下拉式清單中選取所需值。若要進一步瞭解 API 產品套裝組合,請參閱管理 API 產品套裝組合

    如果您選用的產品組合包含多項 API 產品,則必須為各個 API 產品選取個別費率方案,還是要套用至所有 API 產品的一般費率方案。

    目標對象 可存取房價方案的目標對象。從下拉式清單中選取下列其中一個值:
    • 所有人 - 所有開發人員。
    • 開發人員 - 開發人員或公司。輸入開發人員名稱或公司名稱。在你輸入時,下拉式選單中會顯示包含該字串的開發人員/公司清單。在下拉式清單中,按一下開發人員或公司的名稱。
    • 開發人員類別:開發人員類別。從下拉式清單中選取開發人員類別。

      視需要設定開發人員類別,詳情請參閱管理開發人員類別

    所有人
    開始日期 房價方案生效的日期。輸入開始日期,或使用日曆選取日期。 今天
    結束日期 房價方案的結束日期。如要指定結束日期,請啟用「含結束日期」切換按鈕,然後輸入結束日期,或使用日曆選取日期。

    注意:費率方案的生效日期為指定日期的當天。舉例來說,如果要將費率方案設為 2018 年 12 月 1 日,就必須將 endDate 值設為 2018-11-30。在這種情況下,費率方案會在 2018 年 11 月 30 日結束時失效;所有在 2018 年 12 月 1 日的要求都會遭到封鎖。

    入口網站可檢視 將房價方案設為「公開」或「私人」。請參閱公開費率與不公開費率方案 已啟用
  4. 設定費率方案的費用。請參閱設定費率方案的費用
    注意:不適用於可調整的通知計畫。
  5. 如果您選取的產品組合包含多個 API 產品,請在「特定或一般費率方案」部分設定下列偏好設定:
    注意:這個步驟不適用於可調整的通知計畫。
    欄位 說明 預設
    針對每項產品個別設定 這個旗標用於指定每個 API 產品的個別費率方案。 已停用
    分別設定每項產品的免費增值優惠 此旗標用於指定每個 API 產品的免費增值方案。 已停用
    選取產品 如果同時啟用其中一項或兩項旗標,您必須從下拉式清單中選取各項產品,並設定費率方案詳細資料。

    注意:請確認您已設定產品套裝組合中的所有產品。

  6. 根據所選費率方案類型設定費率方案詳細資料:
  7. 點選以下其中一個選項:
    按鈕 說明
    儲存為草稿 將房價方案儲存為草稿。

    在您發布費率方案後,應用程式開發人員才會看到房價方案。您可以在草稿費率方案中編輯任何欄位。

    發布新方案 發布方案。

    注意:發布費率方案後,如果您尚未設定結束日期,就只能修改結束日期。費率方案一經發布即無法刪除,但你可以到期費率方案,改訂較新的費率方案,詳情請參閱「到期費率方案」一節。

  8. 營利限制檢查政策附加至與費率方案所含 API 產品相關聯的 API Proxy。營利限制檢查政策會限制 API Proxy 的營利限制,並確保數據分析和營利報表中擷取了所有錯誤。詳情請參閱「強制執行 API Proxy 的營利限制」一文。

正在編輯房價方案

您可以編輯草稿費率方案中的所有欄位,但產品組合、類型和目標對象除外。發布費率方案後,只有在未指定結束日期的情況下,你才能編輯結束日期。

如何編輯房價方案:

  1. 前往「房價方案」頁面
  2. 按一下要編輯的費率方案資料列。
    畫面上會顯示房價方案面板,
  3. 視需要編輯費率方案欄位。
    注意:發布費率方案後,如果您尚未設定結束日期,就只能修改結束日期。
  4. 點選以下其中一個選項:
    按鈕 說明
    更新草稿 (草稿費率方案) 將房價方案儲存為草稿。

    在您發布之前,應用程式開發人員不會看到這個費率方案。您可以在草稿費率方案中編輯任何欄位。
    發布草稿 (草稿費率方案) 發布費率方案。

    注意:發布費率方案後,如果您尚未設定結束日期,就只能修改結束日期。費率方案一經發布即無法刪除,但你可以到期費率方案,改訂較新的費率方案,詳情請參閱「到期費率方案」一節。
    新版結束日期 (已發布的定價方案) 設定已發布企劃書的結束日期。

    注意:設定已發布費率方案的結束日期後,就無法再修改。

正在刪除草稿費率方案

如果不再需要草稿費率方案,請刪除。

注意:您無法刪除已發布的費率方案。

如要刪除草稿費率方案,請按照下列步驟操作:

  1. 前往「房價方案」頁面
  2. 將滑鼠遊標移到要刪除的費率方案上,即可顯示動作選單。
  3. 按一下「」。
  4. 點選「刪除」加以確認。

使用 API 管理費率方案

以下各節說明如何使用 API 管理費率方案。

使用 API 建立房價方案

如要建立費率方案,請向 /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans 發出 POST 要求,其中 {monetizationpackage_id} 是您要建立費率方案的 API 產品套件 ID (您建立 API 產品套件時,回應中會傳回 ID)。

建立費率方案時,您必須在要求主體中指定下列資訊:

  • 機構組織 ID
  • API 產品軟體包 ID
  • 房價方案名稱
  • 房價方案說明
  • 費率方案的範圍 (適用於所有開發人員,或僅適用於特定開發人員、公司或開發人員類別)
  • 房價方案生效的日期
  • 房價方案的貨幣
  • 是否發布房價方案
  • 房價方案為公開或不公開

您可以視需要調整其他設定,例如付款截止期間 (例如 30 天)。請參閱費率方案的設定屬性

如果您為含有多項產品的 API 產品套裝組合建立費率方案 (不含費用方案),可以將方案套用至產品套裝組合中的特定產品。方法是在要求中識別產品。如果您沒有識別產品,系統會將方案套用至 API 產品套裝組合中的所有產品。

以下各節說明如何建立費率方案:

使用 API 建立標準費率方案

如要建立標準費率方案,請將 type 屬性設為 STANDARD,如以下範例所示。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

使用 API 建立開發人員或公司費率方案

如要將費率方案套用至特定開發人員或公司,請將 type 值設為 Developer。您也需要在要求中指明開發人員或公司,識別公司的 ID、法定名稱和公司名稱。

舉例來說,下列摘錄會為 Dev Five 開發人員建立房價方案:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

使用 API 建立開發人員類別費率方案

如要將費率方案套用至開發人員類別,請將 type 值設為 Developer_Category。此外,您也必須在要求中指明開發人員類別。 例如:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

使用 API 建立 API 產品專屬費率方案

為含有多個 API 產品的 API 產品套裝組合建立費率方案時,您可以分別指定 API 產品的費率方案詳細資料。

舉例來說,下列程式碼會建立兩項 API 產品的收益分潤方案:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

如要將 API 產品新增至 my-package API 產品套裝組合,您必須按照使用 API 產品專屬費率方案將 API 產品新增至 API 產品套件說明為 API 產品新增費率方案詳細資料。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

使用 API 將費率方案設為公開或私人

建立費率方案時,您可以使用要求主體中的 isPrivate 屬性來指定公開或不公開。如果設為 true,費率方案將設為不公開。詳情請參閱公開與不公開費率方案

舉例來說,以下是建立不公開費率方案:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

使用 API 發布費率方案

如要發布費率方案,請在建立費率方案時將 published 屬性值設為 true。開發人員將可在企劃書的 startDate 屬性中指定的日期中查看費率方案。

舉例來說,以下是建立並發布價目表方案 (只顯示部分要求)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

使用 API 儲存費率方案草稿

如要儲存費率方案,而不發布該方案,請在建立費率方案時將 published 屬性值設為 false。

舉例來說,下列程式碼會建立價目表方案,並儲存為草稿 (只顯示部分要求):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

使用 API 編輯費率方案草稿

如要更新費率方案草稿,請向 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id} 發出 PUT 要求,其中 {package_id} 是 API 套件的識別資訊,而 {plan_Id} 是費率方案的識別項目。更新時,您必須在要求主體中指定更新後的設定和費率方案 ID。如要更新費率方案費率,請一併指定費率方案費率的 ID。舉例來說,以下要求會更新費率方案的費率 (ID 為 location_flat_rate_card_plan (醒目顯示的部分):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

回應包含新版費率方案費率 (僅會顯示部分回應):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

使用 API 查看費率方案

您可以使用營利 API 查看費率方案,詳情請見下列各節。

透過 API 查看機構的所有費率方案

如要查看機構的所有費率方案,請向 /mint/organizations/{org_name}/rate-plans 發出 GET 要求,其中 {org_name} 是貴機構的名稱。

您可以傳遞下列查詢參數以篩選結果:

查詢參數 說明
all 這個旗標可指定是否要傳回所有費率方案。如果設為 false,則每頁傳回的費率方案是由 size 查詢參數定義。預設值為 true
size 每個網頁傳回的 API 套件數量。如果將 all 查詢參數設為 true,系統會忽略這個參數。
page 您要傳回的網頁數量 (如果內容分頁的話)。如果將 all 查詢參數設為 true,系統會忽略這個參數。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

使用 API 查看 API 產品套裝組合的所有費率方案

如要查看 API 套件的所有費率方案,請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans 發出 GET 要求,其中 {package_id} 是 API 套件的 ID (建立營利套件時會傳回套件 ID)。

根據預設,結果只會傳回有效的、公開和標準費率方案。包括:

  • 如果是草稿或過期方案,請將 current 查詢參數設為 false (例如 ?current=false)。
  • 不公開費率方案:將 showPrivate 查詢參數設為 true (例如 ?showPrivate=true)。
  • 針對所有標準費率方案,請將 standard 查詢參數設為 true (例如 ?standard=true)。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

使用 API 查看 API 套件的費率方案

如要查看 API 套件的費率方案,請向 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id} 發出 GET 要求,其中 {package_id} 是 API 套件的 ID,而 {plan_id} 是費率方案的 ID (您建立營利套件時會傳回套件 ID,建立費率方案時會傳回費率方案 ID)。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

以下為回應範例:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

查看開發人員使用 API 的所有有效費率方案

如要查看開發人員的所有有效費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans 發出 GET 要求,其中 {developer_id} 是開發人員的電子郵件地址。

您可以傳遞下列查詢參數以篩選結果:

查詢參數 說明
all 此旗標可指定是否傳回所有 API 套件。如果設為 false,則每頁傳回的 API 套件數量是由 size 查詢參數定義。預設值為 false
size 每個網頁傳回的 API 套件數量。預設值為 20。如果將 all 查詢參數設為 true,系統會忽略這個參數。
page 您要傳回的網頁數量 (如果內容分頁的話)。如果將 all 查詢參數設為 true,系統會忽略這個參數。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

以下為回應範例:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

查看使用 API 的開發人員適用的費率方案

如要查看開發人員的有效費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 發出 GET 要求,其中 {developer_id} 是開發人員的電子郵件地址,{developer_rateplan_id} 是您在接受發布費率方案時,在回應中傳回的已接受費率方案。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

以下為回應範例:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

查看接受採用費率方案 (適用於採用 API 的 API 產品) 的開發人員

如要查看含有 API 產品的開發人員適用的費率方案,請向 /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product 發出 GET 要求,其中 {developer_id} 是開發人員 ID,/{product_id} 則是產品 ID。

根據預設,搜尋結果中只會傳回公開費率方案。如要顯示不公開費率方案,請將 showPrivate 查詢參數設為 true (例如 ?showPrivate=true)。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

查看開發人員使用 API 接受的所有費率方案

如要查看開發人員已接受的費率方案,請向 /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans 發出 GET 要求,其中 {developer_id} 是開發人員 ID。

您可以傳遞下列查詢參數以篩選結果:

查詢參數 說明
all 此旗標可指定是否傳回所有 API 套件。如果設為 false,則每頁傳回的 API 套件數量是由 size 查詢參數定義。預設值為 false
size 每個網頁傳回的 API 套件數量。預設值為 20。如果將 all 查詢參數設為 true,系統會忽略這個參數。
page 您要傳回的網頁數量 (如果內容分頁的話)。如果將 all 查詢參數設為 true,系統會忽略這個參數。

例如:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

以下為回應範例:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

使用 API 刪除費率方案草稿

如要刪除費率方案草稿,請向 /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id} 發出 DELETE 要求,其中 {plan_Id} 是要刪除的費率方案 ID,而 {package_id} 是費率方案的 API 套件識別項目。例如:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

房價方案設定屬性

使用 API 建立費率方案時,您可以指定下列配置設定。

姓名 說明 預設 必填與否
advance

僅適用於週期性費用。此旗標用於指定是否定期收取週期性費用。有效值包括:

  • true - 系統會預先收費。舉例來說,如果週期是 1 個月,則系統會在前一個帳單週期結束後產生的月結單上收取週期性費用。
  • false - 帳單週期結束時系統會向你收取週期性費用。舉例來說,如果週期是 1 個月,則系統會在當前帳單月份結束後,依據月結單收取週期性費用。此為預設值。
false
contractDuration

方案搭配 contractDurationType 使用的合約長度。 舉例來說,如要指定合約效期為 6 個月,請將 contractDuration 設為 6,並將 contractDurationType 設為 MONTH

contractDurationType

搭配 contractDuration 使用的方案合約長度。有效的值包括:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
currency

費率方案使用的貨幣。指定貨幣的 ISO 4217 代碼,例如 usd 代表美元,chf 代表瑞士法郎。

description

房價方案說明。

developer

開發人員 ID (電子郵件地址)。僅適用於開發人員費率方案。

developerCategory

開發人員類別 ID。僅指定開發人員類別費率方案。

displayName

費率方案中容易使用的顯示名稱。

earlyTerminationFee

如果開發人員在續約日前取消訂閱方案,系統會收取一次性的費用。

endDate

方案結束日期。在這個日期之後,開發人員無法查看費率方案。如果您不希望費率方案在特定日期結束,請指定 endDate 的空值。

費率方案的生效日期為指定日期的當天。舉例來說,如果要在 2016 年 12 月 1 日到期費率方案,請將 endDate 值設為 2016-11-30。在這種情況下,費率方案將於 2016 年 11 月 30 日結束時失效;所有指定的要求將於 2016 年 12 月 1 日遭到封鎖。

注意:使用 API 查看費率方案時,將 endDate 時間戳記指定為 YYYY-MM-DD 00:00:00,以免誤導。

freemiumDuration

免費增值期間與 freemiumDurationType 之間的時間範圍。舉例來說,如要指定免費增值期為 30 天,請將 freemiumDuration 設為 30,並將 freemiumDurationType 設為 DAY

freemiumDurationType

將免費增值期與 freemiumDuration 搭配使用的期間。 有效值包括:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
freemiumUnit

免費增值數量。這個值可以是交易次數,或與交易記錄政策所記錄自訂屬性的單位數量。

frequencyDuration

僅適用於週期性費用。週期性費用與 frequencyDurationType 相隔的時間範圍。例如,如要指定收費費用的時間範圍為 30 天,請將 frequencyDuration 設為 30,並將 frequencyDurationType 設為 DAY

frequencyDurationType 僅適用於週期性費用。週期性費用與 frequencyDuration 相隔的時間範圍。有效值包括:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
isPrivate 這個旗標可指定費率方案為公開或不公開。預設為 false (公開)。詳情請參閱公開費率與不公開費率方案
monetizationPackage

費率方案的 API 產品套裝組合 ID。

name

房價方案名稱。

organization

費率方案的機構 ID。

paymentDueDays

僅適用於週期性費用。到期的費用。例如,將值設為 30,表示費用會在 30 天內到期。

proRate

僅適用於週期性費用。用於指明開發人員是否會在某個月內開始或結束方案的部分內容,按比例收費。有效的值包括:

  • true - 期初費用會按照期結束前的天數 (或您在該期間所使用的天數) 按比例計算。
  • false - 無論開發人員開始 (或結束) 方案,系統都會收取全額初始費用。此為預設值。
false
published

此旗標用於指定是否應發布費率方案,以供開發人員查看。有效值包括:

  • true - 發布費率方案。
  • false - 請勿發布費率方案。
ratePlanDetails

費率方案的詳細資料 (請參閱費率方案詳細資料的設定屬性)。

recurringFee

向開發人員持續收費,直到開發人員結束方案為止。

recurringStartUnit

只有在 recurringType 設為 CALENDAR 時才會生效。在該月份收取週期性費用的費用。舉例來說,如果週期性費用按月收費,而 recurringStartUnit 設為 1,則系統會在每個月第一天收取週期性費用。

recurringType

排定週期性費用。有效值包括:

  • CALENDAR - 依日曆安排時間。
  • CUSTOM - 根據自訂日期設定排定時間。
setUpFee

從方案開始日期 (即開發人員購買方案的日期) 開始向開發人員收取的一次性費用。

startDate

方案開始日期。開發人員從該日期起可以查看費率方案。

type

房價方案類型。指定下列其中一項:

  • STANDARD。適用於所有開發人員。
  • DEVELOPER_CATEGORY。適用於所選類別的所有開發人員。
  • DEVELOPER:適用於特定開發人員或公司。

房價方案詳細資料的設定屬性

建立費率方案時,您可以在 ratePlanDetails 陣列中指定下列任一設定主張。

姓名 說明 預設 必填與否
aggregateFreemiumCounters

此旗標用於指定是否啟用匯總計數器,以判斷 API 產品是否在免費範圍內。您必須啟用匯總計數器,才能為產品設定免費增值方案。有效值包括:

  • true - 啟用匯總計數器。
  • false - 請勿啟用匯總計數器。
aggregateStandardCounters

此旗標用於指定是否使用匯總計數器來判定用量頻帶 (例如價目表方案的體積)。這個值可以是下列其中一個值:

  • true - 使用匯總計數器。
  • false - 請勿使用匯總計數器。
aggregateTransactions

注意:這項屬性目前未在營利時使用,因此可以忽略。

true
currency

Currency (貨幣)

duration

計算頻率的時間範圍加上 durationType,其中允許的 duration 值為 1-24。

舉例來說,您可以將 duration 設為 2,並將 durationType 設為 MONTH,以指定 2 個月的計算頻率。

durationType

計算頻率的時間範圍加上 duration。唯一有效的值是 MONTH

如需使用範例,請參閱 duration

freemiumDuration

個別 API 產品的免費增值期與 freemiumDurationType 的時長。例如,如要指定 API 產品的免費增值期為 30 天,請將 freemiumDuration 設為 30,並將 freemiumDurationType 設為 DAY

freemiumDurationType

個別 API 產品的免費增值期與 freemiumDuration 的時長。有效值包括:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

舉例來說,如要指定 API 產品的免費增值期為 30 天,請將 freemiumDuration 設為 30,並將 freemiumDurationType 設為 DAY。

freemiumUnit

API 產品的免費增值量。這個值可以是交易次數,或與交易記錄政策中自訂屬性相關的單位數量。

meteringType

價目表方案的充電模式。有效值包括:

  • UNIT - 固定費率收費模式。
  • VOLUME - 音量充電模式。
  • STAIR_STEP - 隨附的充電模式。
  • DEV_SPECIFIC - 可調整的通知充電模式。不適用於其他收益模式。
organization

機構 ID

paymentDueDays

後付開發人員的付款截止日。例如,將值設為 30,表示付款期限為 30 天。

product

API 產品資訊,例如 ID。

ratePlanRates

費率方案費率詳細資料,例如費率方案類型 (REVSHARERATECARD)、價目表方案的費率、收益分潤方案的收益分潤,以及範圍 (套用費率方案的開始單位和結束單元)。

ratingParameter

房價方案基礎服務。費率方案是以交易或自訂屬性為基礎。有效值包括:

  • VOLUME - 房價方案取決於交易量。
  • custom_attribute - 自訂屬性的名稱 僅適用於 API 產品的交易錄音政策。自訂屬性名稱無法定義為 VOLUME
VOLUME
ratingParameterUnit

適用於 ratingParameter. Only required if ratingParameter 的單位設為自訂屬性 (亦即未設定為 VOLUME)。

revenueType

收益分潤方案中的收益分潤。有效值包括:

  • GROSS - 收益分潤是根據交易總價的百分比計算。
  • NET - 收益分潤是根據交易淨價的百分比計算。
type

房價方案類型。有效值包括:

  • REVSHARE - 收益分潤模式。
  • RATECARD - 價目表模型。
  • REVSHARE_RATECARD - 收益分潤和價目表模式。
  • USAGE_TARGET - 可調整的通知模型。

如要進一步瞭解費率方案類型,請參閱支援的費率方案類型