Kurzübersicht

Ermöglichen Sie externen Diensten, Daten vorhandener WalkMe-Segmente zu erstellen, zu bearbeiten, zu löschen oder zu verwenden. Diese Integration ermöglicht die automatisierte Segmentierung von Inhalten, eine erweiterte Filterung in Insights und eine optimierte Berichterstattung.

Beispiel: Verwenden Sie Heap Analytik, um ein neues Segment zu erstellen und einen ShoutOut basierend auf dieser Segmentierungslogik anzuzeigen.

Authentifizierungszugriffstoken

Ein Zugriffstoken ist eine Anmeldeinformation, die von einer Anwendung verwendet wird, um auf eine API zuzugreifen. Es informiert das System, dass der Träger berechtigt ist, bestimmte Aktionen durchzuführen, wie z. B. Daten von einem externen System an das WalkMe-Menü zu übertragen.

Erstellen von Zugriffstoken

1. Gehen Sie zum Admin Center
2. Öffnen Sie die Seite API-Schlüssel
3. Wählen Sie Neuen Schlüssel erstellen aus.
4. Im Bereich „Neuen Schlüssel erstellen“:
   1. Benennen Sie den Schlüssel (geben Sie seinen Zweck an, damit Sie sich später merken können)
   2. Aktivieren Sie Segments API.
   3. Wählen Sie Schreiben und Lesen aus dem Dropdown-Menü.
   4. Wählen Sie Erstellen aus.
5. Kopieren Sie im Bereich „Key Details“ die Client-ID und das Client Secret.

Konfigurieren der API-Verbindung

Verwenden Sie die folgenden allgemein notwendigen Informationen, um Ihre Verbindungsanwendung zu konfigurieren:

• URL: https://api.walkme.com/accounts/connect/token
• Methode: POST
• Payload-Typ: application/x-www-form-urlencoded
• Daten: grant_type client_credentials
• Basic Authentication: Geben Sie die Client-ID und das Client Secret ein, die aus dem Admin Center kopiert wurden.

Sobald Sie diese Informationen hinzugefügt haben, generiert das System ein Zugriffstoken.

1. Kopieren Ihres Zugriffstokens
2. Dieses Token verwenden, um Segmente zu verwalten

Beispiel für eine cURL-Anfrage

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <Anmeldeinformationen>' \
--data-urlencode 'grant_type=client_credentials'
# <Anmeldeinformationen> ist die Base64-Kodierung des Verbraucherschlüssels und des Verbrauchergeheimnisses des WalkMe-Kontos, die durch einen Doppelpunkt verbunden ist.

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

Endpunktreferenz

Segment erstellen

Erstellen Sie ein neues Segment basierend auf einer statischen Liste von Benutzern.

• Methode: POST
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• Headers: Authorization: Bearer <Access Token>
• URL-Parameter: systemGuid (zu finden im WalkMe Editor im Snippet)
• Payload / Body: {"id": "<external id>", "name": "<WalkMe Segment Name>", "userIds": ["user1@company.com", "user2@company.com"]}
• Einschränkungen:
  • Maximal 25.000 Benutzer pro Anfrage
  • Maximal 100 Zeichen pro ID-Wert

Segment aktualisieren

Benutzer innerhalb eines vorhandenen Segments ändern.

• Methode: PUT
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
• Headers: Authorization: Bearer <Access Token>
• URL-Parameter:
  • systemGuid: WalkMe-System-GUID
  • segmentGuid: Die spezifische Segment-GUID (muss Bindestriche enthalten, z. B.: 12345aeb-123c-4d83-8b38-a5a456789d0a)
• Payload-Parameter:
  • userIDs: Liste der zu ändernden IDs (Limit 25,000)
  • Aktion: Geben Sie das Hinzufügen, Entfernen oder Überschreiben an
• Payload-Beispiel: {"action": "add", "userIds": ["jane.doe@walkme.com"]}

{ "action": <enum("add"|"remove"|"override")>, "userIds": [<String (Zeichenfolge)>] }

Segmente abrufen

Rufen Sie eine Liste der vorhandenen Segmente ab.

• Methode: GET
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• Headers: Authorization: Bearer <Access Token>
• URL-Parameter: systemGuid

Segmente löschen

Ein Segment dauerhaft entfernen.

• Methode: DELETE
• URL: https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}
• Headers: Authorization: Bearer <Access Token>
• URL-Parameter: segmentId (die ID des Zielsegments)

Löschen <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>

Technische Hinweise

• Es dauert bis zu 10 Minuten, bis ein neues Segment im Editor Condition Builder angezeigt wird
• Um Ihr Segment zu verwenden, öffnen Sie den Condition Builder und wählen Sie Benutzerattribute aus, dann External-Segment und dann Ihren Segmentnamen
  • Verwenden Sie nur „Ist“ oder „Ist nicht“ als Operator und geben Sie „Wahr“ in das Eingabefeld ein.
• WalkMe zeigt derzeit keine Benutzer an, die als Teil dieser Integration synchronisiert wurden.