接口開放平台
出于下遊客戶和開發者需要調用API和進行資料自動化對接的需求,當企業需要對外開放API接口時,就需要搭建自己的接口開放平台,并向外部開發者提供OpenAPI。
産品設計腦圖
結合前面分享的文章:自建API接口管理平台的産品腦圖和解決方案,本次繼續分享在接口開放平台的産品設計腦圖及其解決方案。
API開放平台腦圖如下(點選圖檔可以檢視高清原圖):
API開放平台的設計腦圖
按産品優先級劃分,API開放平台所需要具備的功能子產品主要有:
核心領域的:登入注冊、應用管理、接口權限、接口文檔
支援領域的:服務大廳、流量統計、首頁
通用領域的:個人中心、工單管理
開放平台的使用說明
從外部開發者的角度,當開發者需要使用開放平台時,一般需要經曆以下三個階段。
第一階段,引導開發者自助注冊,開通賬号。
第二階段,引導開發者建立應用,申請接口權限。
第三階段,開發者根據API接口規範,檢視、接入和調用所需要的API接口。
可以在開放平台的首頁給予新人引導,例如:
另外,在開發文檔時,再配套提供更簡潔的接入流程說明。例如下圖:
登入注冊
對于開放平台,開發者可以選擇自行注冊和登入。
注冊時,可以選擇不同的開發者角色,以便後續進行按角色配置設定接口權限,友善管理。
建立應用
開發者成功注冊後,需要先申請和建立他的應用。開發者應用是指調用API接口的程式、系統和終端。成功建立和申請應用後,将會得到app_key和密鑰。
檢視接口文檔和調用API
在登入的情況下,進入開放平台後,開發者可以檢視自己每個應用所開通的API接口權限。
也可以在未登入的情況下,以遊客的身份檢視開放接口的線上接口文檔,提前了解開放平台具備、提供和開放了哪些API接口服務能力。
在具體的API接口文檔,開發者可以檢視每個API接口的名稱、功能描述、接口路徑、接口參數和傳回等資訊。
購買付費API
如果某些API接口需要付費開通後才能使用,開發者需要能先檢視每個接口的服務套餐,進行線上下單,和檢視成功購買後的接口服務包,以及流量消耗情況。最好能在餘額不足時及時提醒開發者。