API WalkMe

Vous pouvez utiliser les APIs WalkMe après avoir ajouté le snippet à votre environnement. Les APIs vous aideront à intégrer des actions WalkMe directement sur des éléments de votre site Web, tels qu'un bouton ou un menu déroulant.

Les APIs fonctionnent très bien dans les situations dans lesquelles vous essayez de réaffecter un élément de site Web existant. L'invitation de l'API WalkMe à ouvrir le menu lecteur peut être intégrée dans une icône d'aide qui n'est plus utilisée ou qui redirige vers une ancienne page. Grâce à l'API, vous pouvez intégrer vos options d'assistance aux performances telles que les walk-thrus et les ressources dans votre site. L'API WalkMe peut également démarrer les walk-thrus avec des info-bulles existantes. Vous pouvez remplacer vos conseils actuels par des walk-thrus faciles à mettre à jour.

L'API WakMe utilise les mêmes actions que le lecteur WalkMe ou TeachMe. Par défaut, WalkMe invite le serveur à afficher les éléments WalkMe. L'utilisation d'une API équivaut à l'action de démarrage d'un walk-thru à partir du menu lecteur, sauf si l'action est codée en dur sur votre environnement. WalkMe communique toujours avec le serveur pour charger l'élément lui-même, mais l'invitation est basée sur un élément de votre site Web.

WalkMe inclut des APIs qui vous permettent d'effectuer une action, telle que démarrer ou arrêter un Walk-Thru, et de contrôler les événements marquant une action spécifique dans WalkMe, comme l'ouverture et la fermeture de menus.

La fonction walkme_ready ()

La fonction walkme_ready () peut être ajoutée à la fenêtre via les scripts de votre site Web/application.

Elle peut être implémentée comme suit :

window.walkme_ready = function () {

// implémentation de la fonction ici :

}

Lorsque WalkMe est complètement chargé sur votre site Web/votre application, la fonction walkme_ready () est appelée et exécutée pour faire tout ce pour quoi vous l'avez programmée.

L'API WalkMe 

Les APIs peuvent être utilisées en combinaison avec des événements.
Par exemple, on peut utiliser une invitation d'API pour démarrer un walk-thru après l'ouverture du menu :

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

Plusieurs invitations peuvent fonctionner ensemble pour effectuer des actions plus avancées. Par exemple, on peut vérifier que le menu est ouvert avant de l'ouvrir :

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

Invitations d'API WalkMe

Invitations de l'API TeachMe

Saisie d'APIs dans la console

Vous pouvez tester et utiliser les APIs WalkMe en les entrant dans la console du navigateur lorsque l'éditeur est en mode « Aperçu ». Le snippet doit être intégré sur votre site ou bien l'éditeur doit être ouvert pour pouvoir utiliser les APIs via la console. Par exemple, vous pouvez vérifier combien de walk-thrus sont actuellement en direct sur votre implémentation.

1. Ouvrez la console en appuyant sur F12 sur votre clavier.
2. Entrez la commande API dans la ligne de saisie de la console.
   

Trouver l'ID et l'index walk-thru

Vous pouvez trouver l'ID walk-thru en procédant comme ci-dessous :
1. Ouvrez le walk-thru
2. Ouvrez les paramètres du walk-thru
3. Ouvrez les paramètres avancés
4. Trouvez l'ID du walk-thru

Vous pouvez également trouver le walk-thru et son identifiant avec la commande API :  WalkMeAPI.getWalkthrus ()
Cette API récupère tous les walk-thrus publiés dans l'environnement et renvoie l'identifiant et l'index.

Types d'évènements

Pour écouter un événement WalkMe, incluez une fonction de rappel dans le champ de la fenêtre. WalkMe essaiera d'appeler la fonction chaque fois qu'un événement est déclenché. La fonction doit être définie avant que l'événement ne se produise et peut être définie avant même que WalkMe ne soit chargé sur la page. Deux fonctions différentes peuvent être écrites pour écouter les événements :

• window.walkme_player_event : tous les événements associés au menu seront affichés.
• window.walkme_event : événements liés aux éléments WalkMe et aux fonctionnalités internes de WalkMe

Dans l'exemple ci-dessous, nous attendons qu'un utilisateur finisse d'exécuter une tâche avant d'afficher une alerte.

var importantTaskId = 123456;
window.walkme_event = function (eventData) {
    if (eventData. Type === "SurveyCompleted") {
        if (eventData.ExtraData.TaskId == importantTaskId) {
            alerte ("Important task completed") ;
        }
    }
}

Si vous avez besoin d'écouter plusieurs événements, vous devez le faire dans la même fonctionnalité, comme suit :

window.walkme_player_event = function (eventData) {
     if (eventData. Type === "BeforeMenuOpen") {
       console.log ("I'm about to open the menu")
}

else if (eventData. Type === "AfterMenuOpen") {
     console.log ("I warned you... the menu is open.") ;
   }
}