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

您可以在 API 探索工具的憑證部分,使用不同的憑證和範圍進行測試。這項功能可確保您使用最少的必要憑證和範圍來叫用 API 端點。

使用其他憑證進行測試

根據預設,系統會勾選 OAuth 2 和 API 金鑰憑證類型。 如要只使用一項憑證進行測試,請勾選要使用的憑證類型 (並取消勾選其他憑證類型)。以下是選擇憑證進行測試的一般規則:

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

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

如果收到 200 的結果,表示憑證足以存取資料。如果收到 401 結果,您需要使用 OAuth 2 憑證存取資料。

測試不同範圍

範圍是字串,例如 https://www.googleapis.com/auth/drive.metadata.readonly,可定義應用程式所需的資源存取層級,例如使用者擁有的資料存取層級。理想情況下,您希望應用程式使用範圍,以最嚴格的層級存取使用者資料。不同方法可能需要不同範圍。舉例來說,API 中的某個方法可能需要至少唯讀範圍,而其他方法可能需要讀寫範圍。

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

  1. 在「憑證」Google OAuth 2.0 部分中,按一下「顯示範圍」
  2. 檢查叫用方法時使用的範圍。
  3. 按一下「執行」,即可只使用所選範圍執行 API。API 探索工具會顯示授權畫面,要求您授予使用範圍的存取權。
  4. 點按「允許」,結果會顯示在「執行」按鈕下方。

如果 API Explorer 在「application/json」下方顯示 200 的結果,表示範圍足以叫用該方法。如果 API 探索工具顯示 403 的結果,表示您選擇的範圍不足以叫用方法。請嘗試擴大範圍。

如需選取範圍的其他資訊,請參閱特定 Google API 說明文件的驗證和授權部分。

撤銷經過授權的存取權,以便使用新範圍進行測試

使用 Google 授權畫面核准授權後,只要憑證未過期,API Explorer 就能持續發出已驗證的要求。取消勾選範圍不會重設先前核准的憑證和範圍。如要使用新的範圍設定進行測試,請先撤銷先前核准的憑證。

如要撤銷 APIs Explorer 使用的憑證,請按照下列步驟操作:

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