Intergration Guide

Este documento es una guía de integración estándar para el SDK Web de MA.

Preparativos antes de la integración

Para utilizar el servicio EngageLab MA, se debe integrar primero el módulo WebPush.
Preparar un nombre de dominio de servicio web HTTPS accesible. Tras la integración, es necesario probar y depurar las páginas bajo este nombre de dominio. El push web sin conexión no admite depuración local ni HTTP.
Acceder a EngageLab WebPush y, en la página [Ajustes de integración] - [Nombre de dominio del sitio web], completar el nombre de dominio del servicio web HTTPS.

Screenshot 2022-11-29 11.08.16.png

Descripción del producto

El módulo MA en el SDK Web de EngageLab proporciona funciones de recopilación y envío de datos, que se utilizan en escenarios como la generación de EUID, la configuración de propiedades de usuario y el registro de eventos.

Escenarios principales:

Configurar diversos tipos de propiedades y registrar diversos tipos de eventos.

Obtener información de la aplicación

Se debe crear una aplicación en la consola de WebPush. Tras la creación correcta, se generará automáticamente una AppKey para identificar esta aplicación. Para obtener más información, consultar el documento de configuración de la aplicación.

Acceso al SDK

Acceder a la consola, descargar el SDK e incluir el JavaScript en cada página:

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

Este bloque de código se muestra en una ventana flotante

Consejos

Tras importar este JavaScript, pasar la propiedad maOpen con el valor true para habilitar la configuración de MA, lo que permite utilizar las API y funciones correspondientes de MA.

Inicialización del SDK

// Initialization (Enable MA) MTpushInterface.init({ appkey: "", // Required, see above for application information user_str: "adminDemo", // Required, user identifier to mark the user swUrl: "url", // Default: "/sw.min." + sdkEnv.version + ".js". This configuration is the server worker file address. The domain must be the current domain, and the path determines the server worker scope. debugMode: true,// Set whether to enable debug mode. true will print more log information; false will only output logs of level w and e. channel: "default-channel",// Channel name, default value: default-channel appName: "string",// Used to set the website name for reporting maOpen: true, // Toggle to enable MA function userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// Set user identity during MA initialization. Supported since v3.3.4, applicable for enterprises providing MA services exclusively to logged-in members maCompletion: (code, msg) => {// MA initialization callback if (code === 0) { console.log("✅MA SDK initialized successfully!"); } else { console.error("❌MA SDK initialization failed:", msg); } } });

              
              // Initialization (Enable MA)
MTpushInterface.init({
  appkey: "", // Required, see above for application information
  user_str: "adminDemo", // Required, user identifier to mark the user
  swUrl: "url", // Default: "/sw.min." + sdkEnv.version + ".js". This configuration is the server worker file address. The domain must be the current domain, and the path determines the server worker scope.
  debugMode: true,// Set whether to enable debug mode. true will print more log information; false will only output logs of level w and e.
  channel: "default-channel",// Channel name, default value: default-channel
  appName: "string",// Used to set the website name for reporting
  maOpen: true, // Toggle to enable MA function
  userIdentity: { userId: "1234567890", anonymousId: "anonymous123" },// Set user identity during MA initialization. Supported since v3.3.4, applicable for enterprises providing MA services exclusively to logged-in members
  maCompletion: (code, msg) => {// MA initialization callback
        if (code === 0) {
          console.log("✅MA SDK initialized successfully!");
        } else {
          console.error("❌MA SDK initialization failed:", msg);
        }
  }
});