OAuth 2.0:設定新的 API Proxy

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

如果您使用的是 Apigee Cloud 版 Edge,系統預設會在您的機構中加入名為 oauth 的 Proxy。這個 Proxy 提供兩個範例端點,可產生存取和更新權杖。如要進一步瞭解 OAuth 權杖端點,請參閱「瞭解 OAuth 端點」。

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

將 OAuth 2.0 新增至新的 API Proxy

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

邊緣

如要使用 Edge UI 將 OAuth 驗證新增至 API,請按照下列步驟操作:

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

Classic Edge (Private Cloud)

如要使用 Classic Edge UI 將 OAuth 驗證新增至 API,請按照下列步驟操作:

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

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

請注意,「發布 API 產品」核取方塊會變成可選取狀態,並自動選取。如要在建構新的 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

另請參閱「驗證存取權杖」。