Roads API:取得 API 金鑰

注意事項:Google 地圖平台付費方案不再開放註冊或提供給新客戶。

您必須用 API 金鑰驗證要求,才能使用 Roads API。使用 API 金鑰可以:

進一步瞭解付費方案客戶可用的報表

建立 API 金鑰

您必須具備 API 金鑰,才能使用 Roads API。API 金鑰是一組專屬 ID,用來驗證與專案相關的使用權限與帳單處理要求。

取得 API 金鑰的方法如下:

  1. 在 GCP Console 的專案選取器頁面中,選取或建立您想新增 API 金鑰的 Google Cloud 專案。

    前往專案選取器頁面

    注意事項:如要使用方案的完整功能,付費客戶應使用與付費帳戶連結的專案。購買授權後,您會收到以下列格式編寫的付費資產名稱:gme-[company] & proj-[number] ([type])。 為確保您存取的是正確的專案,請透過 console.cloud.google.com/project/number (將 number 替換成專案編號) 以「專案擁有者身分」登入 Cloud Console。 您可以在歡迎信中查看專案擁有者是誰。

  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 支援入口網站,然後選取 [資源] > [Google 地圖平台付費方案線上工具 > [網路服務和 Image API 的網址簽署偵錯工具],接著解決個別網址的問題。