他ツールとの連携

userIdの指定が必要になる連携についてはあらかじめ ユーザープロファイルの設定 の実装が必要となります

URL連携

基本フォーマット

https://app.wicle.io/?apiKey=__YOUR_API_KEY__&userId=__USER_ID__&timestamp=__UNIXTIMESTAMP_MILLS__

「timestamp」をセットするとその時点のタイムラインに直接遷移することができます。（任意値です）

※管理画面URLは将来的に変更になる可能性があります

クライアントサイドでの連携方法

タグが設置されている場合、Wicleの各種関数からURLを取り出すことが可能です。

// 指定ユーザーへのURL
window.__WICLE.getAdminUrlForUser('__USER_ID__'); // https://app.wicle.io?apiKey=__YOUR_API_KEY__&userId=__USER_ID__

// 指定ユーザーの現在時刻へのURL
window.__WICLE.getAdminUrlForUserAndCurrentTime('__USER_ID__'); // https://app.wicle.io?apiKey=__YOUR_API_KEY__&userId=__USER_ID__&timestamp=1660740965525


// --- (option) userIdの特定ができない場合、以下の関数からwicleで発行しているuser hashに基づくURLの発行が可能です
// 指定ユーザーへのURL
window.__WICLE.getAdminUrlForNonUser();

// 指定ユーザーの現在時刻へのURL
window.__WICLE.getAdminUrlForNonUserAndCurrentTime();

サーバーサイドでの連携方法

基本フォーマットに沿ってURLを組み立てて頂く形です。

連携の例

現在はURLベースでの連携方法になるため、任意データが送信できるサービスならどれでも連携自体は可能です。

以下でサンプルケースとしていくつかのサービスの具体例を記載します。

Sentry

APIs | Sentry for JavaScriptdocs.sentry.io

ユーザー情報の拡張データとしてWicleのURLを紐づける

Sentry.setUser({
  id: user.id,
  email: user.email,
  username: user.username,
  wicleUrl: window.__WICLE.getAdminUrlForUser(user.id),
});

キャプチャ時にscopeを利用してエラーデータの拡張データとして付与する

Sentry.withScope((scope) => {
  scope.setExtra('wicleUrl', window.__WICLE.getAdminUrlForUserAndCurrentTime(user.id));
  Sentry.captureException(error);
});

Mixpanel

ユーザー情報の登録APIでWicleのURLを紐づける

https://docs.mixpanel.com/docs/tracking-methods/sdks/javascript#mixpanelregister

mixpanel.identify(user.id);
mixpanel.people.set({
  name: userName,
  email: userEmail,
  wicleUrl: window.__WICLE.getAdminUrlForUser(user.id),
});

イベント送信時の拡張データとして付与する

https://docs.mixpanel.com/docs/tracking-methods/sdks/javascript#mixpaneltrack

mixpanel.track('someEvent', {
  'Gender': 'Male',
  'Age': 21,
  'wicleUrl': window.__WICLE.getAdminUrlForUserAndCurrentTime(user.id),
});