API 類商品接入,即允許云市場售賣您提供的 API 類商品。本文介紹 API 類商品在云市場上架的操作步驟。
前提條件
- 入駐 API 集市。
- 將您的 API 服務部署在阿里云 API 網關,詳情請參見發布API商品。
API 類商品接入
- 登錄云市場服務商后臺。
- 在左側導航欄,選擇商品 > 商品管理。
- 單擊發布商品。
- 在接入信息頁面根據配置向導填寫接入信息。
- 填寫商品接入信息,單擊下一步。
參數 描述 選擇接入類型 單擊API服務。 商品名稱 自定義填寫商品名稱。 選擇API分組 該分組即為您在 API 網關開放 API 時的分組。單擊 API 分組所在地域,選擇目標分組。 API訪問前綴 填寫 API 地址前綴,注意該前綴全局唯一。 是否配置API生產通知 若選擇是,需要填寫 API 生產通知地址。用戶在云市場下單后,云市場會調用您開發的 SPI 接口,通知您該用戶的交易行為。 該參數與 SaaS 類商品的 SPI 接口作用相同。詳情請參見應用軟件(SaaS)類商品接入簡介、SPI 安全令牌。
- 填寫商品基礎信息,單擊下一步。
- 填寫商品業務信息,單擊下一步。
參數 描述 商品所屬類目 選擇您的商品所屬類目。 說明 您只能在入駐的集市中進行選擇。對于API類商品,建議選擇API集市,否則影響審核。(可選)自定義標簽 設置標簽方便客戶根據標簽快速查找到您的商品。 商品搜索引擎優化信息 設置與商品相關的關鍵詞和描述,有助于您的商品被搜索引擎(例如百度)收錄。 - 填寫商品銷售信息,單擊下一步。API類商品支持按次售賣和按量售賣兩種模式:
- 按次售賣: 如果您的 API 服務是根據 API 的調用次數計費的,則選擇該模式。該模式也稱為“套餐包”模式。 您需要定義套餐包的價格與配額,配額即該套餐包包括的調用次數。云市場對用戶調用您的 API 收費,是依據用戶調用您的 API 接口返回的 HTTP 狀態碼(HTTP Status Code)來統計調用次數。
- [200,300) 表示用戶調用成功,云市場會計算費用。
- [400,500) 表示客戶端錯誤,比如客戶端參數輸入不合法,云市場不會計算費用。
- [500,600) 表示服務端錯誤,比如服務端不可用,云市場不會計算費用;
所以,如果您的 API 出現某些使用情況下不收費,需要您將對應的 HTTP 狀態碼調整到對應的區間。
- 按量售賣(后付費):如果您的 API 服務不是僅僅依賴使用次數計費,而是依賴 API 被調用后需要消耗的后端資源來進行計費,則選擇按量售賣模式。
按量模式可配置響應的資源包,即客戶如果購買資源包,則會優先消耗資源包內的配額,當超出資源包配額后,再根據按量價格扣費。
按量計費需要您將用戶在 API 調用過程消耗資源的信息推送給云市場,云市場再對用戶賬號進行扣費。具體過程為:- 用戶購買 API 商品
當用戶購買 API后,云市場會自動生成 CaCloudMarketInstanceId,每個用戶都具有且只有一個 CaCloudMarketInstanceId,在用戶調用 API 時,通過系統參數傳遞給服務商。
- 用戶調用 API
您需要在 API 網關的接口中配置系統參數 CaCloudMarketInstanceId,當用戶產生 API 調用后,您可以根據這個 CaCloudMarketInstanceId 來區分不同用戶的調用消耗的資源情況,根據 ID 進行一段時間內,消耗資源情況的匯總。
您需要根據 CaCloudMarketInstanceId 匯總好資源消耗數據,并依據云市場統一的數據推送格式推送給云市場,云市場對用戶賬號進行扣費。云市場按量數據推送接口請參見 PushMeteringData。
- 用戶產生欠費
用戶調用 API 生產欠費后,云市場會立即關閉用戶調用API的權限。
- 用戶清繳欠費
用戶繳清欠費后,云市場會立即開啟用戶調用 API 的權限。
- 用戶購買 API 商品
- 按次售賣: 如果您的 API 服務是根據 API 的調用次數計費的,則選擇該模式。該模式也稱為“套餐包”模式。
- 填寫商品協議,單擊下一步。
參數 描述 最終用戶協議 該協議為您和最終客戶之間的協議,客戶下單購買前必須勾選。您可以在云市場提供的模板基礎上進行修改,也可以導入您自己的模板。 特殊商品資質 按頁面提示填寫。
- 填寫商品接入信息,單擊下一步。