OAuth 2.0：設定新的 API Proxy

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

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

將 OAuth 2.0 新增至新的 API Proxy

在 Apigee UI 中建立新的 API Proxy 時，您可以為 API 新增 OAuth 驗證。

如要為 API 新增 OAuth 驗證，請按照下列步驟操作：

Cloud 控制台中的 Apigee

  1. 在 Google Cloud 控制台中，前往「Proxy development」>「API proxies」頁面。

    前往 API Proxy

  2. 在 Google Cloud 窗格中，從專案挑選器選取機構。機構名稱與 Google Cloud 專案名稱相同。
  3. 在「API Proxies」窗格中，按一下「+ Create」。
  4. 在「建立 Proxy」窗格的「Proxy 範本」下方，選取「反向 Proxy (最常見)」。
  5. 使用下列項目設定 Proxy：
    名稱 值
    Proxy 名稱 helloworld_oauth2
    基本路徑

    /hellooauth2

    專案基本路徑是網址的一部分，用於向 API 代理發出要求。
    說明 hello world protected by OAuth v2.0
    目標 (現有 API)

    https://mocktarget.apigee.net/ip

    這會定義 Apigee 在對 API Proxy 發出要求時叫用的目標網址。這個目標只會傳回簡單的回應：Hello, Guest!。
  6. 點選「下一步」。
  7. 部署 (選用)：
    • 部署環境：選用。使用核取方塊選取要部署 Proxy 的一或多個環境。如果不想在這個時間點部署 Proxy，請將「部署環境」欄位留空。您之後隨時可以部署 Proxy。
    • 服務帳戶：選用。將服務帳戶附加至部署作業，讓 Proxy 能夠存取 Google Cloud服務，如服務帳戶的角色和權限中所指定。
  8. 點選「建立」。
  9. 在「helloworld_apikey」 Proxy 的「Proxy summary」窗格中，按一下「Develop」分頁標籤。
  10. 在「政策」選單中，按一下「新增政策」。
  11. 在「建立政策」窗格中，選取「安全性」下方的「驗證 API 金鑰」。
  12. 在「Verify API Key」(驗證 API 金鑰) 窗格中，使用下列值填寫「Name」(名稱) 和「Display name」(顯示名稱) 區段中的必填欄位：
    • 名稱：輸入政策名稱。例如：VerifyAPIKey。
    • 顯示名稱：輸入要在使用者介面中使用的政策名稱。例如：Verify API Key。
  13. 點選「建立」。
  14. 按一下 即可新增其他政策。
  15. 在「建立政策」窗格的「中介服務」下方，選取「指派訊息」。
  16. 在「Assign Message」窗格中，使用下列值填妥「Name」和「Display name」區段中的必填欄位：
    • 名稱：輸入政策名稱。例如：AssignMessage。
    • 顯示名稱：輸入要在使用者介面中使用的政策名稱。例如：Assign Message。
  17. 點選「建立」。

  18. 將「Assign Message」政策的內容更新為下列項目：

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. 新增 VerifyApiKey 和 Remove Header Authorization 政策。
    1. 在「Proxy endpoints」(Proxy 端點) 選單中，按一下「Preflow」(前置流程)。
    2. 在視覺化編輯器的「要求」窗格中，按一下 「新增政策步驟」。
    3. 在「新增政策步驟」窗格中，選取「驗證 API 金鑰」。
    4. 按一下「新增」。
    5. 在視覺化編輯器的「要求」窗格中，按一下 「新增政策步驟」。
    6. 在「新增政策」步驟窗格中，選取「移除標頭授權」。
    7. 按一下「新增」。
  20. 按一下 [儲存]。

傳統版 UI

  1. 登入 Apigee 使用者介面。
  2. 在左側導覽列中選取「開發」>「API Proxy」。
  3. 按一下「+ Proxy」。
  4. 使用「建立 Proxy」精靈建立反向 Proxy。請參閱建構簡單的 API Proxy。
  5. 在精靈的「Common policies」(一般政策) 頁面，選取「OAuth v2.0」旁的圓形按鈕。
1 新建立的 API 代理，一個用於驗證存取權杖，另一個則是在驗證後移除存取權杖。

請注意，系統會自動選取「發布 API 產品」核取方塊，且該核取方塊會變成可選取狀態。如要在建構新的 API Proxy 時自動產生產品，請勾選這個選項。系統會自動產生產品，並與新的 API Proxy 建立關聯。如果您有想與這個新 API 建立關聯的現有產品，請務必取消勾選這個核取方塊，以免建立不必要的產品。如要瞭解產品，請參閱「什麼是 API 產品？」一文。