瞭解如何使用及管理 Firebase 的 API 金鑰

查看如何建立 API 專屬金鑰的操作說明

這些操作說明會說明如何為名為 Super Service API 的假 API 建立獨立的受限制 API 金鑰。

步驟 1：將現有的 API 金鑰設為禁止存取 Super Service API

1. 開啟 Google Cloud 控制台的「Credentials」(憑證) 頁面。系統出現提示訊息時，請選取專案。

2. 針對清單中的每個現有 API 金鑰，開啟編輯檢視畫面。

3. 在「API 限制」區段中，選取「限制金鑰」，然後加入清單中，讓 API 金鑰能夠存取的所有 API。請務必「不要」加入要建立個別 API 金鑰的 API (在此範例中為 Super Service API)。

   設定 API 金鑰的 API 限制時，您會明確宣告該金鑰有權存取的 API。根據預設，如果「API 限制」部分已選取「不要限制金鑰」，則 API 金鑰可用於存取已啟用專案的任何 API。

現在，現有的 API 金鑰不會授予 Super Service API 的存取權，但您加入 API 限制清單內的任何 API 都能繼續使用每個金鑰。

步驟 2：建立並使用新的 API 金鑰來存取「Super Service API」

1. 返回「Credentials」(憑證) 頁面。請確保您的 Firebase 專案仍處於選取狀態。

2. 依序按一下「建立憑證」>「API 金鑰」。記下新的 API 金鑰，然後按一下「Restrict key」(限制金鑰)。

3. 在 API 限制區段中，選取「Restrict key」(限制金鑰)，然後只新增至清單 Super Service API。

   這個新的 API 金鑰只能授予 Super Service API 的存取權。

4. 設定您的應用程式和服務，以使用新的 API 金鑰。

如何判斷哪個 API 金鑰與 Firebase 應用程式相關聯？

您可以使用下列任一選項，判斷哪個 API 金鑰與您的 Firebase 應用程式相關聯：

我可以在 Firebase 設定檔/物件中，為同一個 Firebase 應用程式列出兩組 API 金鑰嗎？

• Firebase Apple 應用程式：每個應用程式都有專屬的設定檔，並且只能列出一個 API 金鑰。

• Firebase Android 應用程式：Firebase 專案中的所有 Android 應用程式都會列在同一個設定檔中，而「每個」應用程式只能列出一個 API 金鑰。不過，這個設定檔中的每個應用程式可以列出不同的金鑰。

• Firebase 網頁應用程式：每個應用程式都有專屬的設定物件，並且只能列出一個 API 金鑰。

不過，一個應用程式可以使用多個 API 金鑰。您必須為應用程式提供機制，以便透過環境變數等方式存取其他 API 金鑰。其他 API 金鑰的存取機制無法依附於 Firebase 設定檔/物件中列出的 API 金鑰。

Firebase 如何知道哪個 API 金鑰要與應用程式進行比對 (例如 Firebase 設定檔/物件中的 API)？

您首次取得應用程式的 Firebase 設定檔/物件時，Firebase 會檢查專案中是否有任何現有 API 金鑰的「應用程式限制」符合該應用程式 (例如 Apple 應用程式的相符軟體包 ID)。

如果 Firebase 找不到任何相符的受限制金鑰，就會在設定檔/物件中列出 Apple 應用程式的 iOS key、Android 應用程式的 Android key，以及網頁應用程式的 Browser key (假設這些金鑰已存在，並沒有任何「應用程式限制」導致金鑰無法與該應用程式進行比對)。

我可以手動刪除 Firebase 設定檔/物件中的 API 金鑰和欄位嗎？

可以，您可以手動從設定檔/物件中刪除 API 金鑰。不過，您必須提供其他機制，讓應用程式存取 API 金鑰 (例如透過環境變數)。否則對 Firebase 服務的所有呼叫都會失敗。

我可以使用其他 API 金鑰手動編輯 Firebase 設定檔/物件嗎？

可以，您可以手動編輯設定檔/物件，將不同的 API 金鑰與應用程式建立關聯。

請注意，如果您是從主控台重新取得應用程式的設定檔/物件，則一律會列出 Firebase 自動與該應用程式配對的 API 金鑰。因此，您必須視需要重複手動編輯。

我可以將 API 金鑰從一項 Firebase 專案移至其他專案嗎？

不行，API 金鑰只能識別特定專案，無法移至其他專案。

如果刪除 Google Cloud 控制台中列出的 API 金鑰，會發生什麼事？

如果您刪除某個應用程式正在使用的 API 金鑰，該應用程式的 API 呼叫就會失敗。您可能會收到嘗試使用無效 API 金鑰的報表、電子郵件或錯誤。

API 金鑰一經刪除即無法復原。

對於 Firebase API 金鑰的「API 限制」許可清單中需要哪些 API？

以 Firebase API 金鑰來說，只有需要納入金鑰「API 限制」許可清單的 API，就是要求用戶端在呼叫時一併提供 API 金鑰的 API。請注意，只有少數 Firebase 相關 API 符合這項規定。在專案中已啟用的大多數 Firebase 相關 API 不需要列入金鑰的「API 限制」許可清單中。

請參閱下表，決定要將哪些 Firebase 相關 API 加入 Firebase API 金鑰的「API 限制」許可清單中。別忘了，Firebase API 金鑰僅適用於 Firebase 服務。進一步瞭解如何為特定 API 類型建立個別的受限 API 金鑰。

您可以在 Google Cloud 控制台的「API 和服務」>「憑證」面板中查看及管理專案的 API 金鑰。

^{* 只有在 Firebase API 金鑰與第三方工具搭配使用，或直接透過 REST 存取 Firebase 服務 / 產品的情況下，才需要提供這項參數。}

^{** 對舊版產品 SDK 為必填。如果您使用的是最新版的 SDK，則 API 不需要列在金鑰的許可清單中。}

指出向這個 API 發出的要求遭到封鎖 API_KEY_SERVICE_BLOCKED 或 403 禁止的錯誤，該如何修正？

如果看到 API_KEY_SERVICE_BLOCKED 錯誤或類似下列錯誤，請按照本常見問題中的指示操作：

Forbidden: 403 POST https://example-service.googleapis.com/method: Requests to this API example-service.googleapis.com method google.example-service.rest.method are blocked.

您的應用程式用於呼叫 API 的 API 金鑰可能已套用 「API 限制」，且金鑰的許可清單中未包含該 API。

• 如果在嘗試使用 Firebase 相關服務 / 產品時收到這個錯誤，請確認目前使用的 API 金鑰含有金鑰「API 限制」許可清單中的所有必要 API。

• 如果在嘗試使用非 Firebase 服務時收到這個錯誤，強烈建議您針對該服務和 API 建立新的 API 金鑰。Firebase API 金鑰只能用於 Firebase 服務 / 產品。進一步瞭解如何為特定 API 類型建立個別的受限 API 金鑰。

該如何修正這個錯誤？「無法從伺服器擷取這個 Firebase 應用程式的評估 ID。」

網頁應用程式使用的 API 金鑰可能已套用 「API 限制」。在這種情況下，請確認 Firebase Management API 列於允許的 API 清單中。

我收到 API 金鑰無效的電子郵件或錯誤訊息。發生什麼問題，我該如何修正這個問題？

以下是 API 金鑰無效最常見的幾個原因：

• API 金鑰已套用 「API 金鑰限制」，因此該金鑰與嘗試使用金鑰的應用程式 (「應用程式限制」) 無法比對，也不適用於呼叫的 API (「API 限制」)。

• API 金鑰已從 Google Cloud 控制台的專案中刪除。

• 未針對應用程式 Firebase 設定檔/物件中列出的專案 ID 建立 API 金鑰。

修正此問題的方法之一，就是取得應用程式的 Firebase 設定檔/物件更新版本，然後以新的更新檔案/物件取代舊有的設定檔/物件。傳送要下載的設定檔，或在主控台中顯示設定物件之前，Firebase 會檢查所列 API 金鑰是否與應用程式相符。