Qu'est-ce qu'Event Notifications ?

Event Notifications est un service de routage de notifications d'événements qui vous informe des événements critiques qui se produisent dans votre compte IBM Cloud ou qui déclenche des actions automatisées à l'aide de webhooks. Vous pouvez filtrer et acheminer les notifications d'événements provenant de services IBM Cloud tels que Availability Monitoring, vers des courriels, des SMS, des notifications push et des webhooks.

Comment les clients utilisent-ils les notifications push Firefox Web ?

Le diagramme suivant montre comment les clients utilisent les notifications push Firefox Web.

Objectifs

Ce tutoriel explique comment envoyer des notifications push comme suit :

• Créez un site Web avec Event Notifications.
• Obtenez les données d'identification Firefox Web.
• Téléchargez le SDK et effectuez la configuration des notifications.
• Configurez et envoyez des notifications push Firefox Web à un navigateur.

Création d'une instance de service Event Notifications

• Connectez-vous à votre compte IBM Cloud.
• Dans le catalogue IBM Cloud, recherchez Event Notifications > Event Notifications.
• Sélectionnez une Region dans la liste des régions prises en charge et sélectionnez une pricing plan.
• Fournissez un Service name.
• Sélectionner resource group.
• Acceptez les contrats de licence et les dispositions en cochant la case.
• Cliquez sur Create.

Ajouter une source d'API générique

Suivez ces étapes :

• Accédez à la section Sources du tableau de bord Event Notifications.
• Cliquez sur Add et sélectionnez une source d'API.
• Entrez un nom et une description facultative, puis cliquez sur Add.

Créer une destination Event Notifications

Cliquez sur Destinations dans la console Event Notifications et ajoutez les détails de destination suivants :

• Name : ajoutez un nom pour la destination.
• Description : ajoutez une description facultative pour la destination.
• Type: sélectionnez Firefox Push Notifications type dans la liste déroulante.
• Sélectionnez un plan de destination: Destination de préproduction ou Destination de production.
  • Pre-production destination-sélectionnez cette destination comme destination d'envoi à faible coût, pour vos environnements de développement et de test.
  • Production destination-utilise toutes les fonctionnalités de cette destination. Nombre illimité de dispositifs et de messages sortants autorisés.
• Indiquez l'URL de votre site Web.
• Cliquez sur Ajouter.
• Une fois la destination Firefox créée, procédez comme suit. Modifiez la destination créée pour obtenir public vapId key requis pour le sdk web.

Créer une Event Notifications rubrique

Sélectionnez Topics dans la console Event Notifications, puis cliquez sur Create. Entrez les détails de la rubrique suivante :

• Name : entrez un nom pour la rubrique.
• Description : ajoutez une description facultative pour le sujet.
• Source : sélectionnez une source dans la liste déroulante.
• Event type : sélectionnez le type d'événement dans la liste déroulante.
• Event sub type : sélectionnez le sous-type d'événement dans la liste déroulante du sous-type d'événement.
• Severity : sélectionnez la gravité dans la liste déroulante de gravité.
• Advanced conditions : écrivez vos propres conditions personnalisées, qui doivent suivre les spécifications jsonpath. Les expressions Jsonpath peuvent être validées à jsonpath.com ou extendsclass.com.

Créer un Event Notifications abonnement

Cliquez sur Subscriptions dans la console Event Notifications. Entrez les détails suivants sur l'abonnement :

• Cliquez sur Click pour afficher l'assistant d'abonnement.
• Complétez les détails de l'abonnement suivants :
  • Subscription name : nom de l'abonnement.
  • Subscription description : ajout d'une description facultative.
• Sous la section Subscribe to a topic, sélectionnez une rubrique dans la liste déroulante et une destination dans la liste déroulante de destination.
• Destination type : sélectionnez un type sous Destination et cliquez sur Add.

Configurer le SDK Firefox Web Event Notifications

Le SDK Firefox Web permet aux sites Web Firefox de recevoir des notifications push. Procédez comme suit pour installer le SDK Firefox Web Event Notifications, initialiser le SDK et sélectionner l'envoi de notifications pour votre site Web.

• Pour inclure le SDK dans votre projet, ajoutez les fichiers ENPushSDK.js,ENPushServiceWorker.js et manifest_Website.json à votre dossier racine de projet.

• Modifiez le fichier manifest_Website.json.

  {
     "name": "YOUR_WEBSITE_NAME"
  }
  

• Changez le nom de fichier manifest_Website.json en manifest.json.

• Incluez le manifest.json dans la balise <head> de votre fichier html.

  <link rel="manifest" href="https://github.com/IBM/event-notifications-destination-webpush-sdk/blob/main/manifest_Website.json">
  

• Inclure IBM Cloud web push SDK dans le script.

  <script src="https://github.com/IBM/event-notifications-destination-webpush-sdk/blob/main/ENPushSDK.js" async></script>
  

• Effectuez les étapes suivantes pour permettre au site web d'initialiser le SDK.

  var enPush = new ENPush()
  
  function callback(response) {
     alert(response.response)
  }
  
  var initParams = {
     "instanceGUID": "<instance_guid>",
     "apikey": "<instance_apikey>",
     "region": "<region>",
     "deviceId": "<YOUR_DEVICE_ID>",
     "firefoxDestinationId": "<firefox_destination_id>",
     "firefoxApplicationServerKey": "<Firefox_VapId_public_key>"
  }
  
  enPush.initialize(initParams, callback)
  

  • region: région de l'instance Event Notifications. par exemple us-south,eu-gb, au-syd, eu-de et eu-es.

  • deviceId: facultatif deviceId pour l'enregistrement d'appareil.

• Pour s'inscrire aux notifications, utilisez l'API register() ou registerWithUserId() pour enregistrer l'appareil auprès du service IBM Cloud Event Notifications. Sélectionnez l'une des options suivantes :

  • S'enregistrer sans UserId :

    enPush.register(function(response) {
       alert(response.response)
    })
    

  • Inscrivez-vous sur UserId. Pour les notifications basées sur userId, la méthode d'enregistrement acceptera un paramètre supplémentaire - userId.

    bmsPush.registerWithUserId("UserId",function(response) {
       alert(response.response)
    })
    

    UserId est la valeur de l'identificateur utilisateur avec lequel vous souhaitez enregistrer les périphériques dans l'instance de service push.

• L'API subscribe abonne le périphérique à une balise. Une fois que le périphérique est abonné à une balise particulière, il peut recevoir des notifications envoyées pour cette balise. Ajoutez le fragment de code suivant à votre application Web pour vous abonner à une liste de balises.

  enPush.subscribe(tagName, function(response) {
     alert(response.response)
  })
  

• Une fois la configuration terminée, exécutez votre application et enregistrez pour les notifications push.

Envoyer des notifications au périphérique Firefox

Utilisez l'API d'envoi de notifications pour envoyer la notification push pour le périphérique Firefox. Vous pouvez utiliser le SDK d'administration Nœud ou Go au lieu d'appeler directement l'API.