取得 API 金鑰

選取平台: Android iOS JavaScript

現在您已設定帳單和專案啟用 SDK,並安裝偏好的依附元件管理工具和其他軟體,可以做好建立、新增及限制 API 金鑰的準備。

建立 API 金鑰

API 金鑰是一組專屬 ID,用於驗證與您專案有關的使用權限及帳單處理請求。您的專案至少要有一個相關聯的 API 金鑰。

建立 API 金鑰的方法如下:

控制台

  1. 前往「Google Maps Platform」(Google 地圖平台) >「Credentials」(憑證) 頁面。

    前往「Credentials」(憑證) 頁面

  2. 在「Credentials」(憑證) 頁面上,點選「Create credentials」(建立憑證) >「API key」(API 金鑰)
    「API key created」(建立的 API 金鑰) 對話方塊會顯示您新建立的 API 金鑰。
  3. 按一下「Close」(關閉)。
    新建立的 API 金鑰會出現在「Credentials」(憑證) 頁面的「API keys」(API 金鑰) 下方。
    (別忘了先為 API 金鑰設定限制,然後才在正式環境中使用)

Cloud SDK

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

進一步瞭解 Google Cloud SDKCloud SDK 安裝和下列指令:

如「設定 Xcode 專案」一文所述,當您建立 Xcode 專案時,需要用到這組 API 金鑰。

限制 API 金鑰

Google 強烈建議您設定限制,只允許將 API 金鑰用於應用程式需要的 API。限制 API 金鑰可避免不必要的請求使用 API 金鑰,有助提升應用程式的安全性。詳情請參閱「API 安全性最佳做法」。

限制 API 金鑰的方法如下:

控制台

  1. 前往「Google Maps Platform」(Google 地圖平台) >「Credentials」(憑證) 頁面。

    前往「Credentials」(憑證) 頁面

  2. 選取要設定限制的 API 金鑰,畫面隨即顯示 API 金鑰屬性頁面。
  3. 在「Key restrictions」(金鑰限制) 下方,設定下列限制:
    • 應用程式限制:
      1. 選取 [iOS 應用程式]
      2. 如要接受包含您提供的軟體包 ID 的 iOS 應用程式發出的要求,請從清單中選取適當的 iOS 軟體包 ID。
    • API 限制:
      1. 按一下「Restrict key」(限制金鑰)
      2. 從「選取 API」下拉式選單中點選「Maps SDK for iOS」。如果畫面上未列出 Maps SDK for iOS,表示您需要enable該 SDK。
  4. 如要完成變更,請按一下「儲存」(Save)

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 專案。