遷移開發人員的營利方式

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

如果您目前有開發人員需要改用營利功能:

  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

    設為 SETUPFEESRECURRINGFEES

    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