Aperçu rapide

Autorisez les services externes à créer, modifier, supprimer ou utiliser les données des segments WalkMe existantes. Cette intégration permet une segmentation du contenu automatisée, un filtrage avancé dans Insights et des rapports rationalisés.

Par exemple : utilisez Heap Analyses pour créer un nouveau segment et afficher un ShoutOut basé sur cette logique de segmentation.

Jetons d'accès d'authentification

Un jeton d'accès est un identifiant utilisé par une application pour accéder à une API. Il informe le système que le porteur est autorisé à effectuer des actions spécifiques, telles que le transfert de données d'un système externe au Menu WalkMe.

Créer un jeton d'accès

1. Allez au Centre d'administration
2. Ouvrez la page des clés d'API
3. Sélectionnez Créer une nouvelle clé
4. Dans le panneau Créer une nouvelle clé :
   1. Nommez la clé (indiquez son objectif pour vous aider à vous souvenir plus tard)
   2. Activez l'API des segments
   3. Sélectionnez Écrire et lire dans la liste déroulante
   4. Sélectionnez Créer
5. Dans le panneau Détails de la clé, copiez l'ID du client et le secret du client

Configuration de la connexion API

Utilisez les informations universellement nécessaires suivantes pour configurer votre application de connexion :

• URL : https://api.walkme.com/accounts/connect/token
• Méthode : POST
• Type de charge utile : application/x-www-form-urlencoded
• Données : grant_type client_credentials
• Authentification de base : saisissez l'ID du client et le secret du client copiés à partir du Centre Admin

Une fois que vous avez ajouté ces informations, le système générera un jeton d'accès.

1. Copiez votre jeton d'accès.
2. Utilisez ce jeton pour gérer les segments

Exemple de demande cURL

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <Identifiants>' \
--data-urlencode 'grant_type=client_credentials'
# <Identifiants> est l'encodage base64 de la clé du consommateur et du secret du consommateur du compte WalkMe joints par deux-points.

{ "access_token": "asdjkldfsjsdfhjksfdhjkxvc32cvhjhjksefbnxjnweuirou8sdfg8xdfjwkjr.sv8o8vuisuhvseuksfe",
 "expires_in" : 86400,
 "token_type" : "Bearer",
 "scope": "segments:write segments:read"
}

Référence du point de terminaison

Créer un segment

Créez un nouveau segment basé sur une liste statique d'utilisateurs.

• Méthode : POST
• URL : https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• En-têtes : Authorization: Bearer <Access Token>
• Paramètres d'URL : systemGuid (trouvé dans l'Éditeur WalkMe dans le snippet)
• Charge utile / Corps : {"id": "<external id>", "name": "<WalkMe Segment Name>", "userIds": ["user1@company.com", "user2@company.com"]}
• Limitations :
  • Maximum de 25 000 utilisateurs par demande
  • Maximum de 100 caractères par valeur d'ID

Mettre à jour un segment

Modifier les utilisateurs dans un segment existant.

• Méthode : PUT
• URL : https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
• En-têtes : Authorization: Bearer <Access Token>
• Paramètres d'URL :
  • systemGuid : GUID du système WalkMe
  • segmentGuid : le GUID du segment spécifique (doit inclure des tirets, par exemple : 12345aeb-123c-4d83-8b38-a5a456789d0a)
• Paramètres de charge utile :
  • userIds : liste des identifiants à modifier (limite de 25 000)
  • action : spécifiez ajouter, supprimer ou remplacer
• Exemple de charge utile : {"action": "add", "userIds": ["jane.doe@walkme.com"]}

{ "action": <enum("add"|"remove"|"override")>, "userIds" : [<Chaîne>] }

Obtenir des segments

Récupérez une liste des segments existants.

• Méthode : GET
• URL : https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• En-têtes : Authorization: Bearer <Access Token>
• Paramètres d'URL : systemGuid

Supprimer les segments

Supprimer définitivement un segment.

• Méthode : DELETE
• URL : https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}
• En-têtes : Authorization: Bearer <Access Token>
• Paramètres d'URL : segmentId (l'ID du segment cible)

Supprimer <a target="_blank" data-stringify-link="https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}" delay="150" data-sk="tooltip_parent" href="https://api.walkme.com/public/v1/user/system/%7BsystemGuid%7D/segment/%7BsegmentId%7D" rel="noopener noreferrer">https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}</a>

Notes techniques

• Il faut jusqu'à 10 minutes pour qu'un nouveau segment apparaisse dans le générateur de conditions de l'éditeur
• Pour utiliser votre segment, ouvrez le générateur de conditions et sélectionnez Attributs d'utilisateur, puis Segment externe, puis votre nom de segment
  • Utilisez uniquement Est ou N'est pas comme opérateur et tapez True dans le champ de saisie
• WalkMe n'affiche actuellement pas les utilisateurs qui ont été synchronisés dans le cadre de cette intégration.