Roads API:获取 API 密钥

注意:Google Maps Platform 高级计划不再面向注册客户和新客户提供。

如需使用 Roads API,您必须使用 API 密钥对请求进行身份验证。使用 API 密钥,您可以执行以下操作:

如需了解详情,请参阅面向高级计划客户提供的报告

创建 API 密钥

如需使用 Roads API,您必须拥有一个 API 密钥。API 密钥是唯一标识符,用于对与您的项目相关联的请求进行身份验证,以便您使用相关产品和执行结算。

要获取 API 密钥,请执行以下操作:

  1. 在 GCP Console 中,打开项目选择器页面,选择或创建要向其添加 API 密钥的 Google Cloud 项目。

    转到项目选择器页面

    注意:如需拥有对计划中的功能的完整访问权限,高级计划客户应使用与其高级计划帐号相关联的项目。购买许可时,您会收到如下格式的高级计划资产名称:gme-[company] & proj-[number] ([type])。为确保您访问的是正确的项目,请通过 console.cloud.google.com/project/number(将 number 替换为您的项目编号)以项目所有者身份登录控制台。您可以在欢迎邮件中找到项目所有者。

  2. 依次转到 API 和服务 > 凭据页面。

    转到“凭据”页面

  3. 凭据页面上,依次点击创建凭据 > API 密钥
    已创建的 API 密钥对话框会显示您新创建的 API 密钥。
  4. 点击关闭
    新的 API 密钥位于凭据页面的 API 密钥下。
    (请务必在实际使用之前限制 API 密钥。)

向您的请求添加 API 密钥

您必须在每个 Roads API 请求中都添加一个 API 密钥。在以下示例中,将 YOUR_API_KEY 替换为您的 API 密钥。

https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836 &interpolate=true &key=YOUR_API_KEY

限制 API 密钥

通过限制 API 密钥,您可以确保只能使用您的 API 密钥发出已授权的请求,从而提高应用安全性。我们强烈建议您按照相关说明为您的 API 密钥设置限制。如需了解详情,请参阅 API 密钥最佳做法

如要限制 API 密钥,请执行以下操作:

  1. 在 GCP Console 中,打开项目选择器页面,选择或创建要向其添加 API 密钥的 Google Cloud 项目。

    转到项目选择器页面

  2. 依次转到 API 和服务 > 凭据页面。

    转到“凭据”页面

  3. 选择您要设置限制的 API 密钥。系统随即会显示 API 密钥属性页面。
  4. 密钥限制下,设置以下限制:
    • 应用限制:
      1. 如要接受来自您提供的一系列网络服务器 IP 地址的请求,请从应用限制列表中选择 IP 地址(网络服务器、Cron 作业等)
      2. 指定一个 IPv4 或 IPv6 地址,或采用 CIDR 表示法的子网(例如 192.168.0.0/22)。如果您需要输入其他条目,在您添加完上一个条目后,系统会显示一个新框。
    • API 限制:
      1. 点击限制密钥
      2. 选择 API 下拉列表中选择 Roads API
        (如果 Roads API 未列出,您需要启用它。)
  5. 点击保存以完成更改。

排查身份验证问题

如果您的请求格式不正确,或者提供的签名无效,则 Roads API 会返回 HTTP 403 (Forbidden) 错误。

如要对各个网址进行问题排查,您可以使用网址签名调试程序。借助该调试程序,您可以快速验证网址和由您的应用生成的签名。

或者,高级计划客户也可以通过以下方式对各个网址进行问题排查:登录 Google Cloud 支持门户,然后依次选择 Resources > Google Maps Platform Premium Plan online tools > URL Signing Debugger for Web Service and Image APIs