OAuth 2.0:設定新的 API Proxy

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

如果使用 Apigee Cloud Edge 的 Apigee,您會看到根據預設,貴機構中已包含名為 oauth 的 Proxy。這個 Proxy 會提供兩個端點範例,協助您產生存取權和更新權杖。如要進一步瞭解 OAuth 權杖端點,請參閱瞭解 OAuth 端點

用戶端憑證授權類型會定義為交換應用程式憑證而核發存取權杖的程序。這些應用程式憑證是用戶端金鑰和密鑰配對,可讓 Apigee Edge 為機構中註冊的每個應用程式發生問題。詳情請參閱實作授權碼授權類型

將 OAuth 2.0 新增至新的 API Proxy

建立新的 API Proxy 時,您可以輕鬆將 OAuth 驗證新增至 API。

Edge

如何使用 Edge UI 將 OAuth 驗證新增至 API:

  1. 登入 apigee.com/edge
  2. 在左側導覽列中,依序選取「Develop」(開發) >「API Proxy」
  3. 按一下「+ Proxy」
  4. 使用「建立 Proxy」精靈建立反向 Proxy。請參閱建構簡單的 API Proxy 一文。
  5. 在精靈的「常用政策」頁面中,選取「OAuth v2.0」旁的圓形按鈕。

傳統邊緣 (Private Cloud)

如何使用傳統版 Edge UI 為 API 新增 OAuth 驗證:

  1. 登入 http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端導覽列中,依序選取「API」>「API Proxy」
  3. 按一下「+ API Proxy」
  4. 使用「建立 Proxy」精靈建立反向 Proxy。請參閱建構簡單的 API Proxy 一文。
  5. 在精靈的「安全性」頁面上,選取「OAuth v2.0」旁的圓形按鈕。

選取這個選項後,系統會將兩項政策附加至新建立的 API Proxy,一個用於驗證存取權杖,另一個政策則在經過驗證後移除存取權杖。

請注意,「Publish API Product」核取方塊可勾選,而且會自動勾選。如果您想在建構新的 API Proxy 時自動產生產品,請勾選這個選項。系統會建立自動產生的產品,並連結至新的 API Proxy。如果想將現有產品與這個新 API 建立關聯,請務必取消勾選這個核取方塊,以免建立不必要的產品。如要進一步瞭解產品,請參閱「什麼是 API 產品?」一文。

使用預設 OAuth Proxy

OAuth Proxy 公開下列端點 URI:

/oauth/client_credential/accesstoken

請將這個 URI 發布給需要取得存取權杖的開發人員。應用程式開發人員會將應用程式設為呼叫這個端點,並呈現用戶端金鑰和密鑰配對來取得存取權杖。

預設用戶端憑證權杖端點會透過網路公開於下列網址:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

舉例來說,如果機構名稱是「apimakers」,網址會是:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

這是開發人員呼叫的網址,用來取得存取權杖。

呼叫 API

取得存取權杖後,您可以使用授權標頭和不記名權杖呼叫 API,例如:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

另請參閱驗證存取權杖