授權要求

當您的應用程式要求私人資料時,這個要求必須取得可存取該資料的已驗證使用者的授權。

當您的應用程式要求公開資料時,這個要求不須取得授權,但須要附有 ID,例如 API 金鑰。

您的應用程式傳送至 Cloud Resource Manager API 的每項要求,都必須向 Google 識別您的應用程式。有兩種方法可以識別您的應用程式:使用 OAuth 2.0 憑證 (也用來授權要求) 和/或使用應用程式的 API 金鑰。下列內容說明如何決定使用的方法:

  • 如果要求需要經過授權 (例如要求個人的私人資料),則應用程式必須為此要求提供 OAuth 2.0 憑證。應用程式也可以提供 API 金鑰,但並非必須。
  • 如果要求不需要經過授權 (例如要求公開資料),則應用程式必須為此要求提供 OAuth 2.0 憑證及/或 API 金鑰,視何種方式對您來說比較方便而定。

關於授權通訊協定

您的應用程式必須使用 OAuth 2.0 授權要求。系統不支援其他授權通訊協定。如果您的應用程式採用使用 Google 帳戶登入功能,系統會為您處理部分授權事項。

使用 OAuth 2.0 授權要求

向 Cloud Resource Manager API 發出的非公開使用者資料要求都必須獲得已驗證使用者的授權。

OAuth 2.0 授權程序 (或「流程」) 的細節會根據您編寫的應用程式類型而有所不同。下列一般程序適用於所有應用程式類型:

  1. 建立應用程式時,您必須使用 Cloud de Confiance 控制台註冊應用程式。接著 Google 會向您提供稍後需要的資訊,例如用戶端 ID 和用戶端密碼。
  2. 在 Cloud de Confiance 控制台中啟用 Cloud Resource Manager API。(如果 Cloud de Confiance 控制台未列出該 API,請略過這個步驟)。
  3. 當應用程式需要存取使用者資料時,會向 Google 要求特定的存取範圍
  4. Google 會向使用者顯示同意畫面,要求他們授權您的應用程式要求的部分資料。
  5. 如果使用者同意,Google 即會將短期的存取憑證授予您的應用程式。
  6. 您的應用程式向使用者要求資料,並且在要求中附上存取符記。
  7. 如果 Google 判定您的要求與憑證有效,即會傳回要求的資料。

部分流程包含額外的步驟,例如使用更新憑證來取得新的存取憑證。如要進一步瞭解各類應用程式的流程,請參閱 Google 的 OAuth 2.0 說明文件

以下是 Cloud Resource Manager API 的 OAuth 2.0 範圍資訊:

範圍 意義
https://www.googleapis.com/auth/cloud-platform 讀取/寫入權限。

如要透過 OAuth 2.0 要求存取權,您的應用程式需要範圍資訊,以及 Google 在您註冊應用程式時提供的資訊 (例如用戶端 ID 和用戶端密碼)。

提示:Google API 用戶端程式庫可以為您處理部分授權程序,且適用於多種程式設計語言;詳情請參閱程式庫和範例頁面

取得並使用 API 金鑰

向 Cloud Resource Manager API 發出的公開資料要求都必須附有 ID,可以是 API 金鑰或是存取權杖

要取得 API 金鑰:

  1. 在 Cloud de Confiance 控制台中開啟「憑證」頁面
  2. 這項 API 支援兩種憑證。 請建立適用於您專案的憑證:
    • OAuth 2.0:每當您的應用程式要求私人使用者資料時,必須同時傳送 OAuth 2.0 憑證。您的應用程式會先傳送用戶端 ID,並可能傳送用戶端密碼以獲取憑證。您可以為網路應用程式、服務帳戶或已安裝的應用程式產生 OAuth 2.0 憑證。

      詳情請參閱 OAuth 2.0 說明文件

    • API 金鑰: 沒有提供 OAuth 2.0 憑證的要求必須傳送 API 金鑰。 金鑰可用來識別專案,並為您提供 API 存取權、配額和報表。

      API 支援數種類型的 API 金鑰限制。如果您還沒有所需的 API 金鑰,請依序點選「建立憑證」>「API 金鑰」 ,以在主控台中建立 API 金鑰。在您將金鑰使用在實際工作環境中之前,可以點選「限制金鑰」並選擇其中一項限制,以限制金鑰的使用。

為確保您 API 金鑰的安全,請遵循安全使用 API 金鑰的最佳做法

取得 API 金鑰後,您的應用程式可以將查詢參數 key=yourAPIKey 附加到所有的要求網址。

API 金鑰可以安全地嵌入網址中,不需任何編碼。