建立用戶端 ID

如果您要求須通過驗證才能存取您的 API 後端,則必須取得所需的用戶端 ID,並使用適當的 API 裝飾器引數,將這些 ID 提供給後端。

Android

您必須具備憑證金鑰指紋,才能建立 OAuth 2.0 Android 用戶端 ID。如果您使用 Android Studio,系統會自動建立偵錯金鑰庫和偵錯金鑰。偵錯金鑰可用於測試用途,但是在實際工作環境中您必須使用發行金鑰。

請注意,預設的偵錯 keystore 密碼為 android,金鑰別名則為 androiddebugkey。Linux 和 macOS 的預設位置為 ~/.android/debug.keystore

  1. 如果您還沒有偵錯或發行金鑰,請為 Android 應用程式產生一個。如果您使用 Android Studio,則在初次建構 Android 專案時,其會自動在偵錯金鑰庫中產生偵錯金鑰。
  2. 在 Linux 或 macOS 終端機視窗中,您可以使用 keytool (隨附於 Java SDK 中) 取得金鑰指紋,如下所示:
    keytool -exportcert -alias androiddebugkey -keystore path-to-debug-or-production-keystore -list -v
    輸出會顯示一個指紋,類似如下:DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09
  3. 執行上述 keytool 指令後,複製並儲存系統顯示的金鑰指紋。您必須提供指紋才能在 Google Cloud Platform 主控台中產生 Android 用戶端 ID。
  4. 在 GCP 主控台中,前往「Credentials」(憑證) 頁面

    前往「Credentials」(憑證) 頁面

  5. 在專案清單中選取包含 API 的專案。
  6. 若這是您第一次在此專案建立用戶端 ID,請使用子步驟前往「OAuth consent」(OAuth 同意) 頁面,否則請跳至下一步。
    1. 按一下 [OAuth consent screen] (OAuth 同意畫面)
    2. 在「Application Name」(應用程式名稱) 欄位輸入名稱。
    3. 根據需要填寫其餘欄位。
    4. 按一下 [Save] (儲存)
  7. 在「Create credentials」(建立憑證) 下拉式清單,選取 [OAuth client ID] (OAuth 用戶端 ID)
  8. 將應用程式類型設為 [Android]
  9. 在「Name」(名稱) 中,輸入用戶端 ID 的名稱。
  10. 在「Signing-certificate fingerprint」(簽署憑證的指紋) 中,輸入您透過上述步驟取得的指紋。
  11. 在「Package name」(套件名稱) 中,輸入 Android 應用程式套件名稱 (如在 AndroidManifest.xml 檔案中所指定)。
  12. 按一下 [Create] (建立)

    您會在 API 後端與用戶端應用程式中使用產生的用戶端 ID。

網路用戶端

  1. 在 GCP 主控台中,前往「Credentials」(憑證) 頁面

    前往「Credentials」(憑證) 頁面

  2. 在專案清單中選取包含 API 的專案。
  3. 若這是您第一次在此專案建立用戶端 ID,請使用子步驟前往「OAuth consent」(OAuth 同意) 頁面,否則請跳至下一步。
    1. 按一下 [OAuth consent screen] (OAuth 同意畫面)
    2. 在「Application name」(應用程式名稱) 欄位輸入名稱。
    3. 根據需要填寫其餘欄位。
    4. 按一下 [Save] (儲存)
  4. 在「Create credentials」(建立憑證) 下拉式清單,選取 [OAuth client ID] (OAuth 用戶端 ID)
  5. 選取 [Web application] (網路應用程式) 做為應用程式類型。
  6. 在「Name」(名稱) 中,輸入用戶端 ID 的名稱。
  7. 在「Authorized JavaScript origins」(已授權的 JavaScript 來源) 中,輸入下列任一項目:
    • http://localhost:8080 (如果您正在本機測試後端)。
    • https://YOUR_PROJECT_ID.appspot.com (如果您正在部署後端 API 至實際工作環境 App Engine,請將 YOUR_PROJECT_ID 替換成您的 App Engine 專案 ID)。

  8. 按一下 [Create] (建立)

    您會在 API 後端與用戶端應用程式中使用產生的用戶端 ID。

後續步驟

如要瞭解如何在 Android 或 JavaScript 應用程式中支援驗證,請參閱以下內容:

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