當前位置:
首頁 > 最新 > API是怎麼開放的?

API是怎麼開放的?

作為一個有態度的數據平台,【賽合一數據】從來都只做最適合企業的API介面。上次我們談到了API是怎麼創建的,現在跟著【賽合一數據】繼續來看API是怎麼開放的。

其實API 創建完成之後,你就可以開放API服務了。不過要開放API服務需要綁定一個在開發系統中備案成功的獨立域名(比如說,你要開放的API用的是【賽合一數據】的開發系統,那麼你就要綁定一個在【賽合一數據】開發系統中已經備案成功的獨立域名),而且該域名要完成 CNAME 解析。另外,這個獨立域名是綁定在API分組上面的,所以我們有必要了解一下開放API服務需要掌握的API分組和域名。

Part one API分組

API 分組是API的管理單元。你創建API之前,需要先創建分組,然後在某個分組下創建 API。分組包含名稱、描述、區域(Region)、域名幾大屬性。

l 分組的區域(Region)在分組創建時選定不可更改。創建API時,如果選定分組那麼 Region 也一同選定,不可更改。

l 每個賬號API分組個數上限為50個,每個分組API個數上限為200個。

l 域名。分組創建時,系統會為分組分配一個二級域名。如果需要開放API服務,你需要為分組綁定一個在開發系統備案成功的獨立域名,且將獨立域名 CNAME 到相應的二級域名上。

Part two 環境管理

關於環境需要理解兩個概念,環境和環境變數。

環境是API分組上的一個配置,每個分組有若干個環境。API錄入後,未經發布時,就只是API定義。發布到某個環境後才是能夠對外提供服務的API。

環境變數是在環境上用戶可創建可管理的一種變數,該配置是固定於環境上的。如在線上環境創建變數,變數名為 Path,變數值為 /stage/release。在API定義中的 Path 位置,寫作 #Path#,即配置為變數標識,變數名為 Path。那麼將該API發布到線上環境時,該API在線上環境的運行定義,Path 處的 #Path#,會取值為 /stage/release。而將該API發布到其他環境時,若環境上沒有環境變數 #Path#,則無法取值,那麼API就無法調用。

使用環境變數可以解決後端服務需要區分環境的問題,通過不同的環境上配置不同的服務地址和Path,來調用不同的後端服務,同時API的定義配置又是一套。使用時需要注意以下幾點:

1.在API定義中配置了變數標識後,在API列表管理調試頁面將無法調試。

2.變數名嚴格區分大小寫。

3.如果在API定義中設置了變數,那麼一定要在要發布的環境上配置變數名變數值,否則變數無賦值,API將無法正常調用。

Part three 域名及證書

API 網關通過域名來定位到一個唯一的API分組,再通過 Path+HTTPMethod 確定唯一的API。如果要開放API服務,你需要了解二級域名獨立域名

二級域名是分組創建時系統分配的,唯一且不可更改。在你還沒有獨立域名之前,你可以通過訪問二級域名來測試調用你的API。

獨立域名即自定義域名,是你開放API服務需要綁定的,用戶通過訪問你的獨立域名來調用你開放的API服務。不過,對於獨立域名的配置你需要注意以下幾點:

1.獨立域名不必須是根域名,可以是二級、三級域名。

2.獨立域名如果尚未備案,則可以在開發系統做首次備案

3.獨立域名若已在其他系統備案,則需要在開發系統做備案接入

4.獨立域名需要 CNAME 解析到分組的二級域名上。

滿足上述的備案和解析兩個要求,域名才能成功綁定。

Part four 測試、線上、授權

完成以上全部操作之後,接下來就可以將API發布到測試或者線上環境,進行調試和開放了。其中一個重要的環節是授權,授權即授予某個應用可以調用某個API的許可權。

當你完成API創建之後,你就可以將API發布到測試或線上,並給自己創建的應用授權,通過訪問二級域名來調用指定環境中的 API,進行測試。成功綁定獨立域名之後,你的API就可以在市場上架,供客戶購買、調用。你還可以不經過購買將API授權給合作夥伴的應用,供其調用。

至此,你就完成了API服務的開放。在API創建到開放的整個過程中,你還可以隨時操作API的創建、修改、刪除、查看、測試、發布、下線、授權、解除授權、發布歷史及版本切換等操作。


喜歡這篇文章嗎?立刻分享出去讓更多人知道吧!

本站內容充實豐富,博大精深,小編精選每日熱門資訊,隨時更新,點擊「搶先收到最新資訊」瀏覽吧!


請您繼續閱讀更多來自 賽合一數據 的精彩文章:

產品經理必須了解的15個API相關名詞
API是怎麼調用的?——賽合一API知識講堂

TAG:賽合一數據 |