使用不同的憑證類型和範圍進行測試

API Explorer 的「憑證」區段可讓您以不同的憑證和範圍進行測試。這項功能有助於確保您使用最少的必要憑證和範圍來叫用 API 端點。

使用其他憑證進行測試

根據預設,系統會同時檢查 OAuth 2 和 API 金鑰憑證類型。 如果您只想使用一個憑證進行測試,請檢查要使用的憑證類型 (並取消勾選其他憑證類型)。以下是提供憑證測試的一般規則:

  • 如果您使用方法存取公開資料 (例如 Google 地圖資料),可以使用 API 金鑰做為憑證。勾選 [API key] (API 金鑰),然後取消勾選 [Google OAuth 2.0]

  • 如果您使用方法存取私人資料 (例如使用者的 Google 雲端硬碟資料),就必須使用 OAuth 2 憑證。取消勾選 [API key] (API 金鑰),然後勾選 Google OAuth 2.0

當您收到 200 的結果時,該憑證就足以存取資料。如果收到 401 結果,您必須使用 OAuth 2 憑證來存取資料。

以不同範圍進行測試

範圍是 https://www.googleapis.com/auth/drive.metadata.readonly 等字串,用於定義應用程式所需資源的存取權層級,例如使用者資料的存取層級。在理想情況下,您希望應用程式使用的使用者資料範圍最狹窄。不同的方法可能需要不同的範圍。例如,API 中的方法可能需要至少唯讀範圍,而其他方法則可能需要讀取/寫入範圍。

根據預設,API Explorer 會啟用 API 的所有 Google OAuth 2.0 範圍。如要以特定範圍進行測試,請按照下列步驟操作:

  1. 在「憑證 Google OAuth 2.0」部分,按一下 [顯示範圍]
  2. 檢查叫用方法時要使用的範圍。
  3. 按一下 [Execute] (執行) 僅使用選定的範圍來執行 API。API Explorer 會顯示授權畫面,要求您授予範圍的使用權限。
  4. 按一下 [允許]。結果會顯示在 [執行] 按鈕的下方。

如果 APIs Explorer 在「application/json」之下顯示 200 的結果,則範圍就足以叫用該方法。如果 APIs Explorer 顯示 403 的結果,您選擇的範圍不足以叫用該方法。請擴大範圍。

如需進一步瞭解選擇範圍,請參閱特定 Google API 說明文件的「驗證和授權」一節。

撤銷授權以透過新範圍進行測試

在您使用 Google 授權畫面核准授權後,API Explorer 仍會取得驗證要求,直到憑證過期為止。取消勾選範圍並不會重設先前核准的憑證和範圍。如要使用新的範圍設定進行測試,您必須撤銷先前核准的憑證。

如何撤銷 APIs Explorer 使用的憑證:

  1. 前往具有您帳戶存取權的應用程式頁面。
  2. 在「具有帳戶存取權的第三方應用程式」下方,按一下 [Google API Explorer]
  3. 按一下 [移除存取權]
  4. (選用) 重新載入說明文件頁面,重設 API Explorer。