使用不同的凭据类型和范围进行测试

借助 API Explorer 的凭据部分,您可以测试不同的凭据和范围。此功能有助于确保您使用最少的必需凭据和范围来调用 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 Explorer 中会启用 API 的所有 Google OAuth 2.0 范围。如需使用特定范围进行测试,请执行以下操作:

  1. 在“凭据 - Google OAuth 2.0”部分中,点击显示范围
  2. 检查调用方法时要使用的范围。
  3. 点击 Execute 以仅使用所选范围执行 API。API 探索器会显示一个授权界面,要求您授予使用相应范围的权限。
  4. 点击允许。结果会显示在“执行”按钮下方。

如果 API Explorer 在“application/json”下显示结果 200,则表示相应范围足以调用该方法。如果 API Explorer 显示 403 结果,则表示您选择的范围不足以调用该方法。尝试扩大范围。

如需详细了解范围选择,请参阅特定 Google API 的文档中的身份验证和授权部分。

撤消已授权的访问权限以测试新范围

使用 Google 授权界面批准授权后,只要凭据未过期,API 探索器就始终有权发出经过身份验证的请求。取消勾选范围不会重置之前批准的凭据和范围。如果您想使用新的授权范围配置进行测试,则必须撤消之前获批的凭据。

如需撤消 APIs Explorer 使用的凭据,请执行以下操作:

  1. 前往有权访问您账号的应用
  2. 有账号访问权限的第三方应用下,点击 Google APIs Explorer
  3. 点击撤消访问权限
  4. (可选)重新加载文档页面以重置 API Explorer。