Webhook連携を設定することで、Safie Entrance での顔認証時に認証データを連携先に送信する事ができます。連携先は3件まで設定可能です。
Webhook 設定手順
１、[管理者メニュー]→[管理設定]タブを表示します。[Webhook設定]の枠内に、現状設定されているWebhook連携の連携先名とURLのリストが表示されます。Webhook登録ボタンをクリックします。
２、Webhook登録画面が表示されます。 連携先のWebhook名、Webhook URL、Secretキーを入力します。Secretキーは入力しなかった場合、自動で設定されます。
３、登録が完了すると下記の登録完了画面が表示され、リストに反映されます。
Webhookのペイロード
Webhook設定で指定されたURLに対して、以下の情報がPOSTメソッドでリクエストされます。
Header
| ヘッダー名 | 内容 |
| X-ENTRANCE-SECRET | Webhook登録時のシークレット文字列 |
Body（JSON）
| プロパティ名 | 型 | 必須 | 内容 |
| event | string | ◯ | 通知するイベントを表す文字列 ・detection: 顔認識 |
| data | object | ◯ | 各eventに対応したオブジェクト |
detectionイベントデータ
| プロパティ名 | 型 | 必須 | 内容 |
| detection_id | number | ◯ | ID |
| timestamp | string | ◯ | 顔認識した日時 (RFC3339) |
| is_recognized | boolean | ◯ | 人物を認識できたかどうか |
| is_realtime | boolean | ◯ | リアルタイム情報かどうか ネットワーク切断時の認識結果を、ネットワーク復旧後に再送する場合があります |
| is_allowed | boolean | ◯ | 認識した人物に権限があるかどうか スケジュール設定や利用期限が設定されている場合、認識できても拒否される場合があります また、リアルタイム情報でない場合は必ずfalseになります |
| temperature | number | 温度 温度測定に対応した顔認証端末による認識結果の場合のみ出力されます | |
| person | object | 認識した人物情報 人物を識別できた場合のみ出力されます | |
| person_id | number | ◯ | 人物ID |
| name | string | ◯ | 人物名 |
| terminal | object | ◯ | 認識した顔認証端末 |
| terminal.terminal_id | number | ◯ | 顔認証端末ID |
| terminal.serial | string | ◯ | 顔認証端末のシリアル |
| terminal.name | string | ◯ | 顔認証端末名 |
リクエスト例
{
“event”: “detection”,
“data”: {
“detection_id”: 1,
“timestamp”: “2022-12-10T16:55:18+09:00”,
“is_recognized”: true,
“is_realtime”: true,
“is_allowed”: true,
“temperature”: 36.2,
“person”: {
“person_id”: 1,
“name”: “人物名”
},
“terminal”: {
“terminal_id”: 1,
“serial”: “5C18R000000”,
“name”: “端末名”
}
}
}