Map Management API 支援使用 OAuth 2.0 進行驗證。Google 支援常見的 OAuth 2.0 情境,例如網路伺服器。
本文說明如何在開發環境中,將 OAuth 權杖傳遞至 Map Management API 呼叫。如需在正式環境中使用 OAuth 的操作說明,請參閱「Google 的驗證方式」。
事前準備
您必須擁有已連結帳單帳戶的專案,並啟用 Map Management API,才能開始使用 Map Management API。詳情請參閱「在 Cloud 控制台中設定」。
關於 OAuth
您可以根據部署環境,透過多種方式使用 OAuth 建立及管理存取權杖。
舉例來說,Google OAuth 2.0 系統支援伺服器對伺服器互動,例如應用程式與 Google 服務之間的互動。在這個情境中,您需要服務帳戶。這類帳戶屬於應用程式,而非個別使用者。由於使用者不會直接參與,因此應用程式會代表服務帳戶呼叫 Google API。如要進一步瞭解驗證方式,請參閱「Google 的驗證機制」。
或者,您也可以在 Android 或 iOS 行動應用程式中使用 Map Management API。如要進一步瞭解如何搭配使用 OAuth 和 Map Management API,包括如何管理不同部署環境的存取權杖,請參閱「使用 OAuth 2.0 存取 Google API」。
關於 OAuth 範圍
如要搭配使用 OAuth 和 Map Management API,OAuth 權杖必須具有 https://www.googleapis.com/auth/cloud-platform 範圍。
在本機開發環境中試用 REST API 呼叫
如果您想使用 OAuth 權杖試用 Map Management API,但尚未設定產生權杖的環境,可以按照本節中的程序發出呼叫。
本範例說明如何使用應用程式預設憑證 (ADC) 提供的 OAuth 權杖發出呼叫。如要進一步瞭解如何使用 ADC 透過用戶端程式庫呼叫 Google API,請參閱「使用用戶端程式庫進行驗證」。
必要條件
您必須先使用 Google Cloud CLI 將憑證提供給 ADC,才能使用 ADC 發出 REST 要求:
- 如果您尚未建立專案並啟用計費功能,請按照「在 Cloud 控制台中設定」一文中的步驟操作。
- 安裝並初始化 gcloud CLI。
如要建立憑證檔案,請在本機電腦上執行
gcloud指令:gcloud auth application-default login
- 在系統提示時登入帳戶。登入後,您的憑證會儲存在 ADC 使用的本機憑證檔案中。
詳情請參閱「提供應用程式預設憑證的憑證」說明文件的「本機開發環境」一節。
提出 REST 要求
在這個範例中,您會傳遞兩個要求標頭:
使用下列指令產生權杖,在
Authorization標頭中傳遞 OAuth 權杖:gcloud auth application-default print-access-token傳回的權杖範圍為
https://www.googleapis.com/auth/cloud-platform。- 在
X-Goog-User-Project標頭中,傳遞已啟用計費功能的 Google Cloud 專案 ID 或名稱。詳情請參閱「在 Cloud 控制台中設定」一文。
使用 OAuth 權杖呼叫 Map Management API:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "X-Goog-User-Project: PROJECT_ID" \ https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs/
疑難排解
如果要求傳回錯誤訊息,指出這個 API 不支援使用者憑證,請參閱「使用者憑證無法運作」一節。