利用 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 范围。如需使用特定范围进行测试,请执行以下操作:
- 在“凭据 Google OAuth 2.0”部分,点击显示范围。
- 检查在调用该方法时使用的范围。
- 点击执行,以仅使用所选范围执行 API。API Explorer 会显示授权屏幕,要求您授予该范围的访问权限。
- 点击允许。结果显示在“执行”按钮下方。
如果 API Explorer 在“application/json”下显示结果 200,则表示作用域足以调用该方法。如果 API Explorer 显示 403 结果,则表明您选择的范围不足,无法调用该方法。请尝试更广泛的范围。
如需详细了解范围选择,请参阅特定 Google API 的文档的身份验证和授权部分。
撤消授权范围,以便使用新范围进行测试
使用 Google 授权屏幕批准授权后,只要凭据未过期,API Explorer 就会继续发出经过身份验证的请求。取消选中范围不会重置之前批准的凭据和范围。如果您想要使用新的范围配置进行测试,则必须撤消之前批准的凭据。
要撤消 API Explorer 使用的凭据,请执行以下操作:
- 转到有权访问您帐号的应用。
- 在具有帐号访问权限的第三方应用下方,点击 Google API Explorer。
- 点击撤消访问权限。
- (可选)重新加载文档页面,以重置 API Explorer。