Check out what’s new from Firebase@ Google I/O 2021, and join our alpha program for early access to the new Remote Config personalization feature. Learn more

Configurer une application cliente JavaScript Firebase Cloud Messaging

L'API JavaScript FCM vous permet de recevoir des messages de notification dans les applications Web exécutées dans des navigateurs prenant en charge l' API Push . Cela inclut les versions de navigateur répertoriées dans cette matrice de prise en charge et les extensions Chrome via l'API Push.

Le SDK FCM est pris en charge uniquement dans les pages diffusées via HTTPS. Cela est dû à son utilisation de service workers, qui ne sont disponibles que sur les sites HTTPS. Si vous avez besoin d'un fournisseur, Firebase Hosting est recommandé pour un hébergement HTTPS gratuit sur votre propre domaine.

Pour commencer avec l'API JavaScript FCM, vous devez ajouter Firebase à votre application Web et ajouter une logique pour accéder aux jetons d'enregistrement.

Ajouter Firebase à votre projet JavaScript

Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet JavaScript .

Si vous utilisez actuellement FCM pour le Web et souhaitez effectuer une mise à niveau vers le SDK 6.7.0 ou une version ultérieure, vous devez activer l' API d'enregistrement FCM pour votre projet dans Google Cloud Console. Lorsque vous activez l'API, assurez-vous d'être connecté à Cloud Console avec le même compte Google que celui que vous utilisez pour Firebase et assurez-vous de sélectionner le bon projet. Les nouveaux projets ajoutant le SDK FCM ont cette API activée par défaut.

Configurer les informations d'identification Web avec FCM

L'interface Web FCM utilise des informations d'identification Web appelées « Identification volontaire du serveur d'applications » ou « VAPID » pour autoriser l'envoi de demandes aux services Web Push pris en charge. Pour abonner votre application aux notifications push, vous devez associer une paire de clés à votre projet Firebase. Vous pouvez soit générer une nouvelle paire de clés, soit importer votre paire de clés existante via la console Firebase.

Générer une nouvelle paire de clés

  1. Ouvrez l'onglet Cloud Messaging du volet Paramètres de la console Firebase et faites défiler jusqu'à la section Configuration Web .
  2. Dans l'onglet Certificats Web Push , cliquez sur Générer une paire de clés . La console affiche un avis indiquant que la paire de clés a été générée et affiche la chaîne de clé publique et la date d'ajout.

Importer une paire de clés existante

Si vous utilisez déjà une paire de clés existante avec votre application Web, vous pouvez l'importer dans FCM afin de pouvoir accéder à vos instances d'application Web existantes via les API FCM. Pour importer des clés, vous devez disposer d'un accès de niveau propriétaire au projet Firebase. Importez votre clé publique et privée existante sous une forme codée sécurisée en base64 :

  1. Ouvrez l'onglet Cloud Messaging du volet Paramètres de la console Firebase et faites défiler jusqu'à la section Configuration Web .
  2. Dans l'onglet Certificats Web Push , recherchez et sélectionnez le texte du lien « importer une paire de clés existante ».
  3. Dans la boîte de dialogue Importer une paire de clés , indiquez vos clés publique et privée dans les champs correspondants et cliquez sur Importer . La console affiche la chaîne de clé publique et la date d'ajout.

Pour obtenir des instructions sur l'ajout de la clé à votre application, consultez Configurer les informations d'identification Web dans votre application . Pour plus d'informations sur le format des clés et sur la manière de les générer, consultez Clés du serveur d'applications .

Récupérer un objet de messagerie

Web v8

const messaging = firebase.messaging();

Web v9

import { getMessaging } from "firebase/messaging";

const messaging = getMessaging();

Configurer les informations d'identification Web dans votre application

La méthode getToken(): Promise<string> permet à FCM d'utiliser les informations d'identification de la clé VAPID lors de l'envoi de demandes de message à différents services push. À l'aide de la clé que vous avez générée ou importée conformément aux instructions de Configurer les informations d'identification Web avec FCM , ajoutez-la dans votre code une fois l'objet de messagerie récupéré :

// Add the public key generated from the console here.
messaging.getToken({vapidKey: "BKagOny0KF_2pCJQ3m....moL0ewzQ8rZu"});

Accéder au jeton d'inscription

Lorsque vous devez récupérer le jeton d'enregistrement actuel pour une instance d'application, appelez getToken . Si l'autorisation de notification n'a pas été accordée, cette méthode demandera à l'utilisateur des autorisations de notification. Sinon, il renvoie un jeton ou rejette la promesse en raison d'une erreur.

Le service de messagerie nécessite un firebase-messaging-sw.js . À moins que vous n'ayez déjà un firebase-messaging-sw.js , créez un fichier vide avec ce nom et placez-le à la racine de votre domaine avant de récupérer un jeton. Vous pouvez ajouter un contenu significatif au fichier ultérieurement au cours du processus de configuration du client.

Pour récupérer le jeton actuel :

Web v8

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
messaging.getToken({ vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});

Web v9

import { getMessaging, getToken } from "firebase/messaging";

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
const messaging = getMessaging();
getToken(messaging, { vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});

Une fois que vous avez obtenu le jeton, envoyez-le à votre serveur d'applications et stockez-le en utilisant votre méthode préférée.

Prochaines étapes

Une fois les étapes de configuration terminées, voici quelques options pour continuer avec FCM pour le Web (JavaScript) :