Intergration Guide

Dieses Dokument ist ein Standard-Integrationsleitfaden für das MA Web SDK.

Vorbereitungen vor der Integration

Um den EngageLab MA-Service zu nutzen, müssen Sie zunächst das WebPush-Modul integrieren.
Stellen Sie eine erreichbare HTTPS-Webdienst-Domain bereit. Nach der Integration müssen die Seiten unter dieser Domain getestet und debuggt werden. Web-Offline-Push unterstützt kein lokales Debugging und kein HTTP.
Öffnen Sie EngageLab WebPush und tragen Sie auf der Seite [Integrationseinstellungen] – [Website-Domainname] die HTTPS-Webdienst-Domain ein.

Screenshot 2022-11-29 11.08.16.png

Produktbeschreibung

Das MA-Modul im EngageLab Web SDK bietet Funktionen zur Datenerfassung und -berichterstattung, die in Szenarien wie EUID-Generierung, Setzen von Benutzereigenschaften und Ereignisberichterstattung eingesetzt werden.

Hauptszenarien:

Eigenschaften festlegen und Ereignisse melden.

Anwendungsinformationen erhalten

Sie müssen eine Anwendung über die WebPush-Konsole erstellen. Nach erfolgreicher Erstellung wird automatisch ein AppKey generiert, der die Anwendung eindeutig identifiziert. Weitere Informationen finden Sie im Dokument zu den Anwendungseinstellungen.

SDK-Zugriff

Gehen Sie zur Konsole, laden Sie das SDK herunter und fügen Sie das JavaScript auf jeder Seite ein:

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

Diesen Codeblock im schwebenden Fenster anzeigen

Hinweise

Nachdem Sie dieses JavaScript eingebunden haben, übergeben Sie die Eigenschaft maOpen mit dem Wert true, um die MA-Konfiguration zu aktivieren. Dadurch können Sie die relevanten APIs und Funktionen von MA nutzen.

SDK-Initialisierung

// Initialisierung (MA aktivieren) MTpushInterface.init({ appkey: "", // Erforderlich, siehe oben für Anwendungsinformationen user_str: "adminDemo", // Erforderlich, Benutzerkennung zur Identifizierung des Benutzers swUrl: "url", // Standard: "/sw.min." + sdkEnv.version + ".js". Diese Konfiguration gibt die Adresse der Service-Worker-Datei an. Die Domain muss die aktuelle Domain sein, wobei der Pfad den Geltungsbereich des Service Workers festlegt. debugMode: true, // Legt fest, ob der Debug-Modus aktiviert wird. true gibt mehr Log-Informationen aus; false gibt nur Logs der Warn- und Fehlerstufe aus. channel: "default-channel", // Kanalname, Standard: default-channel appName: "string", // Wird verwendet, um den Website-Namen für die Berichterstattung zu setzen maOpen: true, // Schalter zur Aktivierung der MA-Funktionen userIdentity: { userId: "1234567890", anonymousId: "anonymous123" }, // Legt die Benutzeridentität während der MA-Initialisierung fest. Unterstützt ab v3.3.4; geeignet für Unternehmen, die MA-Dienste ausschließlich für eingeloggte Mitglieder bereitstellen. maCompletion: (code, msg) => { // Rückmeldung zur MA-Initialisierung if (code === 0) { console.log("✅MA SDK erfolgreich initialisiert!"); } else { console.error("❌MA SDK-Initialisierung fehlgeschlagen:", msg); } } });

              
              // Initialisierung (MA aktivieren)
MTpushInterface.init({
  appkey: "", // Erforderlich, siehe oben für Anwendungsinformationen
  user_str: "adminDemo", // Erforderlich, Benutzerkennung zur Identifizierung des Benutzers
  swUrl: "url", // Standard: "/sw.min." + sdkEnv.version + ".js". Diese Konfiguration gibt die Adresse der Service-Worker-Datei an. Die Domain muss die aktuelle Domain sein, wobei der Pfad den Geltungsbereich des Service Workers festlegt.
  debugMode: true, // Legt fest, ob der Debug-Modus aktiviert wird. true gibt mehr Log-Informationen aus; false gibt nur Logs der Warn- und Fehlerstufe aus.
  channel: "default-channel", // Kanalname, Standard: default-channel
  appName: "string", // Wird verwendet, um den Website-Namen für die Berichterstattung zu setzen
  maOpen: true, // Schalter zur Aktivierung der MA-Funktionen
  userIdentity: { userId: "1234567890", anonymousId: "anonymous123" }, // Legt die Benutzeridentität während der MA-Initialisierung fest. Unterstützt ab v3.3.4; geeignet für Unternehmen, die MA-Dienste ausschließlich für eingeloggte Mitglieder bereitstellen.
  maCompletion: (code, msg) => { // Rückmeldung zur MA-Initialisierung
        if (code === 0) {
          console.log("✅MA SDK erfolgreich initialisiert!");
        } else {
          console.error("❌MA SDK-Initialisierung fehlgeschlagen:", msg);
        }
  }
});