天天看點

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

api服務類商品就是服務商(賣家)在市場售賣的商品是以api形式調用的服務,如:氣象資訊api、圖像識别api、語言翻譯api等。買家一般是開發者,買家可以調用賣家的api,作為原材料,産出最終的軟體或服務。

在做具體接入工作之前,我們先了解一下接入的邏輯和流程。

首先是整體的概念邏輯。1個api服務商品,對應1個api網關的分組,1個api網關的分組背後是0到多個api(如果是0個,那賣的就是空服務了)。相當于賣家可以把一組api服務打包,作為一個api服務商品進行售賣。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

部分賣家會擔心每個api性能優先,如果進行售賣後,被調用頻率過高,性能無法保證。是以api網關提供了流控政策,能夠幫助賣家進行限流,避免背景api被拖垮。

api服務商品接入涉及到兩個系統,分别是api網關和雲市場:

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

api網關是使用雲市場api類服務前必須開通的系統,當api網關中建立完分組後,即可同步在雲市場裡對api服務進行上架編輯操作。

自有api接入api網關前,請确認:

确認分組的規劃:1個商品對應1個分組,是以要上架多少個商品就要建立多少個分組;

申請獨立域名;1個分組對應1個域名,是以要建立多少個分組,就要申請多少個域名,但是域名申請需要綁定cname,需要等分組建立完後再申請;

可被通路到的api服務,及服務的api說明文檔;

流控政策(可選)。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

點選“建立分組”,進入分組建立對話框,填寫合适的“分組名稱”和“描述”;

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

分組建立完成之後,點選分組名稱,進入分組詳情頁面,可以看到二級域名中有一個長長的一串域名,拿着這個長長的二級域名就可以去申請域名了(不一定要一級域名,二級、三級等域名都可以,但是這個域名是專用的)。在申請域名中,注意使用cname類型的解析,并且解析到那個長長的二級域名。一旦域名申請下來,就可以“綁定域名”,綁定域名時會自動檢查cname設定是否正确(也就是配好域名的解析規則前是無法綁定的),視情況,可以添加ssl證書(注意公鑰、私鑰不要弄反)。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

分組建立完畢後,也可以先建立api并綁定。建立api在“api清單”菜單裡,選擇合适的region并“建立api”。注意,api的region和分組的region需要一緻。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

在填寫api資訊時,若安全認證填“無認證”,則任何人都可以無需事先購買和授權就進行調用。後端服務位址是真實的提供服務的位址。在填寫這些資訊時,相信後端的服務已經準備就緒,就是目前能調通的那個位址,最終使用者不會感覺到這個位址。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

服務的path是最終使用者能感覺到的位址,和真實的服務位址可以不一緻。在“請求body”一欄中經常容易把請求body中的字元串、json當成form表單去填,如果是字元串、json、二進制資料等,請選擇“使用二進制資料”。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

常量參數、系統參數,對最終調用者不可見,對服務提供者可以見。用常量參數、系統參數,服務提供者能夠對api進行一些統計、鑒權等,更多用途可以慢慢挖掘。需要注意的是,在http協定中,header是不區分大小寫的,query中是有大小寫區分的,這裡需要服務提供方的程式員注意。tips:在服務測試階段,可以把所有系統參數都設上,然後看服務端列印的那些系統參數,進而選擇在生産中是否要設定系統參數、設定哪些系統參數。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

最後填寫完“結果基礎定義”,整個api定義到此結束。

api建立完畢後,需要進行測試和釋出。測試釋出後,即可對api進行測試。測試與是否綁定域名無必然聯系,如果未綁定域名,可以用二級域名進行測試,如果綁定了域名,則可以用域名進行測試。通路測試環境的api,需要在header中加入名為“<code>x-ca-stage</code>”的鍵,且值為“<code>test</code>”。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟
資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

如果測試沒有問題,即可生産釋出(生産釋出前視情況配置流控政策)。

api服務商品上架前,請确認:

确認已有資料服務商品的規劃(當然,如果還沒有的話,api接入api網關一步都無法正确進行);

每個商品需要有對應的商品圖檔(160×120像素)、商品介紹、定價、最終使用者協定(雲市場可以給出一份範例,錄入商品時可以看到),如果還沒有,在填寫前準備好就行。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

選擇“接入類型”,因為本篇文檔闡述的是api服務的接入,是以這裡就選擇“api服務”。釋出商品時分組看不到的話,請确認選擇了正确的region。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

上傳商品圖檔、商品介紹、商品詳情。複雜的商品詳情格式,請使用圖檔。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

填寫商品所屬類目等資訊。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

填寫商品銷售資訊。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

填寫商品協定等資訊。在這之前,每點選“下一步”都是儲存,可随時退出,這一頁點選“送出”,在稽核前無法修改,請謹慎點選送出按鈕。

資料市場API産品接入-上架指南什麼是API服務類商品接入步驟

确認無誤後,點選送出,等待稽核通過,即上架成功。

繼續閱讀