はじめにクイックスタートガイド

エントリー時の年齢保証

Adaptive Accessを使って年齢ゲートでユーザーに年齢の証明を求め、合格した後にのみCDKセッションを作成します。

このガイドでは、Adaptive Accessのエントリー側であるプロダクトレベルの年齢保証を設定します。選択したトリガー年齢以上の年齢を申告したユーザーは、セッションを取得する前にそれを証明します。設定、年齢ゲートの結果、チェック、結果、セッションという1つの流れで、Compliance Studioの設定から解除されたセッションまでを進めます。

ユーザーが特定の機能に到達したときにのみ証明を求めるには、代わりに機能利用時の年齢保証に従ってください。多くのプロダクトではそちらだけで十分です。

AIコーディングエージェントと統合する

公式の Agent Skills では、年齢ゲート、年齢保証チャレンジ、webhookなど、AI支援での統合を扱います。

前提条件

  1. Compliance Studioの CDKプロダクト。プロダクトの作成を参照してください。
  2. プロダクトの開発者設定から取得した テストモードのAPIキー。テストモードの呼び出しは https://game-api.test.k-id.com に送信されます。テストを参照してください。
  3. Challenge.StateChange イベントを受信する webhookエンドポイント。Webhooksを参照してください。
  4. ユーザーの年齢または生年月日を収集する 年齢ゲート。独自に構築する場合は、カスタム年齢ゲートに従ってください。年齢ゲートまたはエンドツーエンドウィジェットを使用する場合、ウィジェットがチェックを実行し、結果を Widget.AgeGate.Result で報告します。

APIキーはサーバー上に保管してください

このガイドのすべてのk-ID API呼び出しはサーバー間で行います。APIキーをブラウザやアプリに送信しないでください。

ステップ1:プロダクトレベルのアクセスを有効にする

  1. Compliance Studioでプロダクトを開き、エンジンとオーバーライド を選択します。
  2. グローバルルールの編集 を選択します。
  3. プロダクトレベルのアクセス で はい を選択します。
  4. 適用対象 でトリガー年齢を選択します。デフォルトは 法定成人年齢 です。
  5. 変更を保存 を選択し、続いて テスト環境にプッシュ を選択します。

一部の市場でのみ有効にするには、グローバルの設定を いいえ のままにし、マーケット固有のルールを追加 でそれらの市場を はい に設定します。Adaptive Accessの設定を参照してください。

ステップ2:ユーザーの年齢をチェックする

年齢ゲートでユーザーの年齢を収集したら、サーバーから POST /age-gate/check を呼び出します。モバイルのシステムブラウザなど、チェックがiframeの外で開かれる場合は、リダイレクトURLを含めてください。

POST /api/v1/age-gate/check
Content-Type: application/json
Authorization: Bearer your-api-key

{
  "jurisdiction": "US-CA",
  "dateOfBirth": "2001-04-15",
  "options": {
    "playerAgeAssurance": {
      "redirectUrl": "https://mygame.com/age-gate/return"
    }
  }
}

プラットフォーム年齢シグナルがある場合は、platformAgeSignal として送信します。トリガー年齢以上の信頼できるシグナルがあれば、チェックはスキップされます。

ステップ3:年齢ゲートの結果を処理する

status で分岐し、CHALLENGE の場合は challenge.type で分岐します:

レスポンス意味対応
PASSこのユーザーにチェックは不要session.sessionId を保存して続行する
PROHIBITEDユーザーがプロダクトの最低年齢を下回っているユーザーをブロックする
CHALLENGE と CHALLENGE_PARENTAL_CONSENTユーザーに保護者の同意が必要カスタム年齢ゲートに従う
CHALLENGE と CHALLENGE_AGE_GATE_AGE_ASSURANCEユーザーが年齢を証明する必要があるステップ4に進む

年齢保証チャレンジは次のようになります。この時点ではセッションはまだ返されません:

{
  "status": "CHALLENGE",
  "challenge": {
    "challengeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "CHALLENGE_AGE_GATE_AGE_ASSURANCE",
    "url": "https://family.k-id.com/age-gate/verify?token=..."
  }
}

結果をこのユーザーと照合できるように、challengeId をサーバーに保存してください。

`ageAssuranceRequired` ではなくレスポンスで分岐してください

/age-gate/get-requirements の ageAssuranceRequired はレポート用の値です。このチャレンジが返されるかどうかは示しません。

ステップ4:チェックを表示する

challenge.url をクライアントに送信し、ユーザーに表示します。ユーザーは、プロダクトの年齢保証の方法のいずれかで自分自身の確認を行います。

Webでは、iframeに埋め込みます。カメラ、決済、AgeKeyの方法には allow 属性が必要です:

<iframe
  src="CHALLENGE_URL"
  width="100%"
  height="600"
  frameborder="0"
  allow="camera;payment;publickey-credentials-get;publickey-credentials-create">
</iframe>

モバイルでは、URLをシステムブラウザで開き、ステップ2のリダイレクトURLを処理します。モバイルアプリクイックスタートを参照してください。コンソールでは、ユーザーのスマートフォン用にURLをQRコードとして表示します。

ユーザーが完了したときにiframeを閉じるには、Verification.Result メッセージをリッスンします:

window.addEventListener("message", (event) => {
  if (!event.origin.endsWith(".k-id.com")) return;
  if (event.data?.eventType === "Verification.Result") {
    closeAgeAssuranceIframe();
    // ここではアクセスを許可しないでください。サーバーが結果を確認するのを待ちます。
  }
});

ステップ5:サーバーで結果を取得する

リダイレクトとDOMメッセージは結果ではありません。Challenge.StateChange webhookを使用するか、GET /challenge/get-status をポーリングして、サーバーでk-IDから結果を読み取ってください。

{
  "eventType": "Challenge.StateChange",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "productId": 42,
    "type": "CHALLENGE_AGE_GATE_AGE_ASSURANCE",
    "status": "PASS",
    "sessionId": "608616da-4fd2-4742-82bf-ec1d4ffd8187"
  }
}
status対応
PASSk-IDがセッションを作成しました。sessionId を保存し、ステップ6に進みます。
FAILユーザーは年齢を証明できませんでした。セッションは作成されていません。ユーザーを入れないでください。
IN_PROGRESS待機を続けます。
// Express の webhook ハンドラー(最初に webhook の署名を検証してください。/webhooks を参照)
app.post("/webhooks/k-id", async (req, res) => {
  const { eventType, data } = req.body;
  if (eventType === "Challenge.StateChange" && data.type === "CHALLENGE_AGE_GATE_AGE_ASSURANCE") {
    if (data.status === "PASS") {
      await savePlayerSession(data.id, data.sessionId);
    } else if (data.status === "FAIL") {
      await markAgeCheckFailed(data.id);
    }
  }
  res.sendStatus(200);
});

k-IDは、このチェックの後に作成されたセッションについて Session.Created webhookを送信しません。Challenge.StateChange の sessionId によってセッションを把握します。

ステップ6:セッションを読み込み、ユーザーを入れる

sessionId を指定して GET /session/get を呼び出し、各権限の enabled の値に基づいて機能を有効にします。

GET /api/v1/session/get?sessionId=608616da-4fd2-4742-82bf-ec1d4ffd8187

セッションには、チェックの結果である ageVerification が含まれます。ユーザーが証明した年齢以下の確認済み年齢を必要とする機能はすでに有効になっているため、それらに対する後続の機能レベルのチェックは、再度確認を求めることなく許可されます。

ステップ7:テストする

テストモードで、トリガー年齢以上の年齢を指定して /age-gate/check を呼び出し、チャレンジURLからチェックを完了します。テストモードのチャレンジURLは7分で期限切れになります。次のことを確認してください:

  • レスポンスがセッションなしの CHALLENGE_AGE_GATE_AGE_ASSURANCE チャレンジであること
  • webhookが status: PASS と sessionId を含む Challenge.StateChange を受信すること
  • /session/get が ageVerification を含むセッションを返すこと

次に、トリガー年齢未満の年齢を指定して /age-gate/check を呼び出し、ユーザーに確認が求められないことを確認します。

次のステップ

On this page