使用 OAuth

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

本文件說明如何將 OAuth 權杖傳遞至在 dev 環境。如需在 環境，請參閱 Google 的驗證。

事前準備

開始使用 Solar API 前，您需要具備 專案連結，而且已啟用 Solar API。建議您建立多個 專案擁有者和帳單管理員，因此您隨時都有擔任這些角色的成員 專屬於您的團隊請參閱這篇文章，進一步瞭解如何在 Cloud 控制台中完成相關設定。

關於 OAuth

根據部署作業使用 OAuth 建立及管理存取權杖的方法有很多種 環境。

舉例來說，Google OAuth 2.0 系統支援伺服器對伺服器之間的互動，例如 應用程式與 Google 服務之間的連線您需要具備服務帳戶 是應用程式擁有的帳戶，而非個別使用者的帳戶。您的 應用程式會代表服務帳戶呼叫 Google API，因此使用者並未直接參與。 如要進一步瞭解驗證方法，請參閱： Google 的驗證。

此外，你也可以在 Android 或 iOS 行動應用程式中使用 Solar API。 如需搭配使用 OAuth 與 Solar API 的一般資訊，包括有關管理方式的資訊 取得不同部署環境的存取權杖，請參閱 使用 OAuth 2.0 存取 Google API。

關於 OAuth 範圍

如要搭配 Solar API 使用 OAuth，您必須將 OAuth 權杖指派給範圍：

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

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

如果想使用 OAuth 權杖試用 Solar API，但沒有設定環境 以產生符記，您可以按照本節的程序發出呼叫。

這個範例說明如何使用 應用程式預設憑證 (ADC) 開始通話。如要進一步瞭解如何透過 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 不支援使用者憑證， 請參閱「使用者憑證無效」。