概要

セグメントAPIは、外部サービスがWalkMeセグメントをプログラム的に作成、更新、取得、削除できるようにします。 コンテンツのセグメンテーションを自動化し、インサイトの高度なフィルターを適用し、レポートを合理化するために使用します。

例えば、Heap Analyticsを使用してセグメントを作成し、そのセグメンテーションロジックに基づいてシャウトアウトをトリガーできます。

認証アクセストークン

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

アクセストークンの作成

1. WalkMeコンソールを開きます
   
   • 米国データセンター
   • EUデータセンター
   • SAP USデータセンター
   • SAP EUデータセンター
   • FedRAMPデータセンター
   • カナダデータセンター
2. 管理者カテゴリに移動します
3. アクセス管理を選択し、APIキーを選択します。
4. 「新しいキーの作成」を選択します
5. 目的を示すキーの名前を入力します。
6. セグメントAPIをオンにします
7. ドロップダウンから［Write and Read（書き込みと読み取り）］を選択します
8. [作成]を選択します
9. 「キー詳細」パネルで、クライアントIDとクライアントシークレットをコピーします。

API接続の設定

認証トークンを取得するには、開発者ハブの認証トークンリファレンスを参照してください。

以下の詳細を使用して、接続を構成します：

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

システムは、リクエストを送信した後にアクセストークンを生成します。 トークンをコピーし、セグメントを管理するために使用します。

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エンコーディングしたものです。

JSONレスポンス例

{"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分かかる場合があります
• WalkMeは、この統合を通じて同期されたユーザーを表示しません
• WalkMeエディタでセグメントを使用するには、条件ビルダーを開き、「ユーザー属性」、「外部セグメント」、次にセグメント名を選択します。 演算子として「Is」または「Is not」のみを使用し、入力フィールドに「True」と入力します。