Segments API (Beta)

Last Updated März 28, 2024

Kurzübersicht

Ermöglichen Sie externen Diensten die Erstellung, Bearbeitung, Löschung oder Verwendung bestehender WalkMe-Segmentdaten zum Zweck der Inhaltssegmentierung, der Filterung von Insights und der Berichterstellung.

Zum Beispiel: Verwenden Sie Heap Analytics, um ein neues Segment zu erstellen und ein ShoutOut entsprechend der Segmentierungslogik anzuzeigen.

Anmerkung

WalkMe zeigt derzeit keine Benutzer an, die als Teil dieser Integration synchronisiert wurden.

Authentifizierung und Erstellung eines Zugriffstokens

Was ist ein Zugriffstoken?

Ein Zugriffstoken ist eine Anmeldeinformation, das von einer Anwendung zum Zugriff auf eine API verwendet werden kann. Sie informieren die API, dass der Inhaber des Tokens berechtigt ist, auf eine bestimmte Aktion zuzugreifen.

Das Zugriffstoken authentifiziert den API-Aufruf und gibt der Anwendung die Erlaubnis, Daten von ihrem System an die Workstation zu übergeben.

Erstellen von Zugriffstoken

Gehen Sie zum Admin Center
Navigieren Sie zur Registerkarte „API Keys“: https://admin.walkme.com/account-api-keys
Klicken Sie auf Create new Key (Neuen Schlüssel erstellen).

Im Bedienfeld „Create new key“:

Benennen Sie den Schlüssel
- Tipp: Geben Sie den Zweck des Schlüssels im Namen an, um Ihnen zu helfen, sich später zu erinnern.
Aktivieren Sie Segments API.
Wählen Sie Schreiben und Lesen aus dem Dropdown-Menü.
Klicken Sie auf Create (Erstellen).

Im Bedienfeld „Key Details“:

Kopieren der Client-ID und des Client-Secret

Speichern des Client-Secrets

Sie werden das Secret nicht wieder sehen, also speichern Sie es irgendwo zugänglich, Sie werden es bald wieder brauchen.

Authentifizierungs-Token

Für zusätzlichen Support und um das Authentifizierungs-Token zu erhalten: Seite der Entwickler

Hinzufügen von Informationen zur API-Verbindungsapplikation

Zusätzlichen Support erhalten Sie auf der Seite der Entwickler.

Jetzt ist es an der Zeit, einige Informationen über Ihre API einzugeben.

Die unten verwendeten Informationen sind für alle Anwendungen allgemein notwendig:

URL = https://api.walkme.com/accounts/connect/token
Payload Type = application/x-www-form-urlencoded
Data = grant_type → client_credentials

Hinzufügen der Basis-Authentifizierung

Client-ID | Client-Secret (kopiert vom Admin Center)
- Beispiel
  0o234234234UqD5d7 | JVnD346346346436345asfgasgbPt_4T7h2_

Sobald Sie diese Informationen hinzugefügt haben, erhalten Sie ein Zugriffstoken.

Kopieren Ihres Zugriffstokens

Jetzt können Sie das Token verwenden, um WalkMe-Segmente zu erstellen, zu erhalten, zu aktualisieren oder zu löschen, indem Sie die API-Dokumentation unten verwenden.

Sie können auch die folgenden cURL-Code-Blöcke verwenden:

Beispiel anfordern – cURL

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <credentials>' \
--data-urlencode 'grant_type=client_credentials'
# <credentials> is the base64 encoding of the consumer key and consumer secrect of the WalkMe account joined by a colon.

Antwortbeispiel – JSON

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

Anruf tätigen

Segment erstellen

Beschreibung	Erstellen eines neuen Segments basierend auf der statischen Liste der Benutzer
URL	https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
Methode	POST
Header	Authentifizierungs-Bearer – jwt
URL-Parameter	`systemGuid` – WalkM-System-GUID. Sie können das System-GUID aus dem Editor > Editor Menu > Snippet abrufen Kopieren des Schlüssels zwischen 'https:cdn.walkme.com/users/<GUID IST HIER>/test/walkme_<....>'
Payload / Body	{"id": "<extneral id>", „name“: „<WalkMe Segment Name – wird im Editor sichtbar>“, "userIds": ["John@company.com", "Melissa@company.com"] }id: heap segment id> - optional param userIds: Liste der Benutzer-IDs – Einschränkungen: Bis zu 25.000 Benutzer pro Anfrage Bis zu 100 Zeichen pro ID-Wert.

Segment aktualisieren

Beschreibung Aktualisieren eines bestehenden Segments

URL https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}

Methode PUT

Header Authorisierung – Bearer – jwt

systemGUID systemGuid- WalkMe system GUID
segmentGuid – WalkMe Segment GUID**SegmentGuid muss in URL im ausgegebenen Format mit einem Bindestrich platziert werden wie: 12345aeb-123c-4d83-8b38-a5a456789d0a

Payload

application/json

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

Payload-Parameter

userIds: List of users ids - limit - 25k users

action: selected update mode, accept only "add","remove" or "override"

Payload-Beispiel:

{"action": "add",
  "userIds": ["jane.doe@walkme.com"]
}

Segmente abrufen

Beschreibung	Segmente abrufen
URL	https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
Header	Authentifizierungs-Bearer – jwt
URL-Parameter	System Guid – WalkMe System GUID

Sobald ein Segment erstellt wurde, dauert es bis zu 10 Minuten, bis der Editor mit dem neuen externen Segment im Condition Builder aktualisiert ist.

Um Inhalte zu segmentieren, die darauf basieren, ob die Benutzerkennung in einem bestimmten, von der API erstellten Segment enthalten ist, gehen Sie zum Condition Builder und wählen Sie: User Attributes (Benutzerattribute) → External-Segment (Externes-Segment) → Segment name (Segmentname) → Is or Is not (Ist oder Ist nicht) → „true“ (wahr)

Sie dürfen nur „Is or Is not“ als Operator und „true“ im Eingabefeld verwenden (andere Optionen funktionieren nicht).

War dies hilfreich?

Ja Nein

Nein

Vielen Dank für Ihr Feedback!