埋め込みフロー
CDKは、単一のインターフェース内で完全な検証可能な親の同意(VPC)フローを処理するエンドツーエンドウィジェットを提供し、年齢ゲート、VPC、データ通知、権限、設定を1つのシームレスなエクスペリエンスでカバーします。
エンドツーエンドウィジェットとは?
エンドツーエンドウィジェットは、単一のインターフェースで完全なコンプライアンスフローを処理する包括的なソリューションで、年齢ゲート、VPC、データ通知、権限、設定を1つのシームレスなエクスペリエンスでカバーします。このウィジェットは、子供のデバイスまたは親自身のデバイスで親が使用でき、同意プロセスに最大の柔軟性を提供します。
ウィジェットURLの生成
/widget/generate-e2e-url APIを呼び出して、完全なVPCフローを処理するエンドツーエンドウィジェットURLを作成します。これにより、ユーザーが年齢収集と親の同意プロセスを完了するための一意のURLが返されます。
リクエストの例
POST /api/v1/widget/generate-e2e-url
Content-Type: application/json
Authorization: Bearer your-api-key
{
"jurisdiction": "US-CA"
}
設定フラグ
オプションのflagsパラメータを使用すると、スキップするフローの部分をカスタマイズできます:
skipDataNotices: データ通知と同意収集をスキップskipVerification: 確認ステップをスキップskipPermissions: 権限管理をスキップskipPreferences: 設定をスキップ
レスポンスの例
{
"id": "7854909b-9124-4bed-9282-24b44c4a3c97",
"url": "https://family.k-id.com/widget?token=eyJhbGciOiJFUzM4NCIs..."
}
ウィジェットの埋め込み
返されたURLを使用して、Webサイトまたはアプリにiframeを作成します。ユーザーはこのインターフェースを通じて年齢収集と信頼できる大人の同意プロセスを完了し、利用可能な方法が管轄区域の要件に自動的に適応します。
<div id="vpc-container">
<iframe
id="vpc-widget"
src="WIDGET_URL"
width="100%"
height="600"
frameborder="0"
allow="camera;payment;publickey-credentials-get;publickey-credentials-create">
</iframe>
</div>
イベントの処理
ウィジェットは、リッスンできるJavaScriptイベントを発行します:
イベント構造の詳細については、Widget.AgeGate.Challengeを参照してください。
window.addEventListener('message', (event) => {
if (!event.origin.endsWith('.k-id.com')) {
return;
}
const message = event.data;
if (message.eventType === 'Widget.AgeGate.Challenge') {
if (message.data.status === 'PASS') {
// 親が同意を承認 - アクセスを許可
console.log('Consent approved:', message.data.sessionId);
grantAccess(message.data.sessionId);
} else if (message.data.status === 'FAIL') {
// 親が同意を拒否 - アクセスを制限
console.log('Consent denied');
restrictAccess();
}
}
});
ウィジェットが処理する内容
ウィジェットは自動的に以下を処理します:
- 年齢収集: 管轄区域に適した年齢収集方法
- データ通知: Compliance Studioでの製品設定に応じて受け入れるデータ通知
- 権限: Compliance Studioでの製品設定に応じて管理する権限
- 親の同意チャレンジ: ユーザーが未成年者と判断された場合、信頼できる大人の承認のためにチャレンジが作成されます
特定のフローは、管轄区域とCompliance Studioでの製品設定によって異なります。
VPCの実装の詳細については、クイックスタートガイドを参照してください。