Aperçu rapide
L'API Segments permet aux services externes de créer, de mettre à jour, de récupérer et de supprimer les segments WalkMe par programmation. Utilisez-la pour automatiser la segmentation du contenu, appliquer un filtrage avancé dans Insights et rationaliser la création de rapports.
Par exemple, vous pouvez utiliser Heap Analyses pour créer un segment et déclencher un ShoutOut en fonction de cette logique de segmentation. le Sh
Fonction activée
C'est une fonctionnalité activée. Pour demander l'accès, soumettez une demande via le canal d'assistance approprié :
- Clients WalkMe : dans le portail d'assistance, sélectionnez Activer ou configurer une fonctionnalité WalkMe et incluez l'API des Segments dans la description
- Clients SAP : dans ServiceNow, sélectionnez le composant de ticket de fonctionnalités du WalkMe Admin Center et incluez l'API des Segments dans la description
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
- Ouvrez la console WalkMe
- Accédez à la catégorie Admin
- Sélectionnez Gestion des accès, puis Clés API
- Sélectionnez Créer une nouvelle clé
- Tapez un nom pour la clé qui indique son objectif le nom
- Activez l'API des segments
- Sélectionnez Écrire et lire dans la liste déroulante
- Sélectionnez Créer
- Dans le panneau Détails de la clé, copiez l'ID du client et le secret du client
Enregistrez le secret du client
Vous ne verrez plus le Secret. Enregistrez-le dans un emplacement sécurisé et accessible immédiatement
Configuration de la connexion API
Pour obtenir votre jeton d'autorisation, reportez-vous à la référence Obtenir un jeton d'autorisation sur le Hub de développement.
Utilisez les détails suivants pour configurer votre 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 : tapez l'ID du client et le secret du client copiés à partir de la page Clés API
Le système génère un jeton d'accès après que vous avez soumis la demande. Copiez le jeton et utilisez-le 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
- Le nouveau segment peut prendre jusqu'à 10 minutes pour apparaître dans le générateur de conditions
- WalkMe n'affiche pas les utilisateurs qui ont été synchronisés via cette intégration
- Pour utiliser votre segment dans l'Éditeur WalkMe, ouvrez le Générateur de conditions et sélectionnez Attributs utilisateur, puis External-Segment, puis le nom de votre segment. Utilisez uniquement Est ou N'est pas comme opérateur et tapez True dans le champ de saisie
