テスト
k-ID統合をテストすることは、公開前に正しく動作することを確保するために不可欠です。このガイドでは、k-IDプラットフォームで利用可能なテスト戦略とツールについて説明します。
テストモードとライブモード
k-IDは、テストと本番環境の2つの環境を提供します:
テストモード
テストモード により、開発者は実際のデータや本番システムに影響を与えることなく統合をテストできます。テストモードAPIキーを使用する場合、リクエストはhttps://game-api.test.k-id.comのテスト環境に送信されます。この環境は、ライブシステムをシミュレートするように設計されていますが、モックデータで動作します。
ライブモード
ライブモード は本番環境で使用されます。ライブモードAPIキーを使用する場合、リクエストはhttps://game-api.k-id.comの本番環境に送信されます。この環境は実際のデータを処理し、ライブシステムと対話します。
注意: 本番データに意図しない影響を与えないように、意図したモードに正しいAPIキーとエンドポイントを使用していることを常に確認してください。
インタラクティブAPIリファレンスでのテスト
k-ID APIを呼び出すコードを書く前に、ドキュメントに組み込まれているインタラクティブAPIリファレンスを使用してエンドポイントを直接テストできます。Compliance Studioで製品の開発者設定ページに移動して、テストAPIキーを取得してください。
APIテストの設定
-
APIリファレンスの任意のエンドポイントページに移動します。たとえば、
/age-gate/checkエンドポイントです。 -
ベースURLを選択: リクエストインターフェースのベースURLフィールドにマウスを合わせて、編集ボタンを表示します。編集ボタンをクリックし、テスト環境(
https://game-api.test.k-id.com/api/v1/)を選択します。 -
リクエストを認証: テストAPIキーを「Bearer Token」フィールドに貼り付けます。
-
リクエスト本文を設定: 必要に応じてリクエスト本文の値を変更します。テストには以下を使用します:
{
"jurisdiction": "US-CA",
"dateOfBirth": "2005-04-15"
} -
リクエストを送信: 「Send API Request」をクリックしてAPI呼び出しを完了します。
-
レスポンスを表示: レスポンスはリクエストインターフェースの下に表示され、APIのリクエストへの応答が示されます。
これで、k-IDへの呼び出しが正常に完了しました!インタラクティブリファレンスの使用に関する詳細については、インタラクティブリファレンスガイドを参照してください。
信頼できる大人の同意のテスト
Family Connectでの親エクスペリエンスを確認するには、同意チャレンジを作成する必要があります。そのためには、インタラクティブリファレンスを使用して/age-gate/checkに別の呼び出しを行います。今回は、米国管轄区域でデジタル同意年齢未満の子供の年齢を使用します。
以下を使用します:
{
"jurisdiction": "US-CA",
"dateOfBirth": "2015-04-15"
}
これにより、次のようなレスポンスが返されます:
{
"challenge": {
"challengeId": "<guid>",
"childLiteAccessEnabled": false,
"oneTimePassword": "<one time password>",
"type": "CHALLENGE_PARENTAL_CONSENT",
"url": "https://family.k-id.com/authorize?otp=<one time password>"
},
"status": "CHALLENGE"
}
その後、ブラウザでurlフィールドのURLに移動できます。メールアドレスの入力を求められ、Family Connectへのリンクが含まれたメールを受信します。そこで、ゲームへの同意を付与できます。ブラウザで同意フローを完了したら、以前に提供されたchallengeIdフィールドでchallenge/get-status APIを呼び出すことができます。レスポンスは次のとおりです:
{
"approverEmail": "email@example.com",
"sessionId": "<guid>",
"status": "PASS"
}
これで、k-ID Sessionが正常に作成されました!/session/getにsessionIdフィールドをパラメータとして提供することで、それを確認できます。
{
"ageStatus": "DIGITAL_MINOR",
"dateOfBirth": "2015-04-15",
"etag": "<guid>",
"jurisdiction": "US",
"permissions": [],
"sessionId": "<guid>",
"kuid": "<guid>",
"status": "ACTIVE"
}