Kurzübersicht

Die Segment-API ermöglicht es externen Diensten, WalkMe-Segmente programmatisch zu erstellen, zu aktualisieren, abzurufen und zu löschen. Verwenden Sie sie, um die Segmentierung von Inhalten zu automatisieren, erweiterte Filterung in Insights anzuwenden und die Berichterstattung zu optimieren. die

Sie können beispielsweise Heap Analytik verwenden, um ein Segment zu erstellen und einen ShoutOut basierend auf dieser Segmentierungslogik auszulösen.

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. Öffnen Sie die WalkMe-Konsole
   
   • US-Rechenzentrum
   • EU-Datenzentrum
   • SAP US Data Center
   • SAP EU Data Center
   • FedRAMP-Rechenzentrum
   • Kanada-Rechenzentrum
2. Gehen Sie zur Kategorie Admin
3. Wählen Sie Zugriffsverwaltung und dann API-Schlüssel aus.
4. Wählen Sie Neuen Schlüssel erstellen aus.
5. Geben Sie einen Namen für den Schlüssel ein, der seinen Zweck angibt.
6. Aktivieren Sie Segments API.
7. Wählen Sie Schreiben und Lesen aus dem Dropdown-Menü.
8. Wählen Sie Erstellen aus.
9. Kopieren Sie im Bereich Schlüsseldetails die Client-ID und den Client-Secret.

Konfigurieren der API-Verbindung

Um Ihr Autorisierungstoken zu erhalten, lesen Sie die Referenz Autorisierungstoken abrufen im Developer Hub.

Verwenden Sie die folgenden Details, um Ihre Verbindung zu konfigurieren: die Verbindung

• URL: https://api.walkme.com/accounts/connect/token
• Methode: POST
• Payload-Typ: application/x-www-form-urlencoded die
• Daten: grant_type client_credentials
• Grundlegende Authentifizierung: Geben Sie die Client-ID und das Client-Secret ein, die von der Seite API-Schlüssel kopiert wurden.

Das System generiert ein Zugriffstoken, nachdem Sie die Anfrage gesendet haben. Kopieren Sie das Token und verwenden Sie es, 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.

Beispiel für eine JSON-Antwort

{ "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 bestimmte Segment-GUID (muss Bindestriche enthalten, z. B. 12345aeb-123c-4d83-8b38-a5a456789d0a)
• Payload-Parameter:
  • user-IDs: 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 kann bis zu 10 Minuten dauern, bis ein neues Segment im Condition Builder angezeigt wird.
• WalkMe zeigt keine Benutzer an, die über diese Integration synchronisiert wurden.
• Um Ihr Segment im WalkMe Editor zu verwenden, öffnen Sie den Condition Builder und wählen Sie Benutzerattribute, dann Externes Segment und dann Ihren Segmentnamen aus. Verwenden Sie nur Is oder Is not als Operator und geben Sie True in das Eingabefeld ein.