概要

外部サービスが既存のWalkMeセグメントデータを作成、編集、削除、使用できることを許可します。 この統合は、コンテンツのセグメンテーションの自動化、インサイトの高度なフィルター、レポートの合理化を可能にします。

例：Heap Analyticsを使用して新しいセグメントを作成し、そのセグメンテーションロジックに基づいてシャウトアウトを表示します。

認証アクセストークン

アクセストークンは、アプリケーションがAPIにアクセスするために使用する認証情報です。 ベアラーが外部システムからWalkMeメニューにデータを渡すなど、特定のアクションを実行する権限を持っていることをシステムに通知します。

アクセストークンの作成

1. Admin Center（管理センター）に移動します。
2. 「APIキー」ページを開きます。
3. 「新しいキーの作成」を選択します。
4. 「新しいキーの作成」パネル：
   1. キーに名前を付けます（後で覚えるために目的を明記します）。
   2. セグメントAPIをオンにします
   3. ドロップダウンから［Write and Read（書き込みと読み取り）］を選択します
   4. [作成]を選択します
5. 「キー詳細」パネルで、クライアントIDとクライアントシークレットをコピーします。

API接続の設定

以下の共通して必要な情報を使用して、接続アプリケーションを設定します：

• URL：https://api.walkme.com/accounts/connect/token
• 方法：POST
• ペイロードタイプ：application/x-www-form-urlencoded
• データ：grant_type client_credentials
• 基本認証：管理センターからコピーされたクライアントIDとクライアントシークレットを入力します。

この情報を追加すると、システムはアクセストークンを生成します。

1. アクセストークンをコピーします
2. このトークンを使用して、セグメントを管理します。

cURLリクエスト例

curl --location --request POST 'https://api.walkme.com/accounts/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <認証情報>' \
--data-urlencode 'grant_type=client_credentials'
# <認証情報> は、WalkMeアカウントのコンシューマーキーとコンシューマーシークレットをコロンで結合したものをbase64エンコーディングしたものです。

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

エンドポイントリファレンス

セグメントを作成する

ユーザーの静的リストに基づいて新しいセグメントを作成します。

• 方法：POST
• URL：https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• ヘッダー：Authorization：Bearer <Access Token>
• URLパラメーター：systemGuid（スニペットのWalkMeエディタにあります）
• ペイロード/本文：{"id": "<external id>", "name": "<WalkMe Segment Name>", "userIds": ["user1@company.com", "user2@company.com"]}
• 制限：
  • リクエストごとに最大25,000ユーザー
  • ID値ごとに最大100文字

セグメントを更新

既存セグメント内のユーザーを変更します。

• メソッド：PUT
• URL：https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid}
• ヘッダー：Authorization：Bearer <Access Token>
• URLパラメータ：
  • systemGuid：WalkMeシステムGUID
  • segmentGuid：特定のセグメントGUID（ハイフンを含む必要があります。例：12345aeb-123c-4d83-8b38-a5a456789d0a）
• ペイロードパラメータ：
  • userIds：変更するIDのリスト（制限25,000個）
  • アクション：追加、削除、オーバーライドを指定します。
• ペイロード例：{"アクション": "add", "userIds": ["jane.doe@walkme.com"]}

{ "アクション"： <enum("add"|"remove"|"override")>, "userIds"：[<文字列>] }

セグメントを取得する

既存セグメントのリストを取得します。

• メソッド：GET
• URL：https://api.walkme.com/public/v1/user/system/{systemGuid}/segment
• ヘッダー：Authorization：Bearer <Access Token>
• URLパラメータ：systemGuid

セグメントを削除します

セグメントを永久に削除します。

• メソッド：DELETE
• URL：https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentId}
• ヘッダー：Authorization：Bearer <Access Token>
• URLパラメータ：segmentId（ターゲットセグメントのID）

DELETE <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>

技術的なノート

• 新しいセグメントがエディター条件ビルダーに表示されるまで、最大10分かかります。
• セグメントを使用するには、条件ビルダーを開き、「ユーザー属性」、「外部セグメント」、「セグメント名」を選択します。
  • 演算子として「Is」または「Is not」のみを使用し、入力フィールドに「True」と入力します。
• WalkMeは現在、この統合の一部として同期されたユーザーを表示しません。