あらゆるデバイスに共通の仕様。5 つの機能グループにわたる 38 のオペレーションを、同期型の REST 呼び出しと、リアルタイムの Callback webhook で利用できます。
すべての REST 呼び出しは、バージョン付きの単一ホストに対して行います。
https://api.camsbiometrics.com/v3/
すべてのリクエストには、お客様のアカウントとデバイスに紐づく AuthToken を付与します。キーは開発者ポータルから発行されます。
フォームエンコードまたは JSON でリクエストできます。レスポンスは JSON で、フィールドとエラーコードは予測しやすい形式です。
2 つの連携方法
ゲートウェイを呼び出すと、すぐに答えが返ります。勤怠の取得、ユーザーの一覧、登録、必要なときのドア開錠に最適です。
URL を登録すると、デバイスが報告した瞬間にゲートウェイがイベントをプッシュします。ポーリングは不要で、失敗時は自動でリトライします。
オペレーション
機能ごとにグループ化しています。名前は基盤となるゲートウェイのエンドポイントと 1:1 で対応します。
アカウント全体で、指定した期間内のすべての打刻。
指定期間における、単一の従業員コードのログ。
1 台のデバイス(シリアル番号)で記録された打刻。
従業員ごと・日ごとの集計(出勤/退勤、時間)。
従業員ごと・日ごとの、初回入場/最終退場のペア。
本日の打刻のライブスナップショット。
対応デバイスで、打刻に紐づいて撮影された写真。
給与計算や突合のための一括エクスポート。
1 台以上のデバイスにユーザーを作成。
氏名、ロール、有効期間、権限を編集。
デバイスからユーザーを削除。
コードでユーザーを検索(資格情報はオプション)。
デバイスに登録されている全員を一覧。
ユーザーが存在するデバイスを表示。
指紋テンプレートをデバイスにプッシュ。
対応デバイスに顔テンプレートを登録。
RFID / 近接カードをユーザーに割り当て。
デバイスの PIN / パスワードを設定・変更。
デバイス間でユーザーとテンプレートを複製。
ユーザーのデータをデバイスのキューに再送。
ドアリレー、ターンスタイル、フラップ、スイング、ブームバリアをリアルタイムに作動。
お客様の制御下でドアをロック / 保持。
現在の開 / 閉の状態を取得。
時間帯に基づくアクセス許可枠を定義。
入退室およびドアイベントのログ。
接続中のすべてのデバイスの一覧。
モデル、ファームウェア、容量、カウンター。
オンライン状態、最終確認時刻、キューの深さ。
デバイスへの到達性を今すぐ確認。
デバイスの時計をサーバーに合わせる。
デバイスをリモートで再起動。
キューに詰まったコマンドを消去。
キューに入ったコマンドの状態を追跡。
ライブイベントを受け取る webhook URL を登録。
打刻のたびにリアルタイムで発火します。
オンライン / オフラインおよびヘルス状態の遷移。
テンプレートがデバイスに反映されたときの確認通知。
デバイス / データの一括移行の進捗を追跡。
予測しやすいレスポンス
| コード | 意味 | 対処方法 |
|---|---|---|
200 | 成功 | JSON ペイロードを処理してください。 |
401 | AuthToken が無効または未指定 | API キーとデバイスのペアリングを確認してください。 |
404 | デバイスまたはユーザーが見つかりません | シリアル番号 / 従業員コードを確認してください。 |
409 | デバイスがオフライン / キューに登録済み | コマンドはキューに登録されています。GetCommandStatus をポーリングしてください。 |
429 | レート制限 | 待機してから、ジッターを加えて再試行してください。 |
BiometricAPI.com のアクセス測定とサービス改善のために Cookie を使用します。分析は同意いただくまで無効のままです。詳細を見る。