天天看點

自建API接口管理平台的産品腦圖和解決方案

API接口管理平台

如果需要自建API接口管理平台,首先要定位和明确需要給誰(開發者是誰)、以什麼方式(免費/付費)、提供什麼接口(内部接口,資料接口還是上遊供應商的API接口)。

站在産品經理的角度,規劃一個API接口管理平台,需要有業務、技術、市場的功底,才能打造一個閉環的接口服務方案。

按需求優先級,API接口管理平台的功能可以分為四大類:核心類功能、輔助類功能、支撐類功能、基礎類功能。

核心類功能:接口管理、接口計費。

輔助類功能:開發者管理、應用管理。

支撐類功能:工單管理、計劃任務、上傳檔案管理、配置管理。

基礎類功能:資料庫管理、統計報表、背景權限控制、登入、首頁。

産品腦圖

為了友善大家整體規劃和了解API接口管理平台需要哪些功能,可以參考以下API接口管理平台的腦圖(點選圖檔可以檢視高清原圖)。

自建API接口管理平台的産品腦圖和解決方案

下面以部分的功能子產品,介紹實作的效果和作用。

背景登入

管理背景的基本登入。

自建API接口管理平台的産品腦圖和解決方案

接口管理

首先,需要用到的是接口開發。有了API接口,才能進行調用、開放和使用。

在接口開發清單,可以管理和檢視API接口,并對其進行管理、釋出、編輯和開發、調試。

自建API接口管理平台的産品腦圖和解決方案

在單個API接口開發時,你可以對接口名稱、接口描述、接口路徑、接口标題、接口請求方式(GET/POST)、接口版本号、接口源代碼、接口參數、接口傳回字段、接口示例、接口錯誤碼等進行維護和線上編輯。

自建API接口管理平台的産品腦圖和解決方案

編輯接口後,還可以進行線上接口測試、線上接口調試、釋出接口、管理接口權限、檢視接口線上文檔等一序列操作。

自建API接口管理平台的産品腦圖和解決方案

API接口釋出後的線上接口文檔。可以分多個項目、分空間、分目錄子產品進行接口分類管理。

自建API接口管理平台的産品腦圖和解決方案

以及自動生成的線上API接口文檔,支援實時生成、離線導出、線上接口測試、國際化翻譯等。

自建API接口管理平台的産品腦圖和解決方案

有了API接口後,可以對接口進行權限配置設定。例如,配置設定開放給指定的開發者角色,或指定的開發者賬号,或指定應用。

自建API接口管理平台的産品腦圖和解決方案

如果需要限制客戶的調用,還可以設定IP白名單、每天接口次數限制、應用稽核、有效日期、接口簽名、接口參數加密等。

自建API接口管理平台的産品腦圖和解決方案

接口計費

對于開放的API接口,除了可以配置設定接口權限,限制調用次數和IP白名單等外,如果需要進行接口流量計費,就城用到套餐、訂單、已購買服務、工單服務等配套的功能支援。

首先,在管理背景,可以添加套餐,并對套餐進行管理,設定價格等。

自建API接口管理平台的産品腦圖和解決方案

在添加接口服務套餐時,可以分為:免費試用、付費套餐群組合套餐。

自建API接口管理平台的産品腦圖和解決方案

支付方式,可以配置現金支付(人工充值)、支付寶線上支付、Paypay(國際付款)。

自建API接口管理平台的産品腦圖和解決方案

當開發者下單購買後,即可以檢視到對應的訂單,并對訂單進行統計和管理,以及檢視已經發放的接口服務包和消耗情況。當接口流量快消耗完時或快到期時,可以提醒開發者及時續約和續費。

自建API接口管理平台的産品腦圖和解決方案

開發者管理

開發者管理是對開發者的賬号密碼進行管理,并對開發者的身份進行核實和認證。

自建API接口管理平台的産品腦圖和解決方案

應用管理

由于最終調用API接口的是程式、是系統、是用戶端,而不是人、不是開發者,是以我們需要進行應用管理。對于建立的應用,需要在稽核通過後才可以調用API接口,避免API非法調用和通路。

建立應用時,有幾個關鍵的資訊:應用名稱、app_key和密鑰,是最基本的應用資訊。此外還可以有一些權限設定。

自建API接口管理平台的産品腦圖和解決方案

統計報表

首頁統計,包括了常用的資料彙總和報表。關心的核心資料名額是:待稽核應用數量(拉新)、接口實時流量統計(API調用量)、訂單數量(平台盈利能力)、API總數(接口品類和服務能力)。

自建API接口管理平台的産品腦圖和解決方案

API接口的實時統計流量,

自建API接口管理平台的産品腦圖和解決方案

每日接口統計,可以分析熱門接口和每天的調用分布。

自建API接口管理平台的産品腦圖和解決方案

應用曆史統計,檢視用戶端使用的情況,分析找出重點需要服務的客戶對象,以及客戶價值。

自建API接口管理平台的産品腦圖和解決方案

背景權限控制

如果需要多人同時管理API接口平台,可以對不同的管理者角色配置設定需要的背景菜單權限。

自建API接口管理平台的産品腦圖和解決方案

本篇文章,結合接口大師的經驗,僅介紹了API接口管理平台的産品解決方案。為了自建API平台,還需要開放平台和其他子系統,後續繼續分享,歡迎關注我。

繼續閱讀