API 密钥概览

API 密钥是一个简单的加密字符串,您可以使用此密钥来调用Google Cloud API。API 密钥的典型用途是将密钥作为查询参数传递到 REST API 调用中,格式如下:

http://example-library.googleapis.com/v1/publishers/mypublisher/books?key=API_KEY
API 密钥对于匿名访问公开数据非常有用,并且可用于将 API 请求与消费者 Google Cloud 项目相关联,以进行配额计算和结算

API Keys 为您提供了一个编程接口,用于为项目创建和管理 API 密钥。与您在 Google Cloud 控制台中可以执行的 API 密钥相关任务相比,它可让您更好地控制 API 密钥。

如需详细了解如何向 Google Cloud API 进行身份验证并确定常见场景的最佳身份验证策略,请参阅身份验证概览。 如需详细了解如何将 API 密钥用于 Google Maps Platform API 和 SDK,请参阅 Google Maps Platform 文档

保护 API 密钥

当您在应用中使用 API 密钥时,请确保其在存储和传输期间均安全无虞。 公开泄露凭据可能会导致您的账号遭盗用,这可能会使您的账号产生预料之外的费用。 为帮助确保 API 密钥的安全,请遵循以下最佳实践:

  • 不要直接在代码中嵌入 API 密钥。嵌入代码中的 API 密钥可能会被意外泄露给公众。例如,您可能忘记从共享的代码中移除密钥。您可以将 API 密钥存储在环境变量或应用的源代码树之外的文件中,而不是将 API 密钥嵌入应用中。

  • 为 API 密钥添加限制。 通过添加限制,您可以降低 API 密钥被盗用时造成的影响。

  • 删除不需要的 API 密钥以最大限度地减少遭到攻击的风险。

  • 定期轮替 API 密钥。如需轮替 API 密钥,请调用 CreateKey 方法。创建替换密钥后,请更新应用以使用新生成的密钥,并删除旧密钥。

  • 公开发布代码前,先检查您的代码,确保您的代码不包含 API 密钥或任何其他私密信息,然后再公开代码。

后续步骤