查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
如有現有開發人員需改用營利服務:
- 為合作開發人員建立 API 產品、API 套件和費率方案 以及遷移作業 (如果尚不存在)。若需更多資訊,請參閱:
- 按照「發布費率方案」中的說明發布房價方案。
- 按照「註冊應用程式開發人員」一文的說明,在貴機構中加入新的開發人員。
- 按照「管理預付帳戶」一文的說明,為每個開發人員儲值預付餘額 餘額。
- 按照「購買費率」中的說明接受費率方案
開始使用 API
注意:如要放棄設定費用,如果開發人員已付費,請將
waivefees
查詢參數到true
。 - 如果您要遷移的開發人員已有交易,
如有需要,您可以使用下列資源手動轉移交易用量:
/organizations/{org_name}/transactions
,其中{org_name}
是 機構名稱。注意:如果開發人員沒有現有的交易,您可以略過這個步驟 採用
transactions
資源會插入單一交易,反映 ,並更新所有內部計數器以反映此新值。舉例來說,如果開發人員在遷移前已對 API 發出 1000 次呼叫, 擷取目前活動,您可以呼叫
transactions
資源,並將batchSize
屬性設為 1000 in 要求主體下表摘要列出您可以在 要求主體以手動設定交易次數、預設值和 不一定要使用這些項目
屬性 說明 預設 必填與否 application
開發人員應用程式的 ID。
不適用 是 batchSize
要轉移的交易數量。
1 否 custAttn
與 batchSize 搭配使用的自訂屬性值 交易用量
訊息中的自訂屬性號碼必須指定為正整數 或十進位 (最多四位數) 的值不允許使用負值。
您必須在以下位置定義自訂屬性:
- API 產品的交易記錄政策。如需設定範例,請參閱設定 交易記錄政策。
- API 產品的有效費率方案。詳情請參閱設定 含有自訂屬性的費率方案。
不適用 是 product
API 產品的 ID。
不適用 是 type
必須設為
CHARGE
(預設值)。CHARGE
否 如要略過驗證步驟並強制設定交易數量,請
force
查詢參數改為true
(例如?force=true
)。根據預設,?force=false
和驗證步驟為 執行狀態舉例來說,如果預付開發人員的帳戶餘額為零和活動 遭到停權,如果?force=false
要求在驗證期間失敗。舉例來說,下列要求會將指定交易次數設為 50 次 應用程式和 API 產品:
$ 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
下列要求會將指定應用程式的交易使用情況設為 12.5,以及 API 產品。要求中的
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
- 如果開發人員尚未支付必要的設定或週期性費用,您可以手動
使用下列資源收取費率方案的設定或週期性費用:
/organizations/{org_name}/transactions
,其中{org_name}
是 機構名稱。注意:如果開發人員已支付設定費用或週期性費用,您可以 可以略過這個步驟。呼叫
transactions
資源不會影響設定或 費率方案所定義的週期性費用。下表摘要列出您可以在 要求內文來手動收取費率方案的設定或週期性費用 (預設) 以及是否為必要值
屬性 說明 預設 必填與否 currency
房價方案使用的貨幣。指定貨幣的 ISO 4217 代碼,例如 美元。
不適用 是 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