遷移開發人員的營利方式

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

如要將現有開發人員遷移至營利服務:

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

    注意:如要免除設定費用 (如果開發人員已遭收費),請將 waivefees 查詢參數設為 true

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

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

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

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

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

    屬性 說明 預設 是否必要?
    application

    開發人員應用程式的 ID。

    N/A
    batchSize

    要轉移的交易筆數。

    1
    custAttn

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

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

    自訂屬性必須定義在:

    N/A
    product

    API 產品的 ID。

    N/A
    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 代表瑞士法郎。

    N/A
    developer

    開發人員 ID。

    N/A
    rate

    設定或週期性費用。

    N/A
    ratePlan

    房價方案的 ID。

    N/A
    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