En savoir plus sur les clés API pour Firebase et les gérer

Une clé API est une chaîne unique qui permet d'acheminer les requêtes vers votre projet Firebase lors de l'interaction avec Firebase et les services Google. Cette page fournit des informations de base sur les clés API, ainsi que des bonnes pratiques pour les utiliser et les gérer avec les applications Firebase.

Si vous avez reçu un e-mail de Google Cloud concernant une "clé API Google accessible publiquement pour votre projet Google Cloud" et que la clé API indiquée dans l'e-mail est votre clé API Firebase, assurez-vous qu'elle répond aux exigences suivantes pour pouvoir être incluse en toute sécurité dans votre code ou vos fichiers de configuration. Vous pouvez vérifier les éléments suivants sur la page API et services > Identifiants de la console Google Cloud.

  • Il s'agit de la clé API que vous utilisez pour votre application Firebase et uniquement pour les services Firebase. Ces clés sont généralement appelées Browser key (auto created by Firebase), Android key (auto created by Firebase) ou iOS key (auto created by Firebase).
  • Elle inclut toutes les API requises liées à Firebase dans la liste d'autorisation "Restrictions relatives aux API" de la clé.
  • Elle ne comporte aucune autre API dans sa liste d'autorisation "Restrictions relatives aux API". En particulier, la liste ne doit pas contenir Generative Language API.

Assurez-vous également d'utiliser Firebase Security Rules et App Check comme recommandé pour les produits Firebase que vous utilisez.

Pour en savoir plus sur les clés API pour Firebase et consulter les questions fréquentes, consultez En savoir plus sur l'utilisation et la gestion des clés API pour Firebase.


Le reste de cette page fournit des informations détaillées sur les clés API pour Firebase, ainsi qu'une liste de questions fréquentes sur ces clés.

Informations générales sur les clés API et Firebase

Les clés API pour Firebase sont différentes des clés API standards

Contrairement à l'utilisation habituelle des clés API, les clés API pour les services Firebase ne sont pas utilisées pour contrôler l'accès aux ressources de backend. Cela ne peut être fait qu'avec Firebase Security Rules (pour contrôler quels utilisateurs finaux peuvent accéder aux ressources) et Firebase App Check (pour contrôler quelles applications peuvent accéder aux ressources).

