Cams Biometric Gateway — Web API 3.0

The Cams Biometric Gateway is the universal Biometric API that connects any biometric attendance or access control machine with your application — ERP, HRMS, payroll, school management, custom software, or AI/automation workflow. It supports all major device brands and provides a standardised JSON-over-HTTP Biometric API regardless of the hardware.

38 の操作 — 11 のコールバック API(機器 → サーバー)と 27 の RESTful API(サーバー → 機器)。すべてのペイロードは HTTP/HTTPS 上の raw JSON です。
すべての生体認証機器に対応しています。Cams の機器、検証済み機器、他社ブランド(ZKTeco、Suprema、Hikvision、Anviz、Morpho/IDEMIA、Virdi、Mantra、Nitgen、Realtime/Startek、Biomax、Secugen、eSSL、Matrix COSEC ほか)に対応します。ご利用環境に適した接続モードをお選びください。

仕組み

Biometric Gateway は次の要素で構成されます。

ゲートウェイサーバーCams Protocol Engine(プロトコル変換、データ正規化、オフラインキャッシュ、認証)と、アプリケーションに一貫したインターフェースを提供する標準化 API レイヤーを備えたクラウドホスト型プラットフォームです。
Protocol Engineゲートウェイサーバーの中核エンジンです。生体認証機器と通信し、ベンダー固有のプロトコルを変換し、安全なデータトランザクションの記録とID管理を行います。
Protocol Engine Liteお客様ご自身のサーバー(Windows/Linux)にインストールできるオンプレミス版で、LAN のみの環境やセルフホスト環境向けです。API は同一で、ローカルに展開します。

連携先

OdooERPNextSAPMicrosoft Dynamics ZohoBitrix24 OrangeHRMBayZatPalmHRuKnowva FedenaTeachmintEduBricz RazorPayPayruler n8nMakeZapier Claude (MCP)GeminiChatGPT カスタム Web アプリ
お客様のアプリケーション
ERP HRMS Payroll 学校 ERP AI ワークフロー(n8n、Zapier) MCP — Claude · Gemini · ChatGPT カスタムアプリ
Biometric Gateway
Protocol Engine
安全な認証処理 データトランザクションの記録 プロトコル変換 オフラインキャッシュ & キュー AES-256 暗号化 · 認証トークン検証
標準化 API レイヤー
ID管理 AI / MCP 連携 コールバックディスパッチャー REST コマンドルーター データ正規化 · マルチブランドのプロトコル対応
インターネット
指紋 · 顔認証 · 手のひら静脈 · RFID カード · PIN · QR / バーコード · GPS 追跡
生体認証機器 — 全ブランド対応
Cams ZKTeco Suprema Hikvision Anviz Morpho / IDEMIA Virdi Mantra Nitgen Realtime Biomax Secugen eSSL Matrix + その他多数
API の種類方向レイテンシ用途
コールバック API機器 → お客様のサーバーリアルタイム / 遅延なし勤怠打刻やユーザー同期イベントの受信
RESTful APIお客様のサーバー → 機器約 15 秒ユーザーの追加/削除、ログの取得、生体データの登録

導入手順

3 つのステップで連携できます。コールバックを受信するため、お客様のサーバーには外部から到達可能な URL が必要です。

1

コールバック URL を設定する

API Monitor ポータルにログインし、お客様のサーバーの公開 HTTPS URL を機器のコールバック URL として設定します。API エンジンは生体認証イベントをこのエンドポイントにリアルタイムで POST します。

2

勤怠打刻を受信する

エンドポイントは raw JSON ボディの POST を受信します。コールバック API ではクエリパラメータは不要です。AuthToken を検証し、打刻データを解析して、{"status":"done"} を返してください。

3

RESTful API を呼び出してユーザーと機器を管理する

API Monitor アカウントに表示されている RESTful エンドポイント URL に、stgid(Service Tag ID)をクエリパラメータとして付けて JSON コマンドを POST します。エンジンはコマンドをキューに入れ、機器は約 15 秒以内に応答します。

エンドポイント形式

API の種類メソッド送信方法
コールバック API(受信) POST 機器がお客様が設定した URL に POST します。raw JSON ボディで、パラメータはありません。
RESTful API(送信) POST RESTful エンドポイント URL(API Monitor アカウントに記載)に、?stgid=YOUR_SERVICE_TAG_ID と raw JSON ボディを付けて POST します。
コールバックリクエストには必ず即座に応答してください。受信を確認するため、サーバーは {"status":"done"}(HTTP 200)を返す必要があります。応答前に重い処理を行わず、キューに入れてください。

API ドキュメント

リファレンスはトピック別に分かれています。まず機器の互換性を確認し、次にコールバックと REST の操作をご覧ください。

対応機器と接続モードゲートウェイが対応する機器、各機器の接続方法(Native Push または Hybrid Push)、各モードで利用できる API 操作について説明します。 API リファレンス:アーキテクチャ、フィールド、ステータスコードすべての操作に共通する構成要素:リクエストフロー、共通 JSON フィールド、テンプレートタイプ、ステータスコード、ポート、ペイロード暗号化。 コールバック API:機器からサーバーへのリアルタイムイベント機器がコールバック URL に送信するすべてのイベントと、サーバーが受信する JSON、および返すべきレスポンスを説明します。 RESTful API:サーバーから機器へのコマンドサーバーがゲートウェイ経由で機器に送るコマンドと、それぞれのリクエスト/レスポンス JSON を説明します。 API のローカルテスト本番環境へ展開する前に、開発マシンで機器のコールバックを受信し、Postman で REST コマンドをテストする方法を説明します。 PHP の例:生体認証勤怠データを MySQL に保存勤怠打刻を MySQL に保存する PHP のコールバックハンドラーの動作例を、3 つのステップで紹介します。 AI コード生成プロンプトプロンプトをお使いの AI アシスタントにコピーして、ご利用の技術スタック向けの連携コードを生成できます。 FAQ、SDK、費用連携担当者からよくいただくご質問と、SDK および API 料金の仕組みを説明します。

お問い合わせ

API サポート、機器の互換性、お見積りに関するお問い合わせ:

営業 & サポート

WhatsApp+91-98-409-21006 (サポート)

開発者向けリソース

Cams Biometrics(Dheeram Innovations Pvt Ltd) — No: 2/98D, 2nd Floor, Cams Biometrics Building, Opposite to Satyabama University, Semmancheri, OMR, Chennai – 600119, India.