ホーム / 製品 / API / REST Management API
API

REST Management API

デバイス群をプログラムで制御。Cams REST Management API では、ユーザーの追加・登録・削除、指紋・顔テンプレートや写真のプッシュ、アクセス時間の制御、ユーザーの有効化・無効化、勤怠ログの取得・再送を、安定したバージョン付きの REST 仕様で行えます。

概要

デバイスとユーザーのライフサイクル全体(プロビジョニング、コマンド、テンプレート、写真、アクセス時間、勤怠ログ)を管理する、バージョン付き(V1/V2/V3)の REST API です。

REST Management API は、Cams プラットフォームのデバイス管理コマンドレイヤーで、3 つの仕様バージョン(V1、V2、V3)をバージョンごとの検証・処理とともに並行して提供します。Cams 勤怠デバイス上のユーザーのライフサイクル全体 — ユーザー追加、テンプレート追加、写真追加、登録、削除、有効化・無効化、アクセス時間の更新、打刻ログの読み込みと再送、ユーザーの再送、再起動、初期化 — をカバーし、バージョン付きテンプレートのペイロードを、デバイスペアとマスター ID のマッピングによって正しいテナントへ振り分けます。リアルタイム取り込み API に対する、運用面の対となる API です。

APIRESTHTTPSJSONC++

対象ユーザー

デバイスのユーザー、生体テンプレート、勤怠ログをプログラムで管理する開発者および人事・給与システムのインテグレーター。

生体認証 REST APIデバイス管理 API勤怠デバイス API指紋テンプレート APIユーザー登録 API打刻ログ APIアクセス時間 APIバージョン付き REST API

機能

できること

ユーザー管理

デバイス上のユーザーの追加、登録、削除、有効化・無効化をプログラムで行います。

テンプレート & 写真のプッシュ

デバイス上での照合のために、指紋または顔テンプレートとユーザー写真をデバイスに送信します。

勤怠の取得

打刻ログを読み込み、必要に応じて勤怠レコードを再送します。

バージョン付き仕様

V1、V2、V3 を並行して提供するため、クライアントは自分のペースで移行できます。

デバイスの操作

デバイスを再起動・初期化し、ユーザーリストをリモートでプッシュまたは再送します。

特長

すべて含まれています

  • 3 つのバージョン付き API 仕様(V1、V2、V3)を、バージョンごとの検証とともに同時提供
  • ユーザーのライフサイクル: ユーザーの追加、登録、削除、有効化・無効化をプログラムで実行
  • 生体データ管理: ユーザーごとに指紋・顔テンプレートとユーザー写真をプッシュ
  • 勤怠アクセス: 打刻ログの読み込みと勤怠レコードの再送をオンデマンドで実行
  • アクセス制御: ユーザーごとのアクセス時間枠を更新
  • デバイス制御: デバイスのリモート再起動と初期化
  • バージョン付きテンプレートデータの解析(R20、R30)と、デバイスペアおよびマスター ID によるテナントのルーティング
  • 単一のオペレーションとパラメーターモデルに基づく、統一された GET/PUT コマンドエンベロープ

REST Management API で構築する

キーを取得し、ドキュメントを読んで、リリースしましょう。最初の連携は私たちのチームがサポートします。

よくある質問

よくある質問

REST Management API では何ができますか?

Cams デバイス上のユーザーと生体情報のライフサイクルを管理します。ユーザーの追加・登録・削除・有効化・無効化、テンプレートや写真のプッシュ、アクセス時間の設定、打刻ログの読み込みと再送、ユーザーリストの送信、デバイスの再起動・初期化が可能です。

どの API バージョンに対応していますか?

V1、V2、V3 が同時に提供され、それぞれが独自の検証・処理レイヤーを持つため、クライアントは自分のペースで移行できます。

指紋と顔のテンプレートに対応していますか?

はい。指紋または顔テンプレートと写真をプッシュする専用のオペレーションがあり、バージョン付きの R20 / R30 テンプレートペイロードを含め、生体認証の資格情報をプログラムからデバイスに送信できます。

関連情報

プラットフォームをもっと見る