WalkMe-API

WalkMe-APIs können verwendet werden, nachdem der Code-Ausschnitt zu deiner Umgebung hinzugefügt wurde. Mithilfe von APIs kannst du WalkMe-Aktionen direkt in deine Website-Elemente integrieren, z. B. in eine Schaltfläche oder ein Dropdown-Menü.

APIs funktionieren gut in Situationen, in denen du versuchst, ein bereits vorhandenes Webseitenelement erneut zu verwenden. Der WalkMe-API-Aufruf, um das Player-Menü zu öffnen, kann in ein Hilfesymbol integriert werden, das nicht mehr verwendet wird oder auf eine alte Seite umleitet. Mithilfe der API kannst du deine Performance-Support-Optionen wie Walk-Thrus und Ressourcen in deine Seite integrieren. Die WalkMe-API kann Walk-Thrus auch mit vorhandenen Tooltips starten. Du kannst deine bestehenden Anleitungen durch Walk-Thrus ersetzen, die einfach zu aktualisieren sind.

Die WalkMe-API verwendet dieselben Aktionen wie der WalkMe- oder TeachMe-Player. Standardmäßig ruft WalkMe auf dem Server die Anzeige von WalkMe-Elementen ab. Die Verwendung der API entspricht der Aktion, bei der ein Walk-Thru vom Player-Menü aus gestartet wird, mit der Ausnahme, dass die Aktion in deiner Umgebung fest codiert ist. WalkMe kommuniziert weiterhin mit dem Server, um das Element selbst zu laden. Der Aufruf basiert jedoch auf einem Element auf deiner Seite.

WalkMe umfasst APIs, mit denen du eine Aktion, wie z. B. das Starten oder Stoppen eines Walk-Thrus, ausführen und Ereignisse überwachen kannst, die bestimmte Aktionen innerhalb von WalkMe markieren, wie das Öffnen und Schließen des Menüs.

Die Funktion walkme_ready()

Die Funktion walkme_ready() kann über die Skripts deiner Webseite / Anwendung zu dem Fenster hinzugefügt werden.

Sie kann wie folgt implementiert werden:

window.walkme_ready = function() {

// Funktionsimplementierung hier:

}

Wenn WalkMe deine Webseite / Anwendung vollständig geladen hat, wird die Funktion walkme_ready() aufgerufen und ausgeführt, um das zu tun, was du bei der Programmierung festgelegt hast.

Die WalkMe-API 

APIs können in Kombination mit Ereignissen verwendet werden.
Zum Beispiel können wir einen API-Aufruf verwenden, um einen Walk-Thru zu starten, nachdem das Menü geöffnet wurde:

window.walkme_player_event = function(event) {
      if (event.Type == "BeforeMenuOpen") {
         WalkMeAPI.startWalkthruByIndex(X)
   }
}

Mehrere Aurufe können zusammenarbeiten, um erweiterte Aktionen auszuführen. Zum Beispiel können wir überprüfen, ob das Menü offen ist, bevor es geöffnet wird:

if (WalkMePlayerAPI.isMenuOpen() == false) {
    WalkMePlayerAPI.toggleMenu();
}

WalkMe-API-Aufrufe

TeachMe-API-Aufrufe

Eingabe von APIs in der Konsole

WalkMe-APIs können getestet und verwendet werden, indem du sie in die Browserkonsole eingibst, während sich der Editor im Vorschaumodus befindet. Der Code-Ausschnitt muss in deiner Seite eingebettet sein oder der Editor muss geöffnet sein, damit APIs über die Konsole verwendet werden können. Du kannst beispielsweise überprüfen, wie viele Walk-Thrus derzeit in deiner Implementierung Live sind.

1. Öffne die Konsole, indem du die Taste F12 auf deiner Tastatur drückst.
2. Gib den API-Befehl in die Konsolen-Eingabezeile ein
   

Finden der Walk-Thru-ID und des Index

Die Walk-Thru-ID kann folgendermaßen gefunden werden:
1. Öffne den Walk-Thru
2. Öffne die Walk-Thru-Einstellungen
3. Öffne die erweiterten Einstellungen
4. Suche nach der Walk-Thru-ID

Walk-Thru und ID können auch per API-Befehl gefunden werden:  WalkMeAPI.getWalkthrus()
Diese API ruft alle veröffentlichten Walk-Thrus in der Umgebung ab und zeigt die ID und den Index an.

Arten von Ereignissen

Um auf ein WalkMe-Ereignis zu warten, füge im Fensterbereich eine Rückruffunktion hinzu. WalkMe versucht die Funktion jedes Mal aufzurufen, wenn ein Ereignis ausgelöst wird. Die Funktion muss vor dem Ereignis deklariert werden und kann sogar vor dem Laden von WalkMe in die Seite deklariert werden. Es gibt zwei verschiedene Funktionen, die zum Warten auf Ereignisse geschrieben werden können:

• window.walkme_player_event: Hier werden alle mit dem Menü verknüpften Ereignisse angezeigt
• window.walkme_event: Ereignisse, die sich auf WalkMe-Elemente und interne WalkMe-Funktionen beziehen

Im folgenden Beispiel warten wir darauf, dass ein Benutzer eine Aufgabe ausführt, bevor eine Warnung angezeigt wird.

var importantTaskId = 123456;
window.walkme_event = function(eventData) {
    if (eventData.Type === "SurveyCompleted") {
        if (eventData.ExtraData.TaskId == importantTaskId) {
            alert("Wichtige Aufgabe erledigt");
        }
    }
}

Wenn du auf mehrere Ereignisse warten möchtest, musst du dieselbe Funktion wie folgt ausführen

window.walkme_player_event = function(eventData) {
     if (eventData.Type === "BeforeMenuOpen") {
       console.log("Ich werde das Menü öffnen")
}

else if (eventData.Type === "AfterMenuOpen") {
     console.log("Ich habe dich gewarnt... Das Menü ist offen.");
   }
}