API 管理如何支援獲利
適用於:所有 API 管理 層
透過 Azure API 管理服務平台,您可以:
- 發佈取用者訂閱的 API。
- 消除實作的風險。
- 加速專案時幅。
- 放心調整您的 API。
在本文件中,我們著重在 API 管理功能,這些功能可讓您實作創造營收策略,例如提供流暢的體驗:
- 探索您的公用 API。
- 輸入付款詳細資料。
- 啟用您的訂用帳戶。
- 取用 API。
- 監視使用量。
- 自動支付 API 使用量的費用。
下圖介紹這些主要 API 管理功能:
API 探索
使用 API 管理的內建開發人員入口網站啟動 API 並讓 API 取用者上線。 強調開發人員入口網站的良好品質開發內容,讓 API 取用者能夠順利探索和使用您的 API。 測試針對協助工具、完整性和可用性所提供的內容和資訊。
如需如何新增內容及控制開發人員入口網站商標的詳細資料,請參閱開發人員入口網站的概觀。
API 封裝
API 管理使用「產品」和「原則」的概念來管理 API 的封裝和呈現方式。
產品
API 會透過產品發佈。 產品可讓您定義:
- 訂閱者可以存取的 API。
- 特定的節流原則,例如將特定訂閱限制為每月呼叫配額。
當 API 取用者訂閱產品時,他們會收到 API 金鑰來用其進行呼叫。 一開始,訂閱會設定為 submitted
狀態。 啟用訂閱,以允許訂閱者使用 API。
設定 API 管理產品來封裝您的基礎 API,以反映您的營收模型,其中包含:
- 營收模型中各層之間的一對一關聯性。
- 對應的 API 管理產品。
範例專案會使用 API 管理產品作為擬定創造營收策略的最上層方法。 API 管理產品會反映營收模型層,並針對各層編製特定定價模式的索引。 此設定提供彈性的設定導向方法來準備創造營收策略。
原則
套用 API 管理原則來控制每個產品的服務品質。 範例專案使用兩個特定原則功能來控制服務品質,並符合營收模型:
原則功能 | 描述 |
---|---|
配額 | 定義使用者可在指定時段內對 API 進行的呼叫總數。 例如,「每月 100 次呼叫」。 一旦使用者達到配額,API 的呼叫會失敗,而呼叫端會收到 403 Forbidden 回應狀態碼。 |
速率限制 | 定義可對 API 進行的滑動時間範圍呼叫數目。 例如,「每分鐘 200 次呼叫」。 其設計目的是為了防止 API 使用量的尖峰超出所選產品的付費服務品質。 達到速率限制時,呼叫端會收到 429 Too Many Requests 回應狀態碼。 |
如需原則的詳細資料,請參閱 Azure API 管理中的原則文件。
API 使用量
使用 API 訂閱,透過產品將 API 取用者存取權授與 API。
- API 取用者會在註冊特定 API 管理產品時建立 API 訂閱。
- 使用 API 管理委派以整合訂閱流程與付款提供者。
- 成功提供付款詳細資料之後,使用者就能使用訂閱產生的唯一安全性金鑰來存取 API。
如需訂閱的詳細資訊,請參閱 Azure API 管理中的訂閱文件。
API 使用量監視
使用 API 管理的內建分析,取得 API 使用量和效能的見解。 這些分析會透過下列方式提供報告:
- API
- 地理位置
- API 作業
- Products
- 要求
- 訂用帳戶
- Time
- User
定期檢閱分析報告,以了解 API 取用者如何採用創造營收策略。
如需詳細資訊,請參閱取得 Azure API 管理中的 API 分析。
安全性
使用 API 管理的產品、API 原則和訂閱來控制每位使用者的存取層級。 如果使用者已向付款提供者成功驗證,則授與訂閱層級 API 存取權,以避免誤用和濫用,即使特定 API 產品是免費的也一樣。
整合
透過 API 管理與所選付款提供者之間的前端和後端整合,建立流暢的創造營收體驗。 使用 API 管理委派進行前端整合,並使用 REST API 進行後端整合。
委派
在範例專案中,您可以使用 API 管理委派與協力廠商付款提供者進行自訂整合。 示範會針對註冊/登入和產品訂閱體驗使用委派。
註冊/登入工作流程
- 在 API 管理開發人員入口網站上,開發人員可以按一下[登入]或[註冊]的連結。
- 瀏覽器會重新導向至委派端點 (已設定為自訂帳單入口網站應用程式中的頁面)。
- 自訂帳單入口網站應用程式會顯示登入/註冊 UI。
- 成功登入/註冊時,系統會驗證使用者,並重新導向回 API 管理開發人員入口網站起始頁面。
產品訂閱工作流程
- 在 API 管理開發人員入口網站中,開發人員選取產品,然後按一下 [訂閱] 按鈕
- 瀏覽器會重新導向至委派端點 (已設定為自訂帳單入口網站應用程式中的頁面)。
- 自訂帳單入口網站應用程式:
- 根據付款提供者 (Stripe 或 Adyen) 來呈現設定的 UI。
- 引導使用者完成相關的結帳流程。
- 系統會將使用者重新導向回 API 管理產品起始頁面。
- 產品會處於作用中狀態,而且 API 金鑰可供使用。
REST API
使用 API 管理的 REST API,將創造營收策略的作業自動化。
範例專案會使用 API 來針對以下進行程式設計:
- 擷取 API 管理產品和原則,以便在付款提供者中啟用類似概念的同步設定,例如 Stripe。
- 定期輪詢 API 管理,以擷取每個訂閱的 API 使用量計量並驅動帳單流程。
如需詳細資訊,請參閱 Azure API 管理的 REST API 概觀。
DevOps
使用 Azure Resource Manager 對 API 管理進行版本控制和自動化部署變更,包括設定實作創造營收策略的功能,例如:
- 產品
- 原則
- 開發人員入口網站
在範例專案中,Azure Resource Manager 指令碼會透過 JSON 檔案來增強,以定義每個 API 管理產品的定價模型。 透過此增強,您可以同步處理 API 管理與所選付款提供者之間的設定。 整個解決方案是在單一原始檔控制存放庫下管理,以:
- 透過單一發行版本的方式協調與持續創造營收策略演進建立關聯的全部變更。
- 遵循治理和稽核需求來執行變更。
初始化和部署
API 管理可透過下列任一方式部署:
- Azure 入口網站 UI,或
- 使用 Azure Resource Manager 範本的「基礎結構即程式碼」方法。
影片
整合 API 管理與 Adyen 付款閘道
整合 API 管理與 Stripe 付款閘道
下一步
- 深入了解 API 管理創造營收策略。
- 透過相關聯的 Git 存放庫部署示範 Adyen 或 Stripe 整合。