ホーム / 製品 / API / Biometric Gateway Web API

API

Biometric Gateway Web API

Biometric Gateway Web API(Universal Biometric Web API 3.0 とも呼ばれます)は、対応する指紋、顔、手のひら、静脈、虹彩、網膜、カード、パスワードのいずれのデバイスも、世界中どこからでもアプリケーションが通信できる、クラウド接続のエンドポイントに変えます。打刻が発生した瞬間にリアルタイムで受信し、デバイス上のユーザーをリモートで管理できます。すべて、シンプルな REST と Callback の仕様で行えます。

はじめる開発者ドキュメント

概要

インターネットに接続できる生体認証の勤怠・アクセス制御デバイスを、HTTP 経由でお客様の Web アプリケーションに直接接続します。ローカルソフトウェア、PC、データベースは不要です。

Cams の主力 Web API は、遠隔地に設置された生体認証デバイスとお客様のサーバーアプリケーションの間の、マシン間通信を実現します。デバイスがインターネットに接続すると、勤怠が Callback(webhook)URL にリアルタイムでプッシュされ、お客様のサーバーは、ユーザーの追加・削除、テンプレートのプッシュ、写真のプッシュ、打刻ログの読み込みといったデバイス操作を RESTful な呼び出しで実行します。デスクトップソフトウェアのインストールも、ローカルデータベースの運用も、LAN 上に PC を常時稼働させておく必要もありません。この API はデータベースに依存せず、どのバックエンド言語でも使えます。

APIRESTCallback/Webhook(HTTP POST)MQTT(EMQX 永続接続経路)PHPPythonJavaNode.js

活用事例:ビジター管理イベント、フェス & スタジアム

Callback(webhook)— リアルタイム打刻

# Your Callback URL receives every punch in real time
POST https://yourapp.com/cams/callback
{
  "DeviceSN": "SN7A2300583",
  "EmployeeCode": "1042",
  "AttendanceLog": "2026-06-21 09:02:14",
  "Type": "face",
  "Direction": "CheckIn"
}

機能

できること

リアルタイム勤怠

打刻は、デバイスに記録された瞬間に Callback URL へプッシュされます。

リモートのユーザー管理

サーバーから RESTful な呼び出しで、ユーザーの追加、削除、ブロック、移動、テンプレートや写真のデバイスへのプッシュができます。

マルチモーダルキャプチャ

一つの仕様で、指紋、顔、手のひら、静脈、虹彩、網膜、カード、パスワードの入力を扱えます。

オフライン耐性

オフライン中の打刻はデバイスにバッファされ、接続が復旧すると順序どおりに再送されます。

暗号化された通信

デバイスごとに AES-256 による生データの暗号化を有効にでき、安全なデータ交換を実現します。

特長

すべて含まれています

Callback(webhook)API が、ポーリングによる遅延なしに、リアルタイムの勤怠打刻をデバイスからサーバーへ配信します
サーバーからデバイスへの操作のための RESTful API: Add User、Add User with Templates、Add User Photo、Delete User、Delete All Users、Load Punchlog など(38 オペレーション)
打刻ごとに複数の入力タイプを取得: 指紋、顔、カード、手のひら、指静脈、虹彩、網膜、パスワード。ハードウェアが対応していれば、体温とマスク着用のフラグも取得
打刻タイプ: CheckIn、CheckOut、BreakIn、BreakOut、OverTimeIn、OverTimeOut、MealIn、MealOut
オフライン打刻に対応: キューに溜まったデータは、デバイスの再接続時に順序どおりに送信されます
やり取りするすべての生データを、API Monitor で設定したセキュリティキーによる AES-256 で暗号化(オプション)
LoadLog API により、サーバーを持たないアプリや LAN 内のみのアプリでも、最大 30 日分の勤怠履歴をオンデマンドで取得できます
堅牢なエラー処理のためのステータスコードを文書化。サポートや突合のために、デバイスごとの AuthToken と OperationID でトレースできます