Découvrez comment utiliser et gérer les clés API pour Firebase.
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Une clé API est une chaîne unique qui permet d'acheminer les requêtes vers votre projet Firebase lorsque vous interagissez avec les services Firebase et Google. Cette page décrit des informations de base sur les clés API, ainsi que les bonnes pratiques à suivre pour les utiliser et les gérer avec les applications Firebase.
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 des services Firebase ne sont pas utilisées pour contrôler l'accès aux ressources backend. Cela ne peut être fait qu'avec Firebase Security Rules (pour contrôler les utilisateurs finaux pouvant accéder aux ressources) et Firebase App Check (pour contrôler les applications pouvant accéder aux ressources).
En règle générale, vous devez protéger minutieusement 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, vous pouvez inclure les clés API des services Firebase dans le code ou les fichiers de configuration enregistrés.
Vous pouvez afficher et gérer toutes les clés API de votre projet dans le panneau API et services > Identifiants de la console Google Cloud.
Vous pouvez également savoir quelle clé API est automatiquement associée à une application Firebase dans les 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 Apple Firebase : 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 permettent d'identifier votre projet Firebase lorsque vous interagissez avec les services Firebase/Google. Plus précisément, elles permettent d'associer des requêtes API à votre projet pour les quotas et la facturation. Elles sont également utiles pour accéder aux données publiques.
Par exemple, vous pouvez utiliser explicitement une clé API en transmettant sa valeur dans un appel d'API REST en tant que paramètre de requête. L'exemple suivant montre comment envoyer une requête à l'API Dynamic Links Link Shortener:
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=API_KEY
Lorsque votre application appelle une API Firebase qui nécessite une clé API fournie par le client mobile/Web, elle recherche automatiquement la clé API de votre projet dans le fichier/objet de configuration Firebase. Vous pouvez toutefois fournir des clés API pour votre application à l'aide d'un mécanisme différent, y compris des variables d'environnement.
Examiner et appliquer les restrictions appropriées aux clés API (recommandé)
Bien qu'il ne soit pas nécessaire de traiter une clé API pour les services Firebase comme un secret, vous devez examiner et appliquer les restrictions et les limites décrites 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 API à cette clé. Les API ajoutées à cette liste d'autorisation sont des API liées à Firebase qui exigent 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 sur la liste d'autorisation de vos clés API.
Étant donné que Firebase ajoute les API nécessaires à 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 faire très attention à ne pas supprimer les API requises pour Firebase et les services Firebase que vous utilisez (voir la liste des API liées à Firebase à ajouter à la liste d'autorisation pour chaque service / produit). Sinon, vous rencontrerez des erreurs lorsque vous appellerez les services Firebase.
Renforcer le quota si vous utilisez des Authentication basés sur un mot de passe
Si vous utilisez des Firebase Authentication basées sur un mot de passe et qu'un tiers s'empare de votre clé API, il ne pourra pas accéder à la base de données ou aux données Cloud Storage de votre projet Firebase tant que ces données sont protégées par Firebase Security Rules. Ils peuvent toutefois 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 réduire 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 qu'il reflète les attentes de trafic normal de votre application. Sachez que si vous resserrez ce quota et que votre application gagne soudainement des utilisateurs, vous risquez de rencontrer 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.
Utiliser des clés API distinctes et limitées pour tout service autre que Firebase
Bien que les clés API utilisées pour les services Firebase ne doivent généralement pas être traitées comme des éléments 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 ne concerne pas un service / produit Firebase, nous vous recommandons vivement de créer des clés API distinctes et limitées à utiliser avec ces API. Cela est particulièrement important si l'API est destinée à un service Google Cloud facturable.
Par exemple, si vous utilisez Firebase ML et les API Cloud Vision sur iOS, vous devez créer des clés API distinctes que vous n'utiliserez que pour accéder aux API Cloud Vision.
En utilisant des clés API distinctes et limitées pour les API autres que Firebase, vous pouvez faire pivoter 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.
Afficher les instructions pour créer des clés spécifiques à une API
Ces instructions décrivent comment créer une clé API distincte et limitée pour une API factice appelée Super Service API.
Étape 1: Configurez vos clés API existantes pour refuser l'accès à Super Service API
Ouvrez la page Identifiants de la console Google Cloud. Lorsque vous y êtes invité, sélectionnez votre projet.
Pour chaque clé API existante dans la liste, ouvrez la vue de modification.
Dans la section Restrictions relatives aux API, sélectionnez Restreindre la clé, puis ajoutez à la liste toutes les API auxquelles vous souhaitez que la clé API ait accès. Veillez à ne pas inclure l'API pour laquelle vous créez une clé API distincte (Super Service API dans cet exemple).
Lorsque vous configurez les restrictions d'API d'une clé API, vous déclarez explicitement les API auxquelles la clé a accès. Par défaut, lorsque l'option Ne pas restreindre la clé est sélectionnée dans la section Restrictions relatives aux API, une clé API peut être utilisée pour accéder à n'importe quelle API activée pour le projet.
Désormais, vos clés API existantes n'autoriseront plus l'accès à Super Service API, mais chacune d'elles continuera de fonctionner pour toutes les API que vous avez ajoutées à sa liste de restrictions d'API.
Étape 2: Créez et utilisez une clé API pour accéder à Super Service API
Revenez à la page Identifiants. Assurez-vous que votre projet Firebase est toujours sélectionné.
Cliquez sur Créer des identifiants > Clé API. Notez la nouvelle clé API, puis cliquez sur Restreindre la clé.
Dans la section Restrictions relatives aux API, sélectionnez Restreindre la clé, puis ajoutez à la liste seulementSuper Service API.
Cette nouvelle clé API n'accorde l'accès qu'à Super Service API.
Configurez votre application et vos services pour qu'ils utilisent la nouvelle clé API.
Utiliser des clés API spécifiques à l'environnement (recommandé)
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 son 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 les clés API associées à votre projet Firebase de préproduction.
Pour réduire les problèmes de promotion des modifications de code du développement à l'environnement de préproduction, puis à la production, au lieu d'inclure des 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.
Notez que si vous utilisez Firebase Local Emulator Suite pour le développement avec Firebase ML, vous devez créer et utiliser une clé API réservée au débogage. Pour savoir comment créer ce type de clé, consultez la documentation Firebase ML.
Questions fréquentes et dépannage
Questions fréquentes
Les clés API pour les services Firebase sont-elles limitées par défaut ?
Oui, par défaut, les restrictions d'API sont automatiquement appliquées à toutes les clés API que Firebase provisionne automatiquement pour les utiliser avec les API liées à Firebase. Consultez la liste des API liées à Firebase figurant sur cette liste d'autorisation.
Les API ajoutées à cette liste d'autorisation sont celles appelées par les services Firebase à partir du code client et qui nécessitent des clés API pour identifier votre projet ou application Firebase. Notez que la plupart des API requises pour utiliser les services Firebase n'ont pas besoin d'être ajoutées à la liste d'autorisation pour vos clés API.
Étant donné que Firebase ajoute les API nécessaires à 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 faire très attention à ne pas supprimer les API requises pour Firebase et les services Firebase que vous utilisez (voir la liste des API liées à Firebase à ajouter à la liste d'autorisation pour chaque service / produit). Sinon, vous rencontrerez des erreurs lorsque vous appellerez les services Firebase.
Vous pouvez afficher toutes vos clés API et leurs "restrictions API" dans le panneau API et services > Identifiants de la console Google Cloud.
Notez les points suivants concernant la façon dont Firebase applique ces "restrictions d'API":
À partir de mai 2024, toutes les nouvelles clés API provisionnées automatiquement par Firebase seront automatiquement limitées à la liste des API liées à Firebase.
En mai 2024, toutes les clés API existantes et non limitées que Firebase avait précédemment provisionnées automatiquement seront limitées à la liste des API liées à Firebaseet à toutes les API actuellement activées du projet.
Les clés API existantes et déjà limitées que Firebase avait précédemment provisionnées automatiquement n'ont pas été modifiées.
Aucune clé API existante qui n'a pas été provisionnée automatiquement par Firebase n'a été modifiée.
Comment déterminer la clé API associée à mon application Firebase ?
Vous pouvez utiliser l'une des options suivantes pour déterminer la clé API associée à votre application Firebase:
Console Firebase
Accédez à settingsParamètres du projet, puis faites défiler la fiche Vos applications vers le bas.
Sélectionnez l'application qui vous intéresse.
Obtenez le fichier/objet de configuration Firebase de l'application concernée, puis recherchez sa clé API:
Apple: téléchargez le GoogleService-Info.plist, puis recherchez le champ API_KEY.
Android: téléchargez le fichier google-services.json, recherchez la configuration de l'application de votre choix (recherchez son nom de package), puis recherchez le champ current_key.
Web: sélectionnez l'option Config (Configuration), puis recherchez le champ apiKey.
CLI Firebase
Obtenez le fichier/objet de configuration Firebase pour l'application concernée en exécutant la commande suivante:
firebase apps:sdkconfig PLATFORMFIREBASE_APP_ID
PLATFORM (l'un des éléments suivants): IOS | ANDROID | WEB
Dans la configuration Firebase imprimée de l'application, recherchez sa clé API:
Apple: recherchez le champ API_KEY.
Android: recherchez la configuration de l'application concernée (recherchez son nom de package), puis le champ current_key.
Web: recherchez le champ apiKey.
API REST
Obtenez le apiKeyId (UID) de la clé API en appelant le point de terminaison applicable pour l'application concernée, puis en transmettant la valeur apiKeyId à l'étape suivante.
Cette keyString est la même valeur que celle que vous pouvez trouver dans l'artefact de configuration de l'application (Apple | Android | Web).
Puis-je lister deux clés API pour la même application Firebase dans mon fichier/objet de configuration Firebase ?
Applications Apple Firebase : chaque application dispose de son propre fichier de configuration et ne peut comporter qu'une seule clé API.
Applications Android créées avec Firebase : toutes les applications Android du projet Firebase sont listées dans le même fichier de configuration, et chaque application ne peut avoir qu'une seule clé API listée. Toutefois, une clé différente peut être indiquée pour chaque application de ce fichier de configuration.
Applications Web Firebase : chaque application dispose de son propre objet de configuration et ne peut comporter qu'une seule clé API.
Vous pouvez toutefois utiliser plusieurs clés API avec une même application. Vous devez fournir un mécanisme permettant à votre application d'accéder à ces autres clés API, par exemple via une variable d'environnement. Le mécanisme d'accès aux autres clés API ne peut pas dépendre de leur présence dans votre fichier/objet de configuration Firebase.
Comment Firebase sait-il quelle clé API associer à une application (comme dans le fichier/objet de configuration Firebase) ?
Si Firebase ne trouve aucune clé restreinte correspondante, il répertorie dans le fichier/objet de configuration iOS key pour les applications Apple, Android key pour les applications Android et Browser key pour les applications Web (en supposant que ces clés existent et qu'elles ne comportent aucune "Restriction d'application" les empêchant de correspondre à cette application).
Puis-je supprimer manuellement la clé API et le champ de mon fichier/objet de configuration Firebase ?
Oui, vous pouvez supprimer manuellement votre clé API de votre fichier/objet de configuration. Toutefois, vous devez fournir un autre mécanisme pour que votre application puisse accéder à une clé API (par exemple, via une variable d'environnement). Sinon, tous les appels aux services Firebase échoueront.
Puis-je modifier manuellement mon fichier/objet de configuration Firebase avec différentes clés API ?
Oui, vous pouvez modifier manuellement un fichier/objet de configuration pour associer une autre clé API à une application.
Puis-je déplacer une clé API d'un projet Firebase à un autre ?
Non, une clé API n'identifie qu'un projet spécifique et ne peut pas être transférée vers un autre projet.
Que se passe-t-il si je supprime une clé API listée dans la console Google Cloud ?
Si vous supprimez une clé API utilisée par une application, les appels d'API de cette application échoueront. Vous pouvez recevoir des rapports, des e-mails ou des erreurs indiquant que vous essayez d'utiliser une clé API non valide.
La suppression d'une clé API est définitive et ne peut pas être annulée.
Quelles API sont requises dans la liste d'autorisation "Restrictions d'API" pour une clé API Firebase ?
Pour une clé API Firebase, les seules API qui doivent figurer sur la liste d'autorisation "Restrictions d'API" de la clé sont celles qui exigent que le client fournisse une clé API avec l'appel. Notez que très peu d'API liées à Firebase présentent cette exigence. La plupart des API liées à Firebase activées dans votre projet n'ont pas besoin d'être ajoutées à la liste d'autorisation "Restrictions API" de la clé.
Utilisez le tableau suivant pour déterminer les API liées à Firebase qui doivent être incluses dans la liste d'autorisation "Restrictions relatives aux API" d'une clé API Firebase. N'oubliez pas que les clés API Firebase ne doivent être utilisées que pour les services Firebase. Découvrez comment créer des clés API distinctes et limitées pour des types d'API spécifiques.
Vous pouvez afficher et gérer les clés API de votre projet dans le panneau API et services > Identifiants de la console Google Cloud.
* Obligatoire uniquement si vous utilisez la clé API Firebase avec des outils tiers ou un accès REST direct au service / produit Firebase.
** Obligatoire pour les versions antérieures du SDK du produit. Si vous utilisez la dernière version du SDK, l'API n'a pas besoin d'être sur la liste d'autorisation de la clé.
Dépannage
Comment corriger une erreur API_KEY_SERVICE_BLOCKED ou 403 Forbidden indiquant que les requêtes envoyées à cette API sont bloquées ?
Suivez les instructions de cette FAQ si une erreur API_KEY_SERVICE_BLOCKED ou une erreur semblable à celle-ci s'affiche:
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.
La clé API utilisée par votre application pour appeler l'API est probablement associée à des restrictions API, et la liste d'autorisation de la clé n'inclut pas cette API.
Si cette erreur s'affiche lorsque vous essayez d'utiliser un service autre que Firebase, nous vous recommandons vivement de créer une clé API spécifiquement pour ce service et cette API. Les clés API Firebase ne doivent être utilisées que pour les services / produits Firebase.
Découvrez comment créer des clés API distinctes et limitées pour des types d'API spécifiques.
Comment résoudre cette erreur ? "Échec de la récupération de l'ID de mesure de cette application Firebase sur le serveur."
La clé API utilisée par votre application Web est probablement associée à des restrictions API. Dans ce cas, assurez-vous que l'API Firebase Management figure dans la liste des API autorisées.
J'ai reçu un e-mail ou un message d'erreur indiquant que ma clé API n'est pas valide. Que s'est-il passé et comment résoudre ce problème ?
Voici quelques-unes des raisons les plus courantes pour lesquelles des clés API sont invalides:
La clé API est associée à des restrictions de clé API qui la rendent incompatible avec l'application qui tente de l'utiliser ("Restrictions liées aux applications") ou inutilisable pour l'API appelée ("Restrictions API").
La clé API a été supprimée du projet dans la console Google Cloud.
La clé API n'a pas été créée pour l'ID de projet indiqué dans le fichier/objet de configuration Firebase de l'application.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/21 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2024/11/21 (UTC)."],[],[]]
