k-IDをゲームに統合する

📄️ ワークフロー

以下のフローチャートは、k-IDエンジンのワークフローの概要を示しています。ワークフロー内でAPI呼び出しが使用されるポイントが示されています。k-ID Workflow

📄️ セッションの管理

れています。すべてのプレイヤーにはアクティブな「Session」が必要です。ゲームはアクティブな「Session」を参照して、ゲーム内の機能が有効か無効かを判断する必要があります。

年齢ゲートが必要な場合、次のワークフローのステップを判断するために/age-gate/check API呼び出しを行う必要があります。プレイヤーの年齢がパブリッシャーポータルで設定されたゲームの最低年齢を下回る場合、返されるstatusフィールドはPROHIBITEDとなります。この時点で、プレイヤーはゲームの継続をブロックされるべきです。現在の場所で検証可能な親の同意が必要な年齢をプレイヤーが入力した場合、statusフィールドにはCHALLENGEという値が入り、新しい同意チャレンジのIDがchallengeIDフィールドで返されます。ゲームはその後、プレイヤーに親の同意を求めるよう促さなければなりません。最後に、statusの値がPASSであれば、プレイヤーはゲームを続行できます。

📄️ 保護書の同意を求めること

/age-gate/check の status フィールドで CHALLENGE の値が返された場合、レスポンスの challengeId フィールドには、k-IDエンジンの Consent Challenge のIDが含まれています。この時点で、プレイヤーが親の同意を求めるためのウィンドウを表示する必要があります。

📄️ セッション権限の使用

ユーザーが年齢ゲートチェックを通過した場合（適切な年齢であるか、保護者から同意が得られた場合）、ゲームは現在のプレイヤーに対する管轄地域固有のすべての権限を取得できます。これは、/age-gate/check呼び出しでstatusフィールドがPASSの場合に取得するか、セッションが以前に作成されてキャッシュされている場合は、/session/getを呼び出して取得します。

📄️ 年齢確認の申し立て

年齢確認が失敗した場合や、ゲームによって割り当てられた年齢カテゴリに異議を申し立てたい場合、プレイヤーは年齢異議申立てのワークフローを作成することができます。年齢異議申立てを作成するには、プレイヤーがファミリーポータルの年齢異議申立てURLにアクセスする必要があります。そこで、管轄地域で利用可能な方法（例：写真付き身分証明書の提出など）を使用して年齢を証明できます。

📄️ 新しい権限の同意をリクエストする

（これはロードマップ機能でありまだ展開していなく、APIドキュメントでは実験的と記載されています）

📄️ Webhooks(ウエブフック)

Webhooksを使用すると、k-IDエンジン内で発生しているイベントをリアルタイムで購読できます。これにより、APIをポーリングしてデータが利用可能かどうかを確認する必要がなくなります。