メインコンテンツに移動

イベントの概要

k-IDは、ユーザーのアクションとシステムの変更にリアルタイムで対応できるように、DOMイベントとWebhooksの2種類のイベントを提供します。どちらのイベントタイプも、k-IDシステムの重要な変更に反応する応答性の高い統合を構築できます。

イベントとは？​

イベントは、アプリケーションで特定のアクションが発生したときにk-IDによって送信される通知です。これにより、以下が可能になります：

  • ユーザーのアクションに反応: ユーザーが確認を完了したり、同意を付与したり、ウィジェットと対話したりしたときに即座に対応する
  • アプリケーションの状態を更新: アプリケーションをk-IDの状態変更と同期させる
  • 非同期操作を処理: 長時間実行されるプロセスが完了したときに通知を受信する
  • リアルタイムエクスペリエンスを構築: 自動的に更新される応答性の高いユーザーインターフェースを作成する

DOMイベント​

DOMイベントは、Webサイトのiframeで実行されるk-IDウィジェットによって発行されるJavaScriptイベントです。これらのイベントは、ブラウザのpostMessage APIを介して送信され、標準のJavaScriptイベントリスナーを使用してリッスンできます。

DOMイベントを使用する場合​

  • 応答性の高いUI更新: ユーザーがウィジェットと対話したときにインターフェースを即座に更新する
  • クライアント側の対話: ブラウザでウィジェットの対話に反応する必要がある場合
  • リアルタイムのユーザーフィードバック: ユーザーに即座の視覚的フィードバックを提供する

主な機能​

  • iframe内のウィジェットから直接発行される
  • JavaScript messageイベントリスナーを介して受信される
  • セキュリティのためにオリジンの検証が必要
  • クライアント側JavaScriptアプリケーションと応答性の高いUIに最適

詳細については、DOMイベントを参照してください。

Webhooks​

Webhooksは、k-IDのサーバーからサーバーエンドポイントに送信されるHTTP POSTリクエストです。k-IDシステムの重要なイベントに関するサーバー間通知を提供します。

Webhooksを使用する場合​

  • データの整合性: データベースを確実に更新し、データの一貫性を維持する
  • サーバー側の処理: サーバーでイベントを処理する必要がある場合
  • 信頼性の高い配信: ユーザーが離れた場合でも処理する必要がある重要なイベント用
  • バックグラウンド処理: ユーザーの対話をブロックせずに非同期でイベントを処理する
  • 状態の同期: サーバーの状態をk-IDの状態と同期させる

主な機能​

  • 設定されたエンドポイントにHTTP POSTリクエストとして送信される
  • セキュリティ検証のために暗号化署名が含まれる
  • Compliance Studioで製品ごとに設定される
  • サーバー側統合、データの整合性、信頼性の高い状態管理に最適

詳細については、Webhooksを参照してください。

DOMイベントとWebhooksの選択​

両方のイベントタイプは異なる目的に役立ち、一緒に使用できます：

ユースケース推奨アプローチ
ブラウザでのリアルタイムUI更新DOMイベント
データの整合性と状態管理Webhooksまたはサーバー側API呼び出し
サーバー側処理とデータベース更新Webhooks
応答性の高いユーザーフィードバックDOMイベント
信頼性の高いイベント処理Webhooks
ウィジェットの対話DOMイベント
ベストプラクティス

応答性の高いUI更新にはDOMイベントを使用し、データの整合性と信頼性の高い状態管理にはwebhooksまたはサーバー側API呼び出し（/age-verification/get-statusや/challenge/get-statusなど）を使用してください。多くのアプリケーションは両方を使用し、即座のUIフィードバックにはDOMイベントを、信頼性の高いサーバー側処理とデータ永続化にはwebhooksを使用します。

はじめに​