セグメントAPI（ベータ）
概要
外部サービスがコンテンツセグメンテーション、インサイトのフィルタリング、およびレポートを目的とした既存のWalkMeセグメントデータを作成、編集、削除、または使用できるようにします。
例：ヒープアナリティクスを使用して新しいセグメントを作成し、セグメンテーションロジックに従ってシャウトアウトを表示します。
認証とアクセストークンの作成
アクセストークンとは何ですか？
アクセストークンは、アプリケーションがAPIにアクセスするために使用できる資格情報です。 彼らは、トークンのベアラが特定のアクションにアクセスすることが許可されたことをAPIに通知します。
アクセストークンは、APIコールを認証し、アプリケーションにシステムからワークステーションにデータを渡す権限を与えます。
アクセストークンの作成
- Admin Center（管理センター）に移動します。
- APIキータブに移動します。https://admin.walkme.com/account-api-keys
- ［Create New（新規作成）］をクリックします
新しいキーの作成パネルから：
- キーに名前を付けます
- ヒント：名前でキーの目的を示すと、後で覚えるのを助けます
- セグメントAPIをオンにします
- ドロップダウンから［Write and Read（書き込みと読み取り）］を選択します
- 作成をクリック
キーの詳細パネルから：
- クライアントIDとクライアントシークレットをコピーします
認証トークン
追加サポートと認証トークンを取得するために：開発者ページ
API接続アプリケーションに情報を追加します
追加サポート開発者ページのために
API接続アプリケーションに関する情報を入力します。
以下で使用される情報は、すべてのアプリケーションで普遍的に必要となります。
- URL=https://api.walkme.com/accounts/connect/token
- ペイロードタイプ=application/x-www-form-urlencoded
- データ=grant_type→client_credentials
基本的な認証を追加
- クライアントID |クライアントシークレット（管理センターからコピー）
- 例
0o234234234UqD5d7 | JVnD346346346436345asfgasgbPt_4T7h2_
- 例
この情報を追加すると、アクセストークンが提供されます。
- アクセストークンをコピーします
以下のAPIドキュメントを使用して、トークンを使用してWalkMeセグメントを作成、取得、更新、または削除できます。
以下のcURLコードブロックを使用することもできます：
リクエスト例 - cURL
--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. |
{ "access_token": "asdjkldfsjsdfhjksfdhjkxvc32cvhjhjksefbnxjnweuirou8sdfg8xdfjwkjr.sv8o8vuisuhvseuksfe", "expires_in": 86400, "token_type": "Bearer", "scope": "segments:write segments:read"} |
呼び出しを行います
セグメントを作成する
| 説明 | ユーザーの静的なリストに基づいて新しいセグメントを作成します |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| メソッド | POST |
| ヘッダー | 承認 - 署名なし - jwt |
| URLパラメータ |
>エディターメニュー>スニペットからシステムGUIDを取得できます 「https:cdn.walkme.com/users/<GUID IS HERE>/test/walkme_<...>」の間にあるキーをコピーします |
| ペイロード/ボディ | {"id": "<extneral id>" "name"："<WalkMeセグメント名-エディターに表示されます>"、 "userIds": ["John@company.com", "Melissa@company.com"] }id: ヒープセグメントID >- オプションのparamuserIds: ユーザーIDリスト -
|
セグメントを更新
| 説明 | 既存セグメントを更新 | ||
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment/{segmentGuid} | ||
| メソッド | PUT | ||
| ヘッダー | 承認 - 署名なし - jwt | ||
| systemGUID | systemGuid- WalkMeシステムGUID segmentGuid - WalkMeセグメントGUID**SegmentGuidは、12345aeb-123c-4d83-8b38-a5a456789d0aのようなハイフンで出力された形式のURLに配置する必要があります。 |
||
| ペイロード | application/json
ペイロードパラメータ：
ペイロードの例：
|
セグメントを取得する
| 説明 | セグメントを取得する |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| ヘッダー | 承認 - 署名なし - jwt |
| URLパラメータ | システムGuid - WalkMeシステムGUID |
セグメントが作成されると、エディターは条件ビルダーの新しい外部セグメントで更新するのに最大10分かかります。
ユーザーIDがAPIによって作成された特定のセグメントにある場合に基づいてコンテンツをセグメント化するには、条件ビルダーに移動し、ユーザー属性→外部セグメント→セグメント名→→Is or Is not →"true"を選択します。
演算子としてIsまたはIs notのみを使用し、入力フィールドで「true」を使用する必要があります（他のオプションは動作しません）。
セグメントを削除します
| 説明 | セグメントを削除します |
| URL | https://api.walkme.com/public/v1/user/system/{systemGuid}/segment |
| ヘッダー | 承認 - 署名なし - jwt |
| URLパラメータ | セグメント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>