En règle générale, vous devez protéger scrupuleusement les clés API (par exemple, en utilisant un service de coffre-fort ou en définissant les clés en tant que variables d'environnement). Toutefois, les clés API des services Firebase peuvent être incluses dans le code ou les fichiers de configuration enregistrés.

Bien que les clés API des services Firebase puissent être incluses dans le code en toute sécurité, vous devez examiner et appliquer les restrictions et limites appropriées.

Créer des clés API

Un projet Firebase peut comporter plusieurs clés API, mais chaque clé API ne peut être associée qu'à un seul projet Firebase.

Clés API créées automatiquement par Firebase pour vos applications Firebase

Firebase crée automatiquement des clés API pour votre projet lorsque vous effectuez l'une des opérations suivantes :

  • Créer un projet Firebase > Browser key créé automatiquement
  • Créer une application Apple Firebase > iOS key créée automatiquement
  • Créer une application Android Firebase > Android key créée automatiquement

Vous pouvez également créer vos propres clés API dans la console Google Cloud, par exemple pour le développement ou le débogage. Découvrez plus bas sur cette page quand cela peut être recommandé.

Trouver vos clés API

Vous pouvez afficher et gérer toutes les clés API de votre projet sur la page API et services > Identifiants de la console Google Cloud.

Vous pouvez également trouver la clé API automatiquement associée à une application Firebase aux emplacements suivants. Par défaut, toutes les applications Firebase de votre projet pour la même plate-forme (Apple, Android ou Web) utilisent la même clé API.

  • Applications Firebase pour Apple : recherchez la clé API mise en correspondance automatiquement dans le fichier de configuration Firebase, GoogleService-Info.plist, dans le champ API_KEY.

  • Applications Android Firebase : recherchez la clé API mise en correspondance automatiquement dans le fichier de configuration Firebase, google-services.json, dans le champ current_key.

  • Applications Web Firebase : recherchez la clé API mise en correspondance automatiquement dans l'objet de configuration Firebase, dans le champ apiKey.

Utiliser une clé API

Les clés API pour Firebase permettent d'identifier votre projet Firebase lorsque vous interagissez avec Firebase ou les services Google. Plus précisément, elles permettent d'associer les requêtes API à votre projet pour le quota et la facturation. Elles sont également utiles pour accéder aux données publiques.

Pour la grande majorité des développeurs et des cas d'utilisation, vous n'interagissez pas directement avec ces clés API. À la place, lorsque votre application appelle une API Firebase qui nécessite une clé API fournie par le client mobile ou Web, elle recherche automatiquement une clé API dans la configuration Firebase de votre application. Cette configuration a été ajoutée au codebase de votre application lorsque vous l'avez associée à Firebase.

Notez que vous pouvez fournir la clé API de votre application dans votre application à l'aide d'un autre mécanisme, comme les options Firebase ou les variables d'environnement.

De plus, pour certaines API REST des services Firebase, vous devrez peut-être transmettre explicitement la valeur de la clé API dans l'appel en tant que paramètre de requête. Cet exemple montre comment effectuer une requête à l'aide de l'API Firebase Authentication :

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=API_KEY

Examiner et appliquer les restrictions appropriées aux clés API

Pour toutes les clés API de votre projet, il est essentiel de vous assurer qu'elles sont soumises aux restrictions et limites d'API appropriées, comme décrit dans cette section.

Vérifier les API automatiquement ajoutées à la liste d'autorisation pour vos clés API Firebase

Lorsque Firebase crée une clé API dans votre projet, nous ajoutons automatiquement des restrictions d'API à cette clé. Les API ajoutées à cette liste d'autorisation sont des API liées à Firebase qui nécessitent que le client fournisse une clé API avec l'appel. Notez que la plupart des API requises pour utiliser les services Firebase n'ont pas besoin d'être ajoutées à la liste d'autorisation de vos clés API.

Étant donné que Firebase ajoute les API nécessaires pour tous les services Firebase, la liste d'autorisation d'une clé API peut inclure des API pour des produits que vous n'utilisez pas. Vous pouvez supprimer des API de la liste d'autorisation, mais vous devez veiller à ne pas supprimer les API requises pour Firebase et les services Firebase que vous utilisez (consultez la liste des API liées à Firebase qui doivent figurer sur la liste d'autorisation pour chaque service/produit). Sinon, vous obtiendrez des erreurs lors des appels aux services Firebase.

Réduire le quota si vous utilisez l'authentification Authentication basée sur un mot de passe

Si vous utilisez l'Firebase Authentication basée sur un mot de passe et que quelqu'un obtient votre clé API, il ne pourra pas accéder à la base de données de votre projet Firebase ni aux données Cloud Storage tant que ces données sont protégées par Firebase Security Rules. Toutefois, ils pourraient utiliser votre clé API pour accéder aux points de terminaison d'authentification de Firebase et envoyer des requêtes d'authentification à votre projet.

Pour limiter le risque qu'une personne utilise de manière abusive une clé API pour tenter une attaque par force brute, vous pouvez resserrer le quota par défaut des points de terminaison identitytoolkit.googleapis.com afin de refléter les attentes normales de trafic de votre application. Sachez que si vous resserrez ce quota et que votre application gagne soudainement des utilisateurs, vous risquez d'obtenir des erreurs de connexion jusqu'à ce que vous augmentiez le quota. Vous pouvez modifier les quotas d'API de votre projet dans la console Google Cloud.

Utilisez des clés API distinctes et restreintes pour tous les services non Firebase.

Bien que les clés API utilisées pour les services Firebase n'aient généralement pas besoin d'être traitées comme des secrets, vous devez prendre des précautions supplémentaires avec les clés API que vous utilisez avec d'autres API Google Cloud.

Si vous utilisez une API Google Cloud (sur n'importe quelle plate-forme) qui n'est pas destinée à un service ou produit Firebase, nous vous recommandons vivement de créer des clés API distinctes et restreintes pour ces API. Cela est d'une importance cruciale si l'API est destinée à un service Google Cloud facturable. En particulier, n'incluez jamais Gemini Developer API dans la liste d'autorisation d'une clé API accessible publiquement ou d'une clé utilisée pour d'autres services.

En utilisant des clés API distinctes et restreintes pour les API non-Firebase, vous pouvez effectuer une rotation ou remplacer les clés si nécessaire, et ajouter des restrictions supplémentaires aux clés API sans perturber votre utilisation des services Firebase.

Utiliser des clés API spécifiques à l'environnement

Si vous configurez différents projets Firebase pour différents environnements, tels que la préproduction et la production, il est important que chaque instance d'application interagisse avec le projet Firebase correspondant. Par exemple, votre instance d'application de préproduction ne doit jamais communiquer avec votre projet Firebase de production. Cela signifie également que votre application de préproduction doit utiliser des clés API associées à votre projet Firebase de préproduction.

Pour réduire les problèmes liés à la promotion des modifications de code du développement à la préproduction, puis à la production, au lieu d'inclure les clés API dans le code lui-même, définissez-les en tant que variables d'environnement ou incluez-les dans un fichier de configuration.

Questions fréquentes et dépannage

Questions fréquentes

Dépannage