Azure API Management（2）建立 Product/User/Subscription/體驗Developer Portal

本文介紹以下內容：

1. 管理員（也就是API的提供者）從Azure Portal 導入後端API

2. 管理員在Azure Portal 對導入的API進行設置，好比增長流控等功能

3. 管理員在Azure Portal建立一個包含一組或多組API的產品併發布

4. 管理員在Azure Portal發佈開發人員門戶（一般該步驟僅執行一次）

5. 用戶從開發人員門戶自主註冊或者從管理員從Azure Portal上註冊用戶

6. 管理員從Azure門戶上爲用戶建立訂閱

7. 用戶在開發人員門戶學習如何調用API並作測試

8. 用戶在本身的業務系統中調用API

 

 

視頻介紹：

https://www.51azure.cloud/post/2020/8/7/azure-api-management-2-create-product-user-subscription-and-try-developer-portal

 

 

 

---

圖文介紹：

 

幾個重要的概念：

 

1. API

導入或者在Azure Portal上建立的 一組API或者多組API，例如導入了一組訂單相關API和一組庫存相關API；

 

2.產品

產品包含至少一組API，一般產品把多組API打包在一塊兒，造成一個包含多種功能的一個集合，例如：定義了一個產品「進銷存」，該產品包含一組 訂單相關的API和一組庫存相關的API；

 

3.用戶

這裏的用戶一般指使用API Management 的人員，其中包含要調用你發佈的API的開發人員。

 

4.組

組指的用戶組，一個組能夠包含多個成員，也就是包含多個「用戶」，系統內置了「Administrator」，「Developer」，「Guests」三個組。

5.訂閱

訂閱決定了哪一個」用戶「能夠調用哪一個「API」或者哪一個「產品」。

訂閱是綁定到「用戶」上的，訂閱能控制某個API或某個產品。

6.開發人員門戶（developer portal）

一般狀況下，開發人員門戶是提供給「用戶」，也就是要調用你API的人員使用的一個門戶網站。

用戶能夠在這個網站維護本身的帳號信息，查看本身的訂閱信息，查看API文檔/在線測試API。

默認狀況下，他的url後半部分爲：developer.azure-api.net;

能夠在開發人員門戶上提交註冊信息，根據配置，可能須要審覈或自動完成審覈，而後便成了「用戶」，用戶能夠根據API及產品是否須要訂閱或者訂閱權限調用對應的API。

在開發人員門戶上自主註冊的用戶，默認自動分配到「Developer」組中。

 

 

---

 

一般總體的使用流程是：

 

1. 管理員（也就是API的提供者）從Azure Portal 導入後端API

2. 管理員在Azure Portal 對導入的API進行設置，好比增長流控等功能

3. 管理員在Azure Portal建立一個包含一組或多組API的產品併發布

4. 管理員在Azure Portal發佈開發人員門戶（一般該步驟僅執行一次）

5. 用戶從開發人員門戶自主註冊或者從管理員從Azure Portal上註冊用戶

6. 管理員從Azure門戶上爲用戶建立訂閱

7. 用戶在開發人員門戶學習如何調用API並作測試

8. 用戶在本身的業務系統中調用API

 

---

 

1.管理員（也就是API的提供者）從Azure Portal 導入後端API

上一講分享的內容中，咱們已經完成了API的導入，本文再也不贅述，若是您還沒有完成API導入，請參照《Azure API Management（1）Create APIM And Add First API,建立Azure APIM並添加後端API》

 

---

 

2.管理員在Azure Portal 對導入的API進行設置，好比增長流控等功能

流控等功能咱們在之後的章節中介紹，本文能夠跳過這個步驟。

 

---

 

3.管理員在Azure Portal建立一個包含一組或多組API的產品併發布

注意：

3處的狀態爲「未發佈」，未發佈的產品不會在開發者門戶中看到。稍後須要執行」發佈產品「操做後，纔會出如今開發者門戶中；

3處的「須要訂閱」若是不勾選，則用戶在開發者門戶中無需訂閱便可進行該產品關聯api的調用；

5處的API能夠選擇多個或者一個；

 

產品建立完成後，默認的訪問控制組在「Administrator」中，若是須要被「開發者麼戶」中建立的用戶訪問，則須要添加「developers」組，由於從門戶自主註冊的用戶，默認爲「developers」組：

 

發佈產品，只有發佈後的產品，纔會顯示在開發人員門戶中：

 

 

---

 

4.管理員在Azure Portal發佈開發人員門戶（一般該步驟僅執行一次）

注意：若是不開啓cors，則用戶在開發人員門戶上沒法測試api調用。

 

---

 

5.用戶從開發人員門戶自主註冊或者從管理員從Azure Portal上註冊用戶

點擊開發人員門戶能夠進入開發人員門戶，此時是管理員默認登陸對門戶的編輯模式，須要切換瀏覽器，才能以新的用戶session訪問開發人員門戶：

 

點擊右上角註冊：

默認註冊使用郵箱和密碼方式：

在郵箱中查收驗證郵件並驗證郵箱：

 

登陸開發人員門戶：

登陸成功，看到以下頁面：

 

查看profile：

注意，此時新用戶並無任何subscription，稍後咱們將在Azure Portal 爲用戶添加訂閱。

 

---

 

6.管理員從Azure門戶上爲用戶建立訂閱

在Azure Poral中查看剛註冊成功的用戶：

用戶即開發人員，也就是要使用你api的人員；

從developer portal自主建立的用戶，默認在 「developer」組中。

 

 

爲用戶建立分配訂閱：

在用戶頁面點擊訂閱，添加訂閱：

 

 

新建訂閱能夠產品級別或者API級別的訂閱，本例選擇產品級別的訂閱，並選擇剛纔發佈的產品。

 

在下拉列表中選擇剛纔發佈的產品，而後建立訂閱。

用戶能夠在開發人員門戶中查看管理員爲你分配的訂閱：

在developer portal 中查看分配的訂閱：

 

---

 

 

7.用戶在開發人員門戶學習如何調用API並作測試

在開發人員portal中進行api測試：

 

subscription key 在建立時是有做用範圍的，本例中，咱們將subscription key 的權限綁定到 「new-product」上，所以，該key在其餘product或者其爲包含在「new-product」裏的api，都是無效的：

以下圖，咱們用subscription key對 echo api進行訪問，結果爲 401：

 

 

---

 

8. 用戶在本身的業務系統中調用API

針對多語言的示例代碼，將代碼集成到本身的業務系統中，完成API調用開發。

 

---

聲明：

 

點擊可查閱本站文章目錄 《文章分類目錄》

本站全部內容僅表明我的觀點，如與官文檔衝突，請以官方文檔爲準。

可在本頁面下方留言或經過下方聯繫方式聯繫我：

微信：wxyusz；郵箱：shuzhen.yu@foxmail.com

歡迎關注公衆號「雲計算實戰」，接收最新文章推送。