1 概述
閱讀對象:
云市場合作伙伴,希望將自己的API上架到云市場上進行售賣。
在完成服務商入駐API集市后,API商品上架過程分成兩個步驟:
步驟一:在API網關上進行API的配置,并發布在API網關上;
步驟二:在云市場服務商控制臺上進行API商品的配置,包括商品介紹、售賣信息等。
本文目標:
幫助合作伙伴快速了解API商品的構成,以案例的方式了解步驟一的主要操作過程,特別是和API商品緊密相關的內容;
本文案例中不涉及更多的API配置方式,具體可詳見API網關的其他相關文檔。
2 API商品的構成
客戶在云市場上瀏覽API商品的時候,會看到API商品主要有三部分構成,如下例所示:
a. 商品簡介和售賣信息
b. API接口的信息
c. 商品的更多信息,包括產品亮點、產品說明、產品價格、評論、使用指南等。
上面的三部分,其中(a)和(c)是需要云市場的服務商控制臺中進行配置,(b)里面是需要在API網關上進行配置。 一個API商品里面可以包含多個API,在上圖的示例中,該API商品只有一個API。
3 API網關上配置并發布API
3.1 概述
注意:需要使用入駐成功后的服務商賬號在API網關上進行配置,否則在云市場服務商控制臺上將無法獲取到配置好的API信息。
以下圖的API商品為例,介紹如何在API網關上進行配置。
3.2 創建API分組
首先需要在API網關中創建分組,API網關的一個API分組對應的是云市場上的一個API商品。如下圖所示,在華東1創建了一個API分組。
注意事項:
如何選擇Region。建議根據API后端服務所在地理位置就近選擇。如果API的后端是函數計算或者是在阿里云的VPC內,則需要在同一個Region內。您在云市場服務商控制臺上創建API商品時,也需要先選擇對應的Region,然后才能選擇到API分組,如下圖所示。
API分組的實例類型建議選擇"共享實例/Serverless實例(VPC)";
API分組的名稱、描述信息等,都可以根據您的需要隨意設置,不會影響到最終用戶看到的API商品信息。
3.3 配置API
對應這個API商品,需要在這個分組下創建兩個API,如下圖所示:
下面章節以"測試商品的API_1"為例,具體展開如何進行配置。
3.3.1 API基本信息
配置API基本信息,如下圖所示:
注意事項:
API名稱,設置后將會顯示在API商品頁中,如下圖所示。商品上架后,API名稱也可以修改;
安全認證,需要選擇"阿里云APP";
AppCode認證,需要選擇"上架云市場后開啟";在商品頁中,最終用戶可以使用兩種方式(API簡單身份認證調用方法APPCode、API簽名認證調用方法APPKey&APPSecret )進行調用。關于阿里云APP的這兩種認證方式的區別可詳見阿里云APP 使用簡單認證(AppCode)方式調用API;
注意一定要選擇"API選項"中的"允許上架云市場",否則此API在商品頁中將無法看到。
3.3.2 定義API請求
定義API請求,如下圖所示:
注意事項:
協議請選擇"HTTPS";
二級域名為API網關自動分配,無需進行調整;
請求Path、HTTP Method、入參請求模式,您可根據API及后端服務的情況來進行設置,本例中HTTP Method選擇的POST,其他的使用默認值;
入參定義,本例中配置了三種不同位置的參數,同時配置了默認值、示例和描述,商品發布后,入參信息會在商品頁中的如下位置出現:
3.3.3 定義API后端服務
這部分用于配置API網關如何訪問后端服務,相關信息都不會出現在API商品信息中,更多配置請詳見API網關幫助文檔。
3.3.4 定義返回結果
定義返回結果,如下圖所示。建議您填寫"返回結果示例"、"失敗返回結果示例"、"錯誤碼定義",可以幫助最終使用者在API商品頁中更好的了解如何使用接口,同時也能大大減少您的支持工作量。
完成此部分的配置后,會在商品頁中如下位置出現。
3.3.5 添加示例代碼
在API商品上,除了上述過程中對接口的輸入和輸出的各種描述之外,還強烈建議您完善示例代碼,既能提高用戶體驗,也能有效降低您的支持工作量。API網關會先根據您的API配置信息自動生成一份默認的示例代碼,如下圖所示:
配置完成后,在API商品頁中如下位置顯示:
注意事項:
示例代碼僅適用于采用APPCode的認證方式調用;
由于是自動生成,因此會存在一定的局限性。如一些場景(如OCR類商品),輸入參數中需要傳入base64之后的圖片文件內容,示例代碼當前無法自動生成對應的代碼片段,建議您可以根據商品特點在自定義示例代碼中直接進行編輯,以補充對應的代碼;
如果您對示例代碼進行過編輯,后續即使API參數發生變化,API網關也不會覆蓋您的示例代碼,請注意及時更新。
3.4 發布和調試API
API配置完成后,需要發布到環境中才可進行調試、調用,在本例中直接發布到了"線上"環境中,更多關于API網關的環境管理的內容可以詳見 環境管理。
發布完成后,由于API的認證方式是"阿里云APP",因此需要在應用管理
菜單中創建一個調試用的APP,如下圖:
需要在API的授權信息
菜單中,為此API添加授權,授權成功后如下圖所示:
最后可以在API調試
菜單中進行參數的調試確認,如下圖所示:
注意事項:
除了在調試API的頁面中進行調試之外,為了保證最終發布的API的準確性,還請您通過代碼調用API進行測試。如何使用"阿里云APP"認證方式進行調用,您可以使用SDK的方式或自行實現阿里云APP加簽算法,詳見使用摘要簽名認證方式調用API;
您可以使用這個分組自動創建的公網二級域名進行調用測試,同時也需要了解到直接使用公網二級域名進行調用時有比較大的局限性,具體可以詳見分組詳情的頁面。
3.5 API商品的域名
在使用API網關進行API全生命周期管理的場景中,您需要在分組上綁定您的正式域名后,業務系統、客戶端程序才能正式調用這些發布的API。但針對這些準備上架到云市場的API分組,則不必您綁定域名,在云市場服務商控制臺中,發布商品的時候,只需要您配置三級域名即可,如下圖。最終用戶在云市場購買成功后,就可以通過此域名訪問到您的API商品。
注意事項:
在云市場服務商控制臺上發布API商品時,需要您填寫的前綴要保證全局唯一;
商品發布后,此域名將會自動綁定到API網關的這個分組上,如下圖所示,請您務必不要刪除此域名,或綁定其他域名,否則都可能會造成您發布的API商品無法訪問,給最終用戶帶來使用困擾。
4. 發布API商品
詳見API 類商品接入說明。