Webhooks(ウェブフック)
Webhooksを利用することで、k-IDエンジン内で発生するイベントをリアルタイムで受け取ることができ、 APIを定期的にポーリングしてデータの有無を確認する必要がなくなります。
Webhooksは、以下のようなさまざまな目的で利用することができます:
- チャレンジ完了結果の処理
- 年齢確認結果の処理
- k-IDセッションの変 更の処理
Setting Up Webhooks (ウェブフックの設定)
Webhooksは、Compliance Studio上で設定します。イベントが発生した際にk-IDエンジンが 呼び出すURLを指定することで構成されます。指定するURLは、HTTPSで保護されたセキュアなURLである必要があります。 k-IDエンジンは、イベントデータを含むJSON形式のペイロードをPOSTリクエストとして指定されたURLに送信します。
Webhooksは各Product単位で紐付けられます。複数のk-ID Productをお持ちの場合、同じエンドポイントを 使い回すことも可能ですが、APIコール(例:/session/get)を行う際には、対象Product専用のk-ID APIキーを必ず使用する必要がある点にご注意ください。
Webhooks can be configured on Developer Settings of a selected product. You can access this page at /products/[productId]/developer.

Webhooks Configuration Page(Webhooksの構成と管理ページ)
Webhooks セクションは、Developer Settings(開発者設定) 内にあり、特定のイベントが発生した際に k-ID(k-ID) が呼び出す HTTPS URL を設定することができます。アプリケーションに必要な Webhook の URL を入力し、Save(保存) をクリックすることで、設定内容がシステムに反映されます。変更内容は、現在の設定に基づいて自動的に適切な環境(Test Mode(テストモード) または Live Mode(ライブモード))に適用されます。詳しくは こちらのガイド をご参照ください。
これにより、テスト環境でも本番環境でも、イベント通知がアプリケーションに正しくかつ安全にルーティングされることが保証されます。
Note(注): Save(保存) ボタンは Push to Test(テストにプッシュ) や Publish Live(本番に公開) ボタンとは異なります。Webhookの保存や更新はユーザー体験に直接影響を与えることはありませんが、Push to Test(テストにプッシュ) や Publish Live(本番に公開) を使用して行う変更は、ユーザー体験全体に影響する可能性があり、k-ID(k-ID) チームによる事前の確認が必要になる場合があります。
さらに、エンドポイントが正しく設定されているかをシークレットの有無にかかわらず確認できる Test Webhook(Webhookテスト) ボタン があります。シークレットが設定されている場合、このボタンをクリックすると、Webhook エンドポイントに2件のリクエストが送信されます: 1) 有効な署名、2) 無効な署名。テストは、有効な署名のリクエストに対しては
200 OK を返し、無効な署名のリクエストに対しては 401 Unauthorized を返した場合にのみ合格となります。Webhookリクエストの検証方法については、ドキュメントの該当セクション をご覧ください。このボタンはテストイベントをシミュレートし、その内容は テストイベントに関するドキュメントセクション に記載されています。
Webhook Event Structure(Webhookイベント構造)
Webhook URL に送信される JSON ペイロードには、以下のフィールドが含まれます:
eventType- 発生したイベントの種類data- イベントに関連するデータ
また、イベントタイプを示す X-Event-Type ヘッダーも併せて送信されます。