遷移開發人員的營利方式

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

如果您有現有的開發人員需要遷移至營利功能，請按照下列步驟操作：

  1. 為要遷移的開發人員建立 API 產品、API 套件和費率方案 (如果還沒有)。詳情請參閱：
  2. 按照「發布費率方案」一節所述，發布費率方案。
  3. 如「註冊應用程式開發人員」一節所述，將新開發人員新增至貴機構。
  4. 請為每位開發人員儲值，詳情請參閱「管理預付帳戶餘額」一文。
  5. 按照「使用 API 的購買費率方案」所述，接受費率方案。

    注意：如果開發人員已被收取設定費用，請將 waivefees 查詢參數設為 true，即可免除設定費用。

  6. 如果您要遷移的開發人員有現有交易，可以使用下列資源手動轉移交易使用情形：
    /organizations/{org_name}/transactions，其中 {org_name} 是機構名稱。

    注意：如果開發人員沒有現有交易，可以略過這個步驟。

    transactions 資源會插入單一交易，反映目前的交易用量，並更新所有內部計數器，以反映此新值。

    舉例來說，如果開發人員在遷移前已向 API 發出 1000 次呼叫，您可以呼叫 transactions 資源，並在要求主體中將 batchSize 屬性設為 1000，藉此設定交易用量為 1000，以便擷取目前的活動。

    下表摘要說明您可以在要求主體中指定的設定屬性，手動設定交易次數、交易預設值，以及是否需要。

    屬性 說明 預設 必填與否
    application

    開發人員應用程式的 ID。

    		 不適用 是
    batchSize

    要轉移的交易次數。

    		 1 否
    custAttn

    與 batchSize 搭配使用，用於計算交易用量的自訂屬性值。

    訊息中的自訂屬性編號必須指定為正整數或小數 (最多四捨五入小數點後四位) 值。不得使用負值。

    自訂屬性必須定義於：

    		 不適用 是
    product

    API 產品的 ID。

    		 不適用 是
    type

    必須設為 CHARGE (預設值)。

    		 CHARGE 否

    如要略過驗證步驟並強制設定交易數量，請將 force 查詢參數設為 true (例如 ?force=true)。根據預設，系統會執行 ?force=false 和驗證步驟。舉例來說，如果預付開發人員的餘額為零，且帳戶活動已暫停，則在驗證期間，?force=false 要求會失敗。

    舉例來說，下列要求會將指定應用程式和 API 產品的交易數量設為 50：

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize":50
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password

    以下要求會將指定應用程式和 API 產品的交易用量設為 12.5。在要求中，batchSize 設為 125，且為 API 產品定義的第一個自訂屬性設為 0.1。相乘後，125 * 0.1 為 12.5。

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize": 125,
   "custAtt1" : 0.1
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password
  7. 如果開發人員未支付必要的設定或週期性費用，您可以使用下列資源，手動收取費率方案的設定或週期性費用：
    /organizations/{org_name}/transactions，其中 {org_name} 是機構名稱。

    注意：如果開發人員已支付設定或週期性費用，您可以略過這個步驟。呼叫 transactions 資源不會影響費率方案定義的設定或週期性費用。

    下表列出您可以在要求主體中指定的設定屬性，以便手動收取費率方案的設定或週期性費用，以及這些屬性的預設值和是否為必要屬性。

    屬性 說明 預設 必填與否
    currency

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

    		 不適用 是
    developer

    開發人員的 ID。

    		 不適用 是
    rate

    要收取的設定費或週期性費用。

    		 不適用 是
    ratePlan

    房價方案的 ID。

    		 不適用 是
    type

    設為 SETUPFEES 或 RECURRINGFEES。

    		 CHARGE 是

    如要略過驗證步驟並強制收取費用，請將 force 查詢參數設為 true (例如 ?force=true)。根據預設，系統會執行 ?force=false 和驗證步驟。舉例來說，如果預付款開發人員的餘額為零，且帳戶活動遭到停權，在驗證期間，?force=false 要求就會失敗。

    舉例來說，下列要求會向訂閱費率方案的開發人員收取 $10 美元的設定費：

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev1@myorg.com"
   },
   "currency":{
     "id":"usd"
   },
   "ratePlan":{
     "id":"mypackage_rateplan1"
   },   
   "rate":10,
   "type":"SETUPFEES"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password