顔認証入退室管理システム 開発者向けドキュメント

FaceSec® 顔認証入退室管理システムを業務システムと連携させたり、デバイス上で動作する独自アプリを開発したりするための技術資料です。REST APIによる外部連携、認証フローへの自社処理の組み込み、Androidアプリ開発の各分野の資料をご用意しています。

用途から選ぶ

連携APIは2種類あります。FaceOS WebService API はデバイスに直接アクセスする方式、FaceCloud SaaS API は管理プラットフォーム（CMP）を経由する方式です。データの向きも2通りあり、業務システムからデバイスを呼び出すAPIに対して、PUSH はデバイス側から業務システムへ送る方式です。自社開発のAndroidアプリを使う場合は2通りあり、ODSL は弊社の標準アプリはそのままに、認証フローの決められた位置で自社アプリを呼び出す方式、SDK は弊社の標準アプリ自体を自社開発のアプリに置き換える方式です。

ドキュメント

WEB FaceOS WebService API V2.6-7 ／ Web閲覧 ／ 英語

デバイスのREST API仕様書。認可（ログイン・ログアウト）、通行ルール管理、利用者管理、データ管理、デバイス管理の各エンドポイントを収録しています。
識別記録のPUSH（HTTP）も本書に含まれます。認証のたびにデバイスが識別記録をJSON形式で指定のHTTPサーバーへ送信するため、受け取った側で必要な項目を取り出し、そのまま業務処理につなげられます。

収録内容（全4章）を見る

• 1.はじめに（用語・デバイスのモード・利用の前提条件）
• 2.代表的なユースケース（ログイン・利用者の配信・編集・入退室記録・統計・識別記録のPUSH設定）
• 3.インターフェース詳細（認可／ルール／利用者／データ管理［識別記録のPUSH］／デバイス管理）
• 4.付録（設定エクスポートXMLの内容）

WEB FaceCloud SaaS API V2.6 ／ Web閲覧 ／ 英語

管理プラットフォーム（CMP）のREST API仕様書。利用者・組織・デバイス・通行ルール・認証記録の管理と、PUSH通知の受信方法を収録しています。

収録内容（全8章）を見る

• 1.概要
• 2.APIの改訂履歴
• 3.APIの利用開始手順
• 4.API通信プロトコル
• 5.インターフェース仕様
• 6.PUSH通知の受信
• 7.呼び出しサンプル
• 8.戻り値のステータスとエラーコード

WEB ODSL Developer Guides V2.6-2 ／ Web閲覧 ／ 英語

お客様が独自に開発したAndroidアプリ（APK）を、顔認証のフローに組み込むための設定ファイル仕様。入退室管理システム側のソースコードを改修する必要はなく、アプリと設定ファイルを用意するだけで、お客様側だけでカスタマイズを完結できます。12種類のアクションタイプと、業務シナリオ別のカスタマイズ方法を収録しています。

収録内容（全6章）を見る

• 1.概要（ODSLの定義・フローの変更点・開発の全体像）
• 2.設定ファイルの構造（ACTION_NAME・ACTION_TYPE・パラメータ）
• 3.設定ファイルの記述指針（データ受け渡し仕様・12のアクションタイプ）
• 4.設定ファイルの作成とインポート手順
• 5.ODSLカスタム設定（業務シナリオ別）
• 6.付録（認証フローの改変・プロンプト設定・コードサンプル・アプリの導入）

WEB SDK Developer Guides V2.6.1 ／ Web閲覧 ／ 英語

Android搭載のFaceSec顔認証端末向けSDK。弊社の標準アプリを使わず、お客様が開発したアプリで端末そのものを動かすためのものです。利用者管理、設定の読み書き、入退室記録の照会、ドア・カードリーダー・シリアルポートなどのデバイス制御APIを収録しています。

収録内容（全10章）を見る

• 1.概要（システム構成・プラットフォーム）
• 2.SDK導入ガイド（開発環境の準備・ファイルのインポート）
• 3.利用者管理・ルール管理API
• 4.設定管理API（設定の読み書き・コールバック）
• 5.入退室記録API（照会・削除）
• 6.インターフェースクラスAPI（シリアルポート・機器間通信）
• 7.デバイス管理API（ドア制御・カードリーダー・指紋・照明）
• 8.顔認証プロセスの起動インターフェース
• 9.用語集
• 10.付録（シリアル通信の詳細・パラメータの制約）

関連情報