如果您要求須通過驗證才能存取您的 API 後端,則必須取得所需的用戶端 ID,並使用適當的 API 裝飾器引數,將這些 ID 提供給後端。
Android
您必須具備憑證金鑰指紋,才能建立 OAuth 2.0 Android 用戶端 ID。如果您使用 Android Studio,系統會自動建立偵錯金鑰庫和偵錯金鑰。您可以使用偵錯金鑰進行測試,但必須使用發行版金鑰進行正式發布。
請注意,預設的偵錯 KeyStore 密碼為 android
,金鑰別名則為 androiddebugkey
。Linux 和 macOS 的預設位置為 ~/.android/debug.keystore
。
- 如果您還沒有偵錯或發行金鑰,請為 Android 應用程式產生一個。如果您使用 Android Studio,則在初次建構 Android 專案時,其會自動在偵錯金鑰庫中產生偵錯金鑰。
-
在 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
-
執行上述
keytool
指令後,複製並儲存系統顯示的金鑰指紋。您必須提供指紋才能在 Google Cloud 控制台中產生 Android 用戶端 ID。 - 前往 Google Cloud 控制台的「Credentials」(憑證) 頁面。
- 在專案清單中選取包含 API 的專案。
- 若這是您第一次在此專案建立用戶端 ID,請使用子步驟前往「OAuth consent」(OAuth 同意) 頁面,否則請跳至下一步。
- 按一下 [OAuth consent screen] (OAuth 同意畫面)。
- 在「Application Name」(應用程式名稱) 欄位輸入名稱。
- 根據需要填寫其餘欄位。
- 按一下「儲存」。
- 在「Create credentials」(建立憑證) 下拉式清單,選取 [OAuth client ID] (OAuth 用戶端 ID)。
- 將應用程式類型設為「Android」Android。
- 在「Name」(名稱) 中,輸入用戶端 ID 的名稱。
- 在「Signing-certificate fingerprint」(簽署憑證的指紋) 中,輸入您透過上述步驟取得的指紋。
-
在「Package name」(套件名稱) 中,輸入 Android 應用程式套件名稱 (如同
AndroidManifest.xml
檔案中指定的名稱)。 - 按一下 [建立]。
您會在 API 後端與用戶端應用程式中使用產生的用戶端 ID。
網路用戶端
- 前往 Google Cloud 控制台的「Credentials」(憑證) 頁面。
- 在專案清單中選取包含 API 的專案。
- 若這是您第一次在此專案建立用戶端 ID,請使用子步驟前往「OAuth consent」(OAuth 同意) 頁面,否則請跳至下一步。
- 按一下 [OAuth consent screen] (OAuth 同意畫面)。
- 在「Application Name」(應用程式名稱) 欄位輸入名稱。
- 根據需要填寫其餘欄位。
- 按一下「儲存」。
- 在「Create credentials」(建立憑證) 下拉式清單,選取 [OAuth client ID] (OAuth 用戶端 ID)。
- 將應用程式類型設為「網頁應用程式」。
- 在「Name」(名稱) 中,輸入用戶端 ID 的名稱。
-
在「Authorized JavaScript origins」(已授權的 JavaScript 來源) 中,輸入下列任一項目:
-
http://localhost:8080
(如果您正在 本機測試後端)。 -
https://YOUR_PROJECT_ID.appspot.com
,如果您要將後端 API 部署至實際用途 App Engine,請將YOUR_PROJECT_ID
替換為您的 App Engine 專案 ID。
-
-
按一下 [Create] (建立)。
您會在 API 後端與用戶端應用程式中使用產生的用戶端 ID。
後續步驟
如要瞭解如何在 Android 或 JavaScript 應用程式中支援驗證,請參閱以下內容: