使用 OAuth

歐洲經濟區 (EEA) 開發人員

Solar API 支援使用 OAuth 2.0 進行驗證。Google 也支援常見的 OAuth 2.0 使用情境，例如網路伺服器。

本文說明如何在開發環境中，將 OAuth 權杖傳遞至 Solar API 呼叫。如需在正式環境中使用 OAuth 的操作說明，請參閱「Google 的驗證方式」。

事前準備

您必須擁有已連結帳單帳戶的專案，並啟用 Solar API，才能開始使用 Solar API。建議您建立多個專案擁有者和帳單管理員，這樣您的團隊隨時都有擔任這些角色的成員可處理相關事務。請參閱這篇文章，進一步瞭解如何在 Cloud 控制台中完成相關設定。

關於 OAuth

根據部署環境，您可以使用 OAuth 建立及管理存取權杖。

舉例來說，Google OAuth 2.0 系統支援伺服器對伺服器的互動行為，例如應用程式和 Google 服務之間的互動。在這種情況下，您需要服務帳戶，這是一種屬於應用程式，而非屬於個別使用者的帳戶。您的應用程式會代表服務帳戶呼叫 Google API，因此不會直接牽涉到使用者。如要進一步瞭解驗證方法，請參閱 Google 的驗證方式。

或者，您也可以在 Android 或 iOS 行動應用程式中使用 Solar API。如需在 Solar API 中使用 OAuth 的一般資訊，包括如何管理不同部署環境的存取權杖，請參閱「使用 OAuth 2.0 存取 Google API」。

關於 OAuth 範圍

如要搭配使用 OAuth 和 Solar API，OAuth 權杖必須指派下列範圍：

  • https://www.googleapis.com/auth/cloud-platform

範例：在本機開發環境中試用 REST API 呼叫

如要使用 OAuth 權杖試用 Solar API，但沒有產生權杖的環境設定，可以按照本節的程序進行呼叫。

本範例說明如何使用應用程式預設憑證 (ADC) 提供的 OAuth 權杖進行呼叫。如要瞭解如何使用 ADC 透過用戶端程式庫呼叫 Google API，請參閱「使用用戶端程式庫進行驗證」。

必要條件

使用 ADC 提出 REST 要求前，請先透過 Google Cloud CLI 提供 ADC 憑證：

  1. 如果尚未建立專案並啟用帳單，請按照「在 Google Cloud 控制台中設定」一文中的步驟操作。
  2. 安裝並初始化 gcloud CLI。

  3. 在本機電腦上執行下列 gcloud 指令，建立憑證檔案：

    gcloud auth application-default login
  4. 畫面上會顯示登入畫面。登入後，系統會將您的憑證儲存在 ADC 使用的本機憑證檔案中。

詳情請參閱「提供應用程式預設憑證的憑證」說明文件的「本機開發環境」一節。

發出 REST 要求

在本範例中，您會傳遞兩個要求標頭：

以下範例使用 OAuth 權杖呼叫 Solar API：

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
"https://solar.googleapis.com/v1/dataLayers:get?location.latitude=37.4450&location.longitude=-122.1390&radius_meters=100&required_quality=HIGH"

疑難排解

如果要求傳回的錯誤訊息指出這項 API 不支援使用者憑證，請參閱「使用者憑證無法運作」。