メインコンテンツに移動

新しいセッションと権限ガイドおよびドキュメントの更新

セッションと権限を管理するための包括的なガイドを追加し、重要な説明を追加してコアコンセプトのドキュメントを更新しました。

新機能

新しいガイド: セッションと権限の管理

新しいクイックスタートガイドを追加しました: セッションと権限の管理。このガイドでは、次の手順を説明しています:

  • Webhookとセッション比較を使用した権限変更の検出
  • セッション削除と取り消しの処理
  • プレイヤーへの権限変更の通知
  • 権限アップグレードフローの実装
  • チャレンジがセッションとどのように関連するかの理解

このガイドは、親が設定を変更したり、プレイヤーが年齢アップしたりするなど、時間の経過とともに権限の変更に対応する必要がある統合に不可欠です。

ドキュメントの更新

セッションドキュメント

セッションコンセプトページに重要な説明を追加しました:

  • セッションIDの永続性: プレイヤーはプロダクトごとに正確に1つのセッションを持ちます。セッションIDは権限変更を通じて永続しますが、セッションが取り消され、同意フローが再度完了した場合は新しいセッションIDが作成されます。
  • セッション削除の動作: 削除されたセッションは、エラーコードNOT_FOUNDでHTTP 400を返します(404ではありません)。これは意図的なものです—削除されたセッションは、存在しなかったかのように扱う必要があります。
  • 年齢アップの変更: 年齢アップイベントはWebhook通知をトリガーしません。これらの変更を検出するには、セッション比較を使用する必要があります。

権限ドキュメント

権限コンセプトページを次の内容で強化しました:

  • managedByフィールドの変更: managedByは時間の経過とともに変更される可能性があることを明確にしました(たとえば、プレイヤーが年齢アップしたときにGUARDIANからPLAYERに)。
  • プレイヤー管理の権限: プレイヤーが/session/upgrade APIを介してPLAYER管理の権限を有効にすることをリクエストすると、Challengeを作成せずに自動的に有効になります。
  • 権限アップグレードのコンテンツ: 権限アップグレードのドキュメントを、より見つけやすくするために権限ページに統合しました。

変更内容

ドキュメントの統合

  • 権限アップグレードコンセプトページを権限ページに統合しました。すべての参照を新しい場所に更新しました。

次のステップ

  • 新しいセッションと権限の管理ガイドを確認してください
  • 統合がセッション削除を正しく処理していることを確認してください(NOT_FOUNDでHTTP 400)

これらの更新についてご質問がある場合や、統合に関するサポートが必要な場合は、サポートチームまでお気軽にお問い合わせください。

新しいセッションと権限ガイドおよびドキュメントの更新

セッションと権限を管理するための包括的なガイドを追加し、重要な説明を追加してコアコンセプトのドキュメントを更新しました。

新機能

新しいガイド: セッションと権限の管理

新しいクイックスタートガイドを追加しました: セッションと権限の管理。このガイドでは、次の手順を説明しています:

  • Webhookとセッション比較を使用した権限変更の検出
  • セッション削除と取り消しの処理
  • プレイヤーへの権限変更の通知
  • 権限アップグレードフローの実装
  • チャレンジがセッションとどのように関連するかの理解

このガイドは、親が設定を変更したり、プレイヤーが年齢アップしたりするなど、時間の経過とともに権限の変更に対応する必要がある統合に不可欠です。

ドキュメントの更新

セッションドキュメント

セッションコンセプトページに重要な説明を追加しました:

  • セッションIDの永続性: プレイヤーはプロダクトごとに正確に1つのセッションを持ちます。セッションIDは権限変更を通じて永続しますが、セッションが取り消され、同意フローが再度完了した場合は新しいセッションIDが作成されます。
  • セッション削除の動作: 削除されたセッションは、エラーコードNOT_FOUNDでHTTP 400を返します(404ではありません)。これは意図的なものです—削除されたセッションは、存在しなかったかのように扱う必要があります。
  • 年齢アップの変更: 年齢アップイベントはWebhook通知をトリガーしません。これらの変更を検出するには、セッション比較を使用する必要があります。

権限ドキュメント

権限コンセプトページを次の内容で強化しました:

  • managedByフィールドの変更: managedByは時間の経過とともに変更される可能性があることを明確にしました(たとえば、プレイヤーが年齢アップしたときにGUARDIANからPLAYERに)。
  • プレイヤー管理の権限: プレイヤーが/session/upgrade APIを介してPLAYER管理の権限を有効にすることをリクエストすると、Challengeを作成せずに自動的に有効になります。
  • 権限アップグレードのコンテンツ: 権限アップグレードのドキュメントを、より見つけやすくするために権限ページに統合しました。

変更内容

ドキュメントの統合

  • 権限アップグレードコンセプトページを権限ページに統合しました。すべての参照を新しい場所に更新しました。

次のステップ

  • 新しいセッションと権限の管理ガイドを確認してください
  • 統合がセッション削除を正しく処理していることを確認してください(NOT_FOUNDでHTTP 400)

これらの更新についてご質問がある場合や、統合に関するサポートが必要な場合は、サポートチームまでお気軽にお問い合わせください。

エッジケース処理の例

年齢確認ガイドに包括的なエッジケース処理の例を追加し、フィールド存在ルールを明確にするために検証イベント契約を更新しました。

新機能

エッジケース処理の例

ウォーターフォールフローガイドに、検証エッジケースを処理するための詳細なコード例が追加されました。各例は、誤った処理パターンと正しい処理パターンの両方を示しています。

新しい例には以下が含まれます:

  • 部分的な試行(最大試行回数超過): ユーザーが確定的な年齢決定なしにすべての確認試行を使い果たした場合のmax-attempts-exceeded失敗理由の適切な処理
  • 不審な活動の検出: 適切なレート制限とセキュリティ対策を含む、fraudulent-activity-detected失敗理由のセキュリティ重視の処理
  • 完全なエッジケースハンドラ: すべてのパターンを一緒に示す包括的なTypeScriptの例

すべての例は、完全なフィールド存在ルールについて検証イベント契約に直接リンクしています。

検証イベント契約の更新

検証イベント契約が更新され、フィールド存在ルールが明確になりました:

  • ageageCategoryはPASSステータスの場合常に存在: PASSをもたらすすべての確認方法は、年齢情報と年齢カテゴリの両方を提供します。PASSステータスの結果を処理する際は、条件チェックなしでこれらのフィールドに安全にアクセスできます。
  • 年齢範囲の明確化: 確認方法によって正確な年齢が提供されない場合、age.lowは確認に必要な閾値の最小年齢となり、age.highは100となります。

更新されたドキュメント

モバイルアプリ統合ガイドとConnectIDテスト更新

k-IDウィジェットをモバイルアプリケーションに統合するのに役立つ包括的なモバイルアプリ統合ドキュメントを追加し、ConnectIDテストリソースを強化しました。

新機能

モバイルアプリ統合ガイド

新しいモバイルアプリクイックスタートガイドは、k-IDウィジェットをモバイルアプリケーションに統合するための包括的なドキュメントを提供します。このガイドでは以下をカバーしています:

  • プラットフォーム固有の実装方法: Android(Custom Tabs、WebView、Trusted Web Activity)とiOS(ASWebAuthenticationSession、SFSafariViewController、WKWebView)の詳細なガイダンス
  • AgeKeysサポート: どの実装方法がAgeKeysとWebAuthnをサポートしているかについての明確なドキュメント
  • 結果の通信: ウィジェット結果を受信する2つのアプローチ—コールバックURL(推奨)とDOMメッセージ
  • サードパーティアプリの確認フロー: ConnectIDなどの確認方法がサードパーティアプリを介してリダイレクトする方法の完全なドキュメント
  • 完全なコード例: iOS(Swift)とAndroid(Kotlin)の両方のステップバイステップの実装例と完全なコードサンプル

ConnectIDテストの強化

モバイルアプリテストリソースを使用したConnectIDテストドキュメントの強化:

  • モバイルアプリテストアプリ: モバイルアプリケーションで完全なリダイレクトフローを検証するために、iOS(TestFlight)とAndroid(Google Play)のConnectID Mock Bank Cテストアプリへのリンクを追加
  • テストセクションの更新: モバイルアプリリダイレクトフローテスト専用のサブセクションでConnectIDテストセクションを拡張

更新されたドキュメント

チェンジログの導入

新しいチェンジログセクションの導入をお知らせします!これは、開発者向けインターフェース、APIの動作、統合パターンの変更についてお知らせする一元化された場所として機能します。

新機能

チェンジログセクション

本日より、開発者向けの変更に関する更新を1つの便利な場所で確認できます。定期的に更新を投稿し、以下についてお知らせします:

  • APIの更新と変更: 新しいエンドポイント、パラメータの変更、非推奨事項
  • イベントシステムの更新: DOMイベントとWebhookの変更
  • インターフェースと動作の変更: 開発者向けインターフェースと統合パターンの更新
  • 破壊的変更: 統合に影響を与える可能性のある重要な更新

検証イベント契約

すべての検証結果データのフォーマット方法に関する信頼できるリファレンス資料を開発者に提供するため、検証イベント契約を導入します。この契約はDOMイベントとWebhookの両方に適用され、統合のための安定したリファレンスとして維持することをお約束します。

これが意味すること:

  • 一貫したイベント構造: すべてのイベントタイプで予測可能なイベントペイロード
  • 包括的なドキュメント: 統合を容易にする完全なイベントスキーマと例
  • 信頼できるリファレンス: 検証結果データのフォーマットに関する安定したリファレンス資料として、この契約を維持することをお約束します

イベント構造と統合での使用方法の詳細については、イベントドキュメントを参照してください。

最新情報を確認

このチェンジログをブックマークして定期的に確認するか、更新を購読してk-IDプラットフォームの最新の変更について常に情報を得てください。統合に影響を与える可能性のあるすべての更新について、お知らせすることをお約束します。

高レベルのプロダクト発表や機能リリースについては、リリースノートをご覧ください。

更新を購読

お好みのフィード形式でチェンジログを購読できます:

これらのフィードURLのいずれかをRSSリーダー、ニュースアグリゲーター、または監視ツールに追加すると、新しいチェンジログエントリが公開されたときに自動通知を受け取ることができます。

これらの更新についてご質問がある場合や、統合に関するサポートが必要な場合は、サポートチームまでお気軽にお問い合わせください。


これはチェンジログの最初のエントリです。開発者向けインターフェースと動作が変更される際は、引き続きここに更新を投稿します。