APIの概要
k-ID APIは、k-IDと対話するためのHTTP RPCスタイルのWeb APIです。検証可能な親の同意（VPC）の開始、年齢確認の開始、プレイヤーの有効な権限の取得のためのメソッドを提供します。
API構造
k-ID APIは、HTTP RPCスタイルのメソッドのコレクションです。すべてのURLはhttps://{host}/api/v1/{method}の形式です。REST APIではありませんが、RESTに慣れ親しんでいる人は、HTTPを基盤とするその構造に馴染みがあるでしょう。すべてのAPIメソッドは、APIに副作用があるかどうかに応じて、GETまたはPOST HTTPメソッドを使用します。
引数は、GETメソッドの場合はクエリパラメータとして、POSTメソッドの場合はリクエスト本文のJSONとして渡されます。すべてのレスポンスはJSON形式です。
ベースURL
ライブモード:
https://game-api.k-id.com/api/v1/
テストモード:
https://game-api.test.k-id.com/api/v1/
エンドポイント
年齢ゲート
| エンドポイント | 説明 |
|---|---|
/age-gate/get-requirements | 管轄区域の年齢ゲート要件を取得 |
/age-gate/check-age-category | プレイヤーの年齢カテゴリをチェック |
/age-gate/check | 年齢をチェックし、セッションを作成または更新 |
/age-gate/get-default-permissions | 管轄区域のデフォルト権限を取得 |
セッション
| エンドポイント | 説明 |
|---|---|
/session/get | セッションIDまたはkuidでセッションを取得 |
/session/upgrade | セッション権限をアップグレード |
/session/update-jurisdiction | セッションの管轄区域を更新 |
/session/set-guardian-managed-session-permissions | 保護者管理のセッション権限を設定 |
チャレンジ
| エンドポイント | 説明 |
|---|---|
/challenge/get | チャレンジの詳細を取得 |
/challenge/get-status | チャレンジステータスを取得 |
/challenge/send-email | チャレンジメール通知を送信 |
/challenge/generate-otp | チャレンジ用のワンタイムパスワードを生成 |
年齢確認
| エンドポイント | 説明 |
|---|---|
/age-verification/perform-facial-age-estimation | 顔年齢推定確認を実行 |
/age-verification/perform-id-verification | ID文書確認を実行 |
/age-verification/perform-age-key-verification | AgeKey確認を実行 |
/age-verification/perform-connect-id-verification | ConnectID確認を実行 |
/age-verification/perform-trusted-adult-verification | 信頼できる大人の確認を実行 |
/age-verification/perform-inference | 推論ベースの確認を実行 |
/age-verification/perform-access-age-verification | すべての方法でアクセス年齢確認を実行 |
/age-verification/perform-age-appeal | 年齢異議申し立て確認を実行 |
/age-verification/perform-custom-age-verification | カスタム年齢確認を実行 |
/age-verification/get-status | 年齢確認ステータスを取得 |
ウィジェット
| エンドポイント | 説明 |
|---|---|
/widget/generate-age-gate-url | 年齢ゲートウィジェットURLを生成 |
/widget/generate-direct-notices-url | データ通知ウィジェットURLを生成 |
/widget/generate-manage-session-permissions-url | セッション権限管理ウィジェットURLを生成 |
/widget/generate-parental-consent-url | 親の同意ウィジェットURLを生成 |
/widget/generate-session-upgrade-url | セッションアップグレードウィジェットURLを生成 |
/widget/generate-e2e-url | エンドツーエンドウィジェットURLを生成 |
テスト
| エンドポイント | 説明 |
|---|---|
/test/set-challenge-status | チャレンジステータスを設定（テストのみ） |
/test/set-age-verification-status | 年齢確認ステータスを設定（テストのみ） |