Intergration Guide

Ce document est un guide d'intégration standard pour le SDK Web MA.

Préparatifs avant l'Intégration

Pour utiliser le service MA d'EngageLab, vous devez d'abord intégrer le module WebPush.
Préparez un nom de domaine de service web HTTPS accessible. Après l'intégration, les pages doivent être testées et déboguées sous ce nom de domaine. La notification push hors ligne web ne prend pas en charge le débogage local ni le HTTP.
Accédez à EngageLab WebPush, puis sur la page [Paramètres d'Intégration] - [Nom de Domaine du Site Web], renseignez le nom de domaine du service web HTTPS.

Screenshot 2022-11-29 11.08.16.png

Description du Produit

Le module MA du SDK Web EngageLab fournit des fonctions de collecte et de rapport de données, utilisées dans des scénarios tels que la génération d'EUID, la définition de propriétés utilisateur et le rapport d'événements.

Principaux Scénarios :

Définir différents types de propriétés et rapporter différents types d'événements.

Obtenir les Informations de l'Application

Vous devez créer une application sur la console WebPush. Après création, une AppKey sera générée automatiquement pour identifier cette application. Pour plus de détails, consultez le Document des Paramètres de l'Application.

Accès au SDK

Rendez-vous sur la Console, téléchargez le SDK et incluez le JavaScript sur chaque page :

              
              <script type="text/javascript" src="./webPushSdk.min.3.0.0.js"></script>

Afficher ce bloc de code dans la fenêtre flottante

Astuces

Après avoir importé ce JavaScript, transmettez la propriété maOpen avec la valeur true pour activer la configuration MA, ce qui vous permet d'utiliser les API et fonctions associées à MA.

Initialisation du SDK

// Initialisation (Activer MA) MTpushInterface.init({ appkey: "", // Obligatoire, voir ci-dessus pour les informations de l'application user_str: "adminDemo", // Obligatoire, identifiant utilisateur pour marquer l'utilisateur swUrl: "url", // Par défaut : "/sw.min." + sdkEnv.version + ".js". Cette configuration correspond à l'adresse du fichier service worker. Le domaine doit être le domaine actuel, et le chemin détermine le scope du service worker. debugMode: true,// Définir si le mode debug est activé. true affichera plus d'informations de log ; false n'affichera que les logs de niveau w et e. channel: "default-channel",// Nom du canal, valeur par défaut : default-channel appName: "string",// Sert à définir le nom du site web pour le reporting maOpen: true, // Bascule pour activer la fonction MA userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// Définir l'identité utilisateur lors de l'initialisation MA. Pris en charge depuis la v3.3.4, applicable aux entreprises fournissant des services MA exclusivement aux membres connectés maCompletion: (code, msg) => {// Callback d'initialisation MA if (code === 0) { console.log("✅SDK MA initialisé avec succès !"); } else { console.error("❌Échec de l'initialisation du SDK MA :", msg); } } });

              
              // Initialisation (Activer MA)
MTpushInterface.init({
  appkey: "", // Obligatoire, voir ci-dessus pour les informations de l'application
  user_str: "adminDemo", // Obligatoire, identifiant utilisateur pour marquer l'utilisateur
  swUrl: "url", // Par défaut : "/sw.min." + sdkEnv.version + ".js". Cette configuration correspond à l'adresse du fichier service worker. Le domaine doit être le domaine actuel, et le chemin détermine le scope du service worker.
  debugMode: true,// Définir si le mode debug est activé. true affichera plus d'informations de log ; false n'affichera que les logs de niveau w et e.
  channel: "default-channel",// Nom du canal, valeur par défaut : default-channel
  appName: "string",// Sert à définir le nom du site web pour le reporting
  maOpen: true, // Bascule pour activer la fonction MA
  userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// Définir l'identité utilisateur lors de l'initialisation MA. Pris en charge depuis la v3.3.4, applicable aux entreprises fournissant des services MA exclusivement aux membres connectés
  maCompletion: (code, msg) => {// Callback d'initialisation MA
        if (code === 0) {
          console.log("✅SDK MA initialisé avec succès !");
        } else {
          console.error("❌Échec de l'initialisation du SDK MA :", msg);
        }
  }
});