メインコンテンツに移動

10件の投稿件のタグ「api」を含む

すべてのタグを見る

Permanently erase a session with a new flag on /session/delete

/session/delete can now permanently erase a session instead of only revoking it.

What's new​

  • confirmIrreversible on POST /session/delete. Set to true to permanently delete a player session and its embedded consent, scoped to the calling product. Unlike the default revoke (which is internally retained), this physically removes the record and can't be undone.
  • Opt-in per developer. Available only to developers explicitly enabled for hard delete. Setting confirmIrreversible: true without enablement returns FEATURE_DISABLED.
  • Every existing call is unaffected. Omitting confirmIrreversible, or setting it to false, behaves exactly as /session/delete always has: a reversible revoke.
  • In-flight challenges are failed too. Any pending challenge tied to that exact session is set to FAIL, scoped to that session only (other sessions for the same player are untouched).

Documentation​

クレジットカード専用の年齢確認エンドポイント

クレジットカードのみを方式として年齢確認を実行するための専用エンドポイント /age-verification/perform-credit-card-verification が追加されました。これは、既存の単一方式エンドポイント（ID、AgeKey、ConnectID）と並ぶものです。

新機能​

  • POST /age-verification/perform-credit-card-verification。 自動的な方式選択をバイパスし、クレジットカードのみでユーザーを確認します。他の単一方式エンドポイントと同じリクエスト形式（jurisdiction、subject、criteria、および任意の options.redirectUrl / options.locale）を受け取り、id、url、shortUrl を返します。
  • 成人（18歳以上）の保証。 クレジットカード確認は、正確な年齢推定ではなく成人であることの保証シグナルです。カードの所有が成人に限定されている法域に最も適しています。
  • ステータスと結果は変更なし。 これまでどおり /age-verification/get-status をポーリングするか、Verification.Result webhook を処理してください。結果は確認 method として credit-card を報告します。

ドキュメント​

Redirect URL for Automatic age assurance flows

/age-gate/check now accepts a redirect URL that k-ID navigates to once an Automatic age assurance challenge completes. This is intended for top-level browser handoffs (such as a mobile webview that bounces out to k-ID and back) where an iframe-based result handler isn't an option.

What's new​

  • options.playerAgeAssurance.redirectUrl. Pass an http(s) URL or a custom-scheme mobile deeplink (for example myapp://age-gate/return) on /age-gate/check. After the player completes or dismisses the CHALLENGE_AGE_GATE_AGE_ASSURANCE flow, k-ID redirects to that URL with challengeId, productId, sessionId (on PASS), and status (PASS or FAIL) appended as query parameters. Existing query parameters on the URL are preserved.
  • Scope. The option is only honored for CHALLENGE_AGE_GATE_AGE_ASSURANCE. CHALLENGE_PARENTAL_CONSENT is unaffected and continues to return through the trusted-adult flow.
  • Confirm outcomes server-side. The redirect query parameters are a UX hint. Treat the Challenge.StateChange webhook or /challenge/get-status as the source of truth before granting access.

Documentation​

レート制限のドキュメント

k-ID APIおよびユーザー向けの年齢確認・保護者同意フローのデフォルトレート制限を、専用ページに掲載しました。

新機能​

  • APIレート制限。 k-ID APIへの呼び出しはプロダクト単位で制限されます：ライブモードでは500 RPS、テストモードでは10 RPS。制限を超えたリクエストはHTTP 429 Too Many Requestsを返します。
  • 年齢確認および保護者同意フローのレート制限。 ユーザー向けフローはプロダクト単位で制限されます：ライブモードでは100 RPS、テストモードでは20 RPS。制限に達すると、ユーザーには「しばらく待ってから再試行してください」というインフロー上のエラーが表示されます（429はサーバーには通知されません）。
  • 引き上げのリクエスト。 これらはデフォルトです。プロダクトでより高い容量が必要な場合は、k-IDの担当者にご連絡ください。
  • ローンチ前チェックリストを更新。 ライブモードの上限値はテストモードと比べて大幅に高くなるため、CDKおよびAgeKit+のローンチ前チェックリストの両方で、レート制限を明示的に取り上げ、新しいページへリンクするようにしました。

ドキュメント​

年齢確認APIレスポンスの短いURLフィールド

年齢確認を作成するエンドポイント（POST /age-verification/perform-access-age-verification やその他の perform-* 年齢確認ルートなど）のレスポンスに、id および url に加えて shortUrl が含まれるようになりました。

新機能​

  • 短いリンク: shortUrl は、完全な url と同じ確認体験へリダイレクトする短いリンクです。クエリ文字列が長いと扱いにくい場合（QRコードや、ユーザーが別端末で確認を完了する場合など）に使えます。
  • 完全なURLは従来どおり: セッションの JWT は引き続き完全な url の token クエリパラメータにあります。その URL を独自に短縮したり再構築したりしないでください。
  • 不透明な値: shortUrl は不透明な文字列として扱い、返却されたとおりに表示・エンコードしてください。パスやクエリの形式は将来変わる可能性があるため、固定形式に依存しないでください。

詳しく見る​

プラットフォーム年齢シグナルのドキュメント

Apple iOS、Google Play、Xbox、Meta Horizon、k-ID の年齢データが k-ID にどう取り込まれるか、年齢ゲートを表示しなくてよいケース、および 検証済み と 未検証 のシグナルが高リスク権限や年齢保証とどう関わるかを説明する、プラットフォーム年齢シグナル のエンドツーエンドドキュメントを公開しました。

新機能​

CDK — プラットフォーム年齢シグナル​

  • プラットフォーム年齢シグナル — クイックな統合パス、API マップ、推奨リクエスト順、POST /age-gate/check でのプラットフォームシグナルの扱い、対応プラットフォームと 検証済みの declarationType、検証済みと未検証のシグナルの動作。
  • プラットフォームシグナルの詳細 — プラットフォームごとのフィールド形、各ネイティブシグナルの取得方法、エンドポイント別の説明（get-requirements、check、get-default-permissions、session/get、get-platform-age-range、session/upgrade）、バリデーション、年齢の衝突、k-id シグナルのルール。

コンセプトと関連ドキュメント​

  • 年齢シグナル — プラットフォーム年齢シグナルが他のシグナル種別とどう並ぶか、PlatformAgeSignal の統合詳細への参照先。
  • 高リスク機能用の年齢保証 および 権限 — verifiedAgeThreshold と年齢ゲートでの検証済みプラットフォームシグナルに関する相互リンクの挙動。

API リファレンス（OpenAPI）​

セッションアップグレード、AgeVerification、platformAgeSignal の説明を、上記ドキュメントと揃えて 検証済みプラットフォームシグナル の表現に統一しました。

ドキュメント​

Account System Product

Account System Product をリリースしました。組織の中央アカウントまたはプラットフォームプロダクトが、1 つの API キーとオプションのヘッダーを使用して、組織内の他のプロダクトに代わって認証チャレンジとセッションを作成できる機能です。

新機能​

Account System Product​

Compliance Studio でプロダクトを Account System Product として有効にすると、Kid-Target-Product-Id ヘッダーにターゲットプロダクトの ID を付けて、同じ組織内の他の（Account System Product 以外の）プロダクトに代わって特定の k-ID API を呼び出せます。Account System Product の API キーを使用するため、ターゲットごとのキー管理やローテーションは不要です。

対応エンドポイント:

保護者はターゲットプロダクトの設定（通知、権限、ブランディング）のみを確認します。Account System Product とターゲットプロダクトの両方に、各イベントの Webhook が送信され、onBehalfOfProductId と initiatedByProductId でクロスプロダクトのフローを識別できます。

Account System Product は マルチプロダクト承認 と連携します。Account System Product をターゲットの必須プロダクトに設定すると、保護者が 1 回のフローで両方を承認できます。

ドキュメント​

追加の法的リンクと Check age gate の options

追加の法的リンク（Developer Details）と Check age gate API の options パラメータについてドキュメントを追加しました。同意フローでプラットフォーム別の法的文書（Xbox、PlayStation、Steam など）を表示できるようになります。

新機能​

追加の法的リンク（Developer Details）​

Compliance Studio のプロダクト 開発者の詳細 タブで、同意フローに表示される任意の 追加の法的リンク を追加できます。

  • タイトルとリンク: ローカライズされた表示タイトルと URL（メインの法的文書と同じ言語オプション）。
  • バリアント ID: Check age gate API 呼び出し時に使用する識別子（例: xbox-tos、playstation-privacy-policy）。常に表示がオフの場合は必須です。
  • 常に表示: オン（デフォルト）の場合、同意フローで常にリンクが表示されます。オフの場合、ゲームが options で一致するバリアント ID を指定して年齢ゲート API を呼び出したときのみ表示されます。

ゲームが複数プラットフォームで配信され、プラットフォームごとに異なる法的文書 URL が必要な場合にご利用ください。

Check age gate API — options パラメータ​

POST /api/v1/age-gate/check のリクエストボディで、任意の options オブジェクトを指定できます。

  • termsOfServiceDocument: 利用規約のバリアント ID（設定した追加の法的リンクと一致すること）。
  • privacyPolicyDocument: プライバシーポリシーのバリアント ID（設定した追加の法的リンクと一致すること）。
  • additionalLegalLinks: 利用規約およびプライバシーポリシーと一緒に表示する追加の法的文書のバリアント ID の配列（各 ID は設定した追加の法的リンクと一致すること）。

チャレンジが作成されると、同意画面ではプロダクトのデフォルトのプライバシーポリシー・利用規約ではなく、リクエストされた法的リンクが表示されます。

ドキュメント​

Age Gate Widget Redirect URL サポート

Age Gate WidgetエンドポイントにredirectUrlをオプションパラメータとして追加しました。

新機能​

Age Gate Widget API の更新​

/widget/generate-age-gate-urlエンドポイントは、optionsオブジェクト内にオプションのredirectUrlパラメータをサポートするようになりました。これにより、Age Gate Widget完了後にリダイレクトするURLを指定できます。これは、エンドツーエンドウィジェットエンドポイントと同様です。

redirectUrlパラメータは、HTTP/HTTPS URLまたはカスタムプロトコルスキームを使用したモバイルディープリンクをサポートします。

更新されたAPI​

Widget.ExitReviewの明確化とAPIの更新

年齢確認とVPCフローのウィジェットUIをいつ閉じるかを明確にし、MegaWidgetOptionsスキーマにredirectUrlサポートを追加しました。

新機能​

Widget.ExitReviewの明確化​

年齢確認とVPCフローのUIをいつ閉じるかを判断するシグナルとして、Widget.ExitReviewを使用することを明確にするためにドキュメントを更新しました。

更新されたドキュメント:

  • 年齢確認ガイド - 確認UIを閉じるためにWidget.ExitReviewをリッスンするガイダンスを追加
  • VPCガイド - VPCウィジェットUIを閉じるためにWidget.ExitReviewをリッスンするガイダンスを追加
  • CDK埋め込みフロー - ウィジェットUIを閉じるためにWidget.ExitReviewをリッスンするガイダンスを追加

すべての言語バージョン（英語、日本語、簡体字中国語、韓国語）がこの明確化で更新されました。

APIの更新​

MegaWidgetOptionsでのredirectUrl​

MegaWidgetOptionsスキーマに、年齢確認リクエストスキーマと一貫性のあるredirectUrlサポートが含まれるようになりました。これにより、エンドツーエンドウィジェットを使用する際にリダイレクトURLを指定できます。

更新されたスキーマ:

  • MegaWidgetOptionsに#/components/schemas/RedirectUrlへの参照を持つredirectUrlフィールドが含まれるようになりました

この変更は、すべてのOpenAPI仕様ファイル（英語、日本語、簡体字中国語、韓国語）で利用できます。

ドキュメントの改善​

プロダクト画像の仕様​

Compliance Studioのプロダクト画像の推奨アスペクト比と解像度を追加しました:

  • ロゴ: 1:1（正方形）、512×512px
  • バナー: 3:1（横長）、2430×810px