メインコンテンツに移動

開発者設定

プロダクト詳細ページの開発者設定タブには、k-IDをプロダクトに統合するために必要な技術的設定が含まれています。APIキー、Webhookエンドポイント、ターゲットオリジン、API URLが含まれます。

APIキー

各プロダクトにはテスト環境とライブ環境で別々のAPIキーがあり、開発と本番のトラフィックを分離します。

キータイプ用途設定ソース
テストAPIキー開発とテストテスト環境の設定
ライブAPIキー本番環境公開済みのライブ設定

キーの作成

  1. プロダクトのDeveloper Settingsタブに移動します。
  2. API Keysセクションで環境(TestまたはLive)を選択します。
  3. 作成ボタンをクリックし、キーに名前を付けます(例: 「Production Server」、「Staging Environment」)。
  4. キーが生成され表示されます。フルキーは再度表示されないため、すぐにコピーしてください。

開発者設定

環境ごとに複数のキーを作成できます。異なるサービスやデプロイステージに独自のキーが必要な場合に便利です。例えば、ゲームサーバーとアナリティクスパイプラインで別々のキーを使用するなどです。

キーのセキュリティ

APIキーはサーバーサイドに保管し、クライアントサイドのコードに公開しないでください。パスワードと同様に扱ってください。

  • キーは環境変数またはシークレットマネージャーに保管する
  • キーをソース管理にコミットしない
  • クライアントサイドのJavaScript、モバイルアプリバンドル、またはエンドユーザーに配布されるコードにキーを含めない

キーが漏洩した場合は、開発者設定ページから即座に取り消し、新しいキーを作成してください。

Webhook

Webhookを使用すると、チャレンジの状態変更、認証結果、セッションパーミッションの更新など、重要なイベントが発生した際にk-IDがサーバーに通知します。

Webhookの設定

テスト環境とライブ環境で別々のWebhookエンドポイントを設定します。

  1. Webhooksセクションで環境を選択します。
  2. Webhook URLを入力します。これは、k-IDからのPOSTリクエストを受信するサーバー上のエンドポイントです。
  3. 設定を保存します。

利用可能なイベントタイプ

Webhookイベントは、コンプライアンスライフサイクルの重要な瞬間をカバーします。

  • チャレンジの状態変更
  • 認証結果
  • 認証の取り消し
  • 保護者の同意の付与
  • セッションパーミッションの変更
  • セッションの削除
  • テストイベント(Webhookセットアップの検証用)

Webhookイベントタイプ

各Webhookデリバリーにはシグネチャヘッダーが含まれており、リクエストがk-IDから発信されたことを確認するために検証する必要があります。ペイロード構造やシグネチャ検証を含むWebhookイベントの完全なリファレンスについては、Webhooksをご覧ください。

ターゲットオリジン

クライアントサイドインテグレーションで許可するオリジン(ドメイン)を設定します。k-IDウィジェットまたはクライアントサイドAPIを使用する場合、リクエストはこれらのオリジンに対して検証され、不正な使用を防止します。

開発、ステージング、本番のドメインを追加します。各オリジンは完全なオリジンURLである必要があります。例:

  • https://yourgame.com
  • https://staging.yourgame.com
  • http://localhost:3000(ローカル開発用)
ヒント

ローカル開発URLを含む、インテグレーションが実行されるすべての環境を追加してください。このリストにないオリジンからのリクエストは拒否されます。

API URL

プロダクト詳細ページには、両方の環境のAPIベースURLが表示されます。これらは、サーバーがk-ID APIにリクエストを行う際に使用するURLです。

環境用途
テストAPI URL開発中にテストAPIキーとともに使用
ライブAPI URL本番環境でライブAPIキーとともに使用

プロダクトの開発者設定ページに表示されるURLを使用してください。手動で構成しないでください。