Webhooks(ウエブフック)

Webhooks を使用すると、k-ID エンジン内で発生しているイベントをリアルタイムで購読できます。これにより、API をポーリングしてデータが利用可能かどうかを確認する必要がなくなります。

Webhooks は、さまざまな目的に使用できます。例えば：

1. 成人認証結果の処理
2. 年齢保証結果の処理

Webhooks の設定

Webhooks は、Publisher Portal で設定します。イベントが発生した際に k-ID エンジンが呼び出す URL を指定します。この URL は、セキュアな HTTPS URL でなければなりません。k-ID エンジンは、イベントデータを含む JSON ペイロードを持った POST リクエストをこの URL に送信します。

Webhook イベント構成

Webhook URL に送信される JSON ペイロードには、次のフィールドが含まれます：

• eventType - 発生したイベントの種類。
• data - イベントに関連するデータ。

イベントタイプを含む X-Event-Type ヘッダーも一緒に送信されます。

将来的には、リクエストの信頼性を確認するために、追加のヘッダーも送信される予定です。

Webhook イベント種類

利用可能なイベントタイプは次のとおりです：

• AdultVerification.Result
• AgeAssurance.Result

大人認証結果

プロパティ：

• id - 一意の認証 ID。
• status - PASS または FAIL可能なステータス
• ageRange (任意) - Details about the estimated age range.

ageRange プロパティ：

• minAge - 推定される最小年齢
• maxAge - 推定される最高年齢

例のペイロード:

{
  "eventType": "AdultVerification.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS"
  }
}

年齢保証結果

プロパティ：

• id - 一意の認証 ID。
• status - PASS または FAIL可能なステータス
• ageRange (任意) - Details about the estimated age range.

ageRange プロパティ：

• minAge - 推定される最小年齢
• maxAge - 推定される最高年齢

例のペイロード:

{
  "eventType": "AgeAssurance.Result",
  "data": {
    "id": "5a58e98a-e477-484b-b36a-3857ea9daaba",
    "status": "PASS",
    "ageRange": {
      "minAge": 18,
      "maxAge": 25
    }
  }
}