获取 API 密钥

请选择平台: Android iOS JavaScript

现在,您已设置结算信息和项目,并启用了 SDK, 并且安装了首选的依赖项管理器和其他软件, 以便创建、添加和限制您的 API 密钥。

创建 API 密钥

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

如需创建 API 密钥,请执行以下操作:

控制台

  1. 前往 Google Maps Platform > 凭据页面。

    前往“凭据”页面

  2. 凭据页面上,依次点击创建凭据 > API 密钥
    已创建的 API 密钥对话框会显示您新创建的 API 密钥。
  3. 点击关闭
    新的 API 密钥即会列在凭据页面的 API 密钥下。
    (在生产环境中使用 API 密钥之前,请务必对 API 密钥设置限制。)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

详细了解 Google Cloud SDKCloud SDK 安装和以下命令:

您在创建 Xcode 项目时需要用到此 API 密钥,如 设置 Xcode 项目

限制 API 密钥

Google 强烈建议您限制 API 密钥,仅将其用于您的应用所需要的 API。限制 API 密钥可防止您的应用收到无正当理由的请求,从而提高应用安全性。如需了解详情,请参阅 API 安全性最佳实践

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

控制台

  1. 前往 Google Maps Platform > 凭据页面。

    前往“凭据”页面

  2. 选择您要设置限制的 API 密钥。系统随即会显示 API 密钥属性页面。
  3. 密钥限制下,设置以下限制:
    • 应用限制:
      1. 选择 iOS 应用
      2. 接受来自 iOS 应用且包含您安装的软件包标识符的请求 请从列表中选择相应的 iOS 软件包标识符。
    • API 限制:
      1. 点击限制密钥
      2. 选择 API 下拉列表中选择 Maps SDK for iOS。 如果 Maps SDK for iOS 未列出,您需要 启用它。
  4. 点击保存以完成更改。

Cloud SDK

列出现有密钥。

gcloud services api-keys list --project="PROJECT"

清除对现有密钥的现有限制。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

为现有密钥设置新限制。

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="maps-ios-backend.googleapis.com"
    --allowed-bundle-ids="BUNDLE_NAME"

详细了解 Google Cloud SDKCloud SDK 安装和以下命令:

现在,您已获取 Maps SDK for iOS 的 API 密钥,接下来可以开始使用了。

后续步骤

现在您已经有了 API 密钥,请创建并配置您的 Xcode 项目,如下所示: 设置 Xcode 项目中的说明。