Skip to content

ID連携 実装ガイド 🟧 ​

開発ご担当者さま向け

本ページは ID連携 を実装する開発ご担当者さま向けの仕様です。 ID連携の概要・メリットは ID連携 をご覧ください。

貴社の会員ID を skinsense に安全に渡すために、貴社サーバで会員ID から idToken(暗号化した会員ID)を発行し、診断ページを開くときに渡す 実装を行います。

全体の流れ ​

① 貴社サーバ  ── 会員ID + シークレットキー ──→  skinsense 暗号化API
   貴社サーバ  ←──────── idToken ─────────────

② 会員のブラウザ ── 診断ページを開く(idToken を付与)──→ skinsense
#やること実装する場所
1シークレットキーをサーバ側に保管する貴社サーバ
2暗号化API を呼び、会員ID から idToken を発行する貴社サーバ
3診断ページの URL、または埋め込みコードに idToken を渡す貴社サイト

1. シークレットキーの保管 ​

プロジェクトID とシークレットキーは、管理画面の プロジェクト設定 > ウィジェット で確認できます。

シークレットキーはブラウザに渡さない

シークレットキーは 貴社サーバの中だけ で扱ってください。ブラウザに届くと、第三者が任意の会員になりすました idToken を作れてしまいます。

次のような「ブラウザに配信される設定」には入れないでください。

  • Nuxt の runtimeConfig.public
  • Next.js の NEXT_PUBLIC_ で始まる環境変数
  • Vite の VITE_ で始まる環境変数
  • HTML や JavaScript に直接書き込む

万一漏れた場合は、シークレットキーを再生成 し、お問い合わせ からご連絡ください。


2. idToken を発行する(暗号化API) ​

エンドポイント ​

POST https://api.skinsense.jp/v1/user/auth/connectId/sign
Content-Type: application/json

リクエスト ​

json
{
  "projectId": "プロジェクトID",
  "connectId": "会員ID",
  "secretKey": "シークレットキー",
  "expiresIn": 3600
}
項目必須内容
projectId✅プロジェクトID
connectId✅貴社の会員ID(文字列)
secretKey✅シークレットキー
expiresIn–idToken の有効期限(秒)。省略時は 3600(1時間)、最大 86400(1日)

expiresIn に 0 を指定しない

0 を指定すると無期限の idToken になります。漏れたときに使われ続けてしまうため、指定しないでください。

レスポンス ​

成功するとステータス 201 で idToken が返ります。

json
{
  "idToken": "(暗号化された会員ID)"
}
ステータス内容
201発行成功
400リクエストの形式に誤りがある(必須項目の不足など)
403シークレットキーが一致しない、またはプロジェクトの ID連携が有効になっていない
404プロジェクトID が見つからない

呼び出し例(Node.js) ​

js
// 貴社サーバ側のコード。シークレットキーは環境変数などサーバ側の設定から読む
const res = await fetch('https://api.skinsense.jp/v1/user/auth/connectId/sign', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    projectId: process.env.SKINSENSE_PROJECT_ID,
    connectId: member.id, // ログイン中の会員の会員ID
    secretKey: process.env.SKINSENSE_SECRET_KEY,
  }),
})
if (!res.ok) throw new Error(`idToken の発行に失敗しました: ${res.status}`)
const { idToken } = await res.json()

3. idToken を渡す ​

公開方法(公開の 2 通りの手段)に合わせて、次のどちらかで渡します。

skinsense のホスティングサイトを使う場合 ​

診断ページの URL に idToken パラメータを付けます。

https://hosting.skinsense.jp/?pid=プロジェクトID&idToken=発行したidToken

idToken は URL にそのまま使える文字だけでできているため、エンコードは不要です。

自社サイトに埋め込む場合 ​

埋め込みコードの s2.setup に idToken を渡します。

html
<script>
  window.s2Ready = function (s2) {
    s2.setup({ projectId: 'プロジェクトID', idToken: '発行したidToken' })
  }
</script>

埋め込みコードの全体は プロジェクト設定 > ウィジェット に表示されています。


有効期限の考え方 ​

  • 有効期限は 診断ページを開いた時点 で判定されます。開いたあとの撮影・診断には影響しません。
  • 期限が切れた idToken で開くと、診断ページに「IDトークンの有効期限が切れています」と表示されます。
  • idToken は使い回さず、診断ページへのリンクを出すたびに発行 してください。

発行するタイミングに合わせて、有効期限を決めてください。

発行するタイミングおすすめの有効期限
診断ページへのリンクを含むページを表示したとき既定の 1時間程度(ページを開いたまま時間が経ってから押されることがあるため)
リンクが押されたときに貴社サーバで発行し、診断ページへ転送するとき数分程度

会員ID について ​

  • connectId には、会員ごとに変わらない ID を指定してください。同じ会員ID であれば、端末やブラウザが変わっても診断履歴が引き継がれます。
  • 会員ID は大文字・小文字や前後の空白も含めて 完全に一致 したものが同じ会員として扱われます。
  • 会員ID は管理画面や 診断結果 CSV に表示されます。メールアドレスなどの個人情報ではなく、会員番号などをお使いください。

動作確認 ​

  1. テスト用の会員でログインし、診断ページを開いて診断します
  2. 管理画面の 診断ユーザー で、その会員に 「ID連携中」バッジ と会員ID が表示されていることを確認します

診断ページに出るエラー ​

表示主な原因
IDトークンの有効期限が切れていますidToken の有効期限が過ぎている(使い回し、または有効期限が短すぎる)
IDトークンが不正ですidToken が途中で欠けている、または別のプロジェクトID で発行したもの
ID連携が無効になっていますプロジェクトの ID連携が有効になっていない

関連 ​

skinsense プロバイダーコンソール 操作マニュアル