Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
本章では、物理サーバーの事前準備の概要について記載します。Amazon EC2やAlibaba ECSをご利用のお客様は、次章、次々章へお進みください。
SenseLink GE V2.x.0のイメージファイル （SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gzファイル） をサーバーに配備してください。
サーバをネットワークに接続してください。なお、サーバー配置場所の物理的なセキュリティ対策、およびサーバーへのアクセスIP制限や、アクセス可能なIPを持つPCへのログイン制御などのセキュリティ対策の実施をお願い申し上げます。
以上で物理サーバーの事前準備は完了です。事前準備が完了したお客様は、第5章、第6章をスキップし第7章へお進みください。
SenseLinkのWeb管理画面の利用方法について記載されています。
本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）の管理者向けWeb UI機能について記載しています。
本マニュアルでは言語設定が英語の前提で用語、図が記載されています。中国語を設定してご利用になる場合は一部用語や図が異なります。適宜読み替えてご利用ください。
ビルディングアクセスソリューションおよびAI温度検知ソリューションは管理者のアクセス管理の負担を軽減し、よりセキュアで快適なアクセスを可能にする日本コンピュータビジョン株式会社（以下「JCV」）の顔認証ソリューションです。本ソリューションは顔認証サービスを通じて、受付、入退室管理、勤怠管理など様々の利用シーンにおいて、セキュリティ強化と利便性向上に貢献します。また、豊富な管理者向け機能を持っており、既存アクセス管理システムと柔軟に連携できます。
当ページではSenseLink GE Enterprise V2.2.0（以下「SenseLink」）と、SenseLinkと一緒に利用いただくToolKit V1.1.2の各種マニュアルを閲覧いただけます。
マニュアルは改訂される場合があります。詳細は各マニュアルの改訂履歴ページを参照してください。
SenseLinkのインストールパッケージは、ファイルの容量が大きいため以下の通り分割して提供いたします。
分割ファイル1：SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-aa
分割ファイル2：SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-ab
分割ファイルからインストールパッケージへの復元は、格納フォルダーへ遷移し下記コマンドを実行してください。
Ubuntu/Macの場合
Windowsの場合
2020/08/05
7.3節 NTPサービスに関する注意事項を追記
2020/12/28
3.2節 任意ソフトに関する記述を訂正
日付
改訂内容
2020/07/01
初版
2020/07/03
8.6節 設定ファイルを変更する時のマンドの漏れを補足、ダブルクォーテーションの誤記を修正
2020/07/06
8.13節 不要なzookeeper設定を削除
2020/07/15
6章 記載ミスを訂正
日付
改訂内容
2020/07/01
初版
2020/07/03
2.2節 コマンドにある不要なバックスラッシュを削除
2020/09/01
1.4節 SenseLinkサービス再起動を追加
2021/09/14
3.2節 データ保存ディレクトリの詳細説明を追加
当製品の概要について記載されています。
SenseLinkは以下の顔認証デバイスとバージョンと接続してご利用いただけます。記載されない顔認証デバイスはご利用いただけません。デバイスやバージョンによって一部利用できる機能やSenseLinkと共有するデータが異なります。この情報は本マニュアル発行時点のものであり、追加や変更が発生する可能性がございます。追加や変更についてはJCVよりお客様へご連絡いたします。
SensePass
SensePass GE V1.2.1
SensePass GE V1.2.3
ただし、両バージョンで一部機能（ビジター管理および認証、ブラックリスト管理および認証、ルール管理、勤怠管理、デバイスアラート管理）に対応していません。
SenseHello
サポートしていません
SenseThunder-E
SenseThunder-E GE V1.0.3
SenseThunder-Mini
SenseThunder-Mini GE V1.0.1
日付
改訂内容
2020/07/01
初版
2020/07/21
デバイス削除の操作に関する詳細を注意点を追加
2020/08/03
オペレーションログに関する補足を追加
2020/09/10
サポートデバイスから以下を削除
SesenThunder-E GE V1.1.3
SenseThunder-Mini GE V1.0.3
SenseThunder-Mini GE V1.0.7
2020/09/30
10.1節 Staffの概要を訂正
cat SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-* > SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gztype SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-aa SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gz-ab > SenseLinkGE-Enterprise-2.x.0.yyyymmdd.tar.gzアップデートパッケージに読込み、書込み及び実行する権限を付与してください。
※アップデートパッケージの保存ディレクトリおよびアップデートパッケージ名は、お客様の環境に合わせて変更してください。
カレントディレクトリをアップデートパッケージのディレクトリへ変更してください。
update.shを実行してください。
アップデート手順は以上です。SenseLink GE V1.10.1またはSenseLink GE V1.10.7からSenseLink GE Enterprise V2.2.0へアップデートを実施したお客様は、V1.xからのデータ修正マニュアル をご参照いただきデータ修正を実施してください。
データ修正完了後、ユーザーマニュアル等をご参照いただきながらSenseLinkをご利用ください。
sudo su -./update.shSenseLinkへのログインとログアウトについて記載されています。
「Account」欄にアカウント名を、「Password」欄にパスワードを入力し、「Login」をクリックしてください。
Super Adminユーザーの初期アカウント名/パスワードは「admin1234」です。その他のユーザーはアカウント登録時の通知メールに記載された、またはSuper Adminユーザー（システム管理者）から連絡されたアカウント名とパスワードを入力してください。
初期ログイン時、必ず以下の操作を行ってください。
すべてのユーザー
初期パスワードの変更を行ってください。パスワード変更手順は11.2.3項 アカウントの修正と削除 をご参照ください。
Super Adminユーザー
System Settingメニューより、EメールサーバーとNTPサーバーの設定を行ってください。このEメールサーバーは、アカウントの作成や変更時にユーザーへメールを発信するためのものです。詳細な利用方法と手順は11.5節 システムの設定をご参照ください。
SenseLinkが稼働するサーバーの時刻およびタイムゾーンとSenseLinkにログインするPCの時刻およびタイムゾーンが異なる場合、ログイン直後に「Session Error」のメッセージが表示されログイン画面に遷移する事象が発生する場合がございます。それぞれの時刻およびタイムゾーンが一致しているかご確認ください。 SenseLinkが稼働するサーバーの時刻およびタイムゾーンの設定状況については、貴社システム管理者等にお問い合わせください。
当ソフトウェアには、以下のシステム動作環境が必要です。必須の項目については、サポート環境または推奨環境から環境をご準備ください。任意の項目は当ソフトウェアの動作環境に必要なものではございませんが、セキュリティやお客様の効率性の観点でより快適にご利用いただくために、代表的なソフトウェアを記載しております。記載されたソフトウェア以外をご利用いただくことも可能です。
また、当ソフトウェアにはサポート環境と推奨環境をご用意しています。サポート環境は最低動作環境を含む環境条件を指し、サポート環境にてSenseLinkをご利用いただく場合、サポートサービス規約にて定義されるサポートサービスをご提供させていただきます。推奨環境はサポート環境のうちもっとも安定した稼働が当社により確認されている環境です。特別な条件、指定、制限がない場合、推奨環境でのご利用をおすすめします。また、当インストールマニュアルでは推奨環境でのインストールを例としてご案内しております。お客様の既存環境に影響を及ぼさない為に、当ソフトウェアの専用環境を構築することを推奨します。
ご利用のPCをSenseLinkのサーバーと同じネットワークに接続してください。PCのWebブラウザを立ち上げ、SenseLinkのサーバーアドレスを入力し、SenseLinkの管理画面を表示してください。サポートされているWebブラウザはGoogle Chrome、Firefox、Safariです。（それ以外のブラウザは保証しておりません。）
HTTP通信をご利用の場合
http://{SenseLinkのサーバーアドレス}
HTTPS通信をご利用の場合
https://{SenseLinkのサーバーアドレス}
ライセンスアクティベーション前のみ、ライセンスアクティベーションページが表示されます。
ライセンスアクティベーション画面で表示されているUDIDと企業名、およびお客様の契約番号を、JCV製品提供窓口（）までご連絡ください。
JCV製品窓口よりライセンスファイルとアクティベーションコードが送付されます。ライセンスアクティベーションページにてアクティベーションコードを入力し、ライセンスファイルをアップロードすると、ライセンスアクティベーションが完了します。
「Account」欄にアカウント名を、「Password」欄にパスワードを入力し、「Login」をクリックしてください。
Super Adminユーザーの初期アカウント名/パスワードは「admin1234」です。初期ログイン後、必ず初期パスワードの変更を行ってください。パスワード変更手順はユーザーマニュアル 11.2.3項 アカウントの修正と削除 を参照ください。
Amazon EC2またはAlibaba ECSをご利用中のお客様 ライセンスのアクティベーション後にインスタンスを長期間停止後再起動するとディアクティベートされアクティベーションされない可能性があります。 可能な限りインスタンスを停止しないようお願い申し上げます。 ライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。
ライセンスのアクティベーションと更新について記載されています。
chmod 775 -R /home/root6/Desktop/{senselinkge-standalone_update}cd /home/root6/Desktop/{senselinkge-standalone_update}項目
種別
サポート環境
推奨環境
OS
必須
Ubuntu Desktop 16.04. LTS
または
Ubuntu Desktop 18.04. LTS
Ubuntu Desktop 18.04.3 LTS
コンテナプラットフォーム
必須
Docker Engine - Community for Ubuntu 19.03.5
各APIの利用方法の詳細について記載されています。
1.「端末/Terminal App」を立ち上げ、SenseLinkサーバーのイメージファイルを展開したディレクトリ内のpublicディレクトリに移動してください。
2. Dockerコンテナを停止します。以下のDockerコンテナ停止コマンドは以下です。
3. 次のコマンドを入力し、SenseLinkサーバのDockerコンテナの一覧を表示してください。
起動中、停止中すべてのコンテナの一覧が表示されます。以下のCONTAINER IDすべてのSTATUSがExitedになっていることを確認してください。
異なるサーバをシャットダウン・再起動しないように、対象サーバが本当に正しいのか必ず確認のうえ、作業するようにしてください。
サーバ本体の再起動は極力避けてください。必要な場合のみ、サービスを再起動するようにしてください。 もしサーバを再起動した場合は、必ずSenseLinikサービスも再起動してください。
SenseLinkが稼働しているサーバ（オンプレ/クラウドインスタンス）のシャットダウンや再起動に関しては、ご利用のサーバ環境に合ったコマンドをご参照・ご利用ください。
SenseLinkサービスを再起動する場合は以下のコマンドを利用してください。
ライセンスのアクティベーション後にインスタンスを長期間停止後再起動するとUDIDが変更・ディアクティベートされ再度アクティベーションできなくなる可能性があります。 可能な限りインスタンスを停止しないようお願い申し上げます。 新しいUDIDのライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/senselinkge-standalone/public/./stop_all.shdocker ps -afs_service
slinkpush_service
emq_service
web_service
sntp_service
java_websocket_service
java_openapi_service
infra_service
schedule_service
java_service
sync_service
feature_service
opq_service
database_service
zookeeper_service
lgapi_service
event_service
nebula_service
tk_service# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/senselinkge-standalone/
./restart_lightweight.shhttp://{SenseLinkのサーバーアドレス}
HTTPS通信をご利用の場合
https://{SenseLinkのサーバーアドレス}
ライセンスアクティベーション前のみ、ライセンスアクティベーションページが表示されます。
ライセンスアクティベーション画面で表示されているUDIDと企業名、およびお客様の契約番号を、JCV製品提供窓口までご連絡ください。
JCV製品窓口よりライセンスファイルとアクティベーションコードが送付されます。ライセンスアクティベーションページにてアクティベーションコードを入力し、ライセンスファイルをアップロードすると、ライセンスアクティベーションが完了します。
ライセンスは年単位で発行され1年に一度の更新が必要です（特別な契約条件がある場合を除きます）。以下は2年目以降の使用に向けてライセンスを更新する手続きについて記述するものです。1年目の利用に向けて2.1 ライセンスのアクティベーションが完了したお客様は、この章をスキップして次章 ログイン へ進んでください。
ナビゲーションメニューの①[System Management]→[License Information]をクリックしてください。ライセンス管理情報が表示されます。
③[License Update]をクリックすると、編集モードになります。
JCV製品窓口より送付された次年度用のアクティベーションコードをActivation Code欄に貼付してください。License Upload欄のSelect Fileボタンをクリックし、次年度用のライセンスファイルをアップロードしてください。
ページ最下部にあるUpdateボタンをクリックしてください。アクティベーションコードとライセンスファイルが反映されます。 運用マニュアル1章 シャットダウンと再起動を参照し、SenseLinkを再起動してください。
ライセンスの有効期限7日前になると、ログイン時画面上部に「[Authorization is about to expire] Your SenseLink Enterprise license will expire in {n} days. To avoid affecting usage, please contact SenseTime or the agent to update the certificate as soon as possible」（SenseLink Enterpriseのライセンスの有効期限があと{n}日で切れます。ライセンスを更新してください）のメッセージが表示されます。お早めにライセンスを更新するようお願い申し上げます。
本章ではAmazon EC2の事前準備の概要について記載します。物理サーバーをご利用のお客様は前章をご確認ください。Alibaba ECSをご利用のお客様は当章をスキップし次章へお進みください。また、Amazon EC2の他Amazon Web Serviceが提供するサービスの設定や利用方法の詳細については、Amazon Web Service社へお問い合わせください。
なお、メニュー名やAmazon Web Serviceのマネジメントコンソール図を英語表記とさせていただいております。ご了承ください。マネジメントコンソール図内の設定情報はお客様の環境によって異なります。
Amazon Web ServiceのマネジメントコンソールからVPCのダッシュボードを開き、Launch VPC Wizardを押下してください。
お客様環境に合わせVPCの設定情報を入力、Create VPCを押下してください。
EC2のダッシュボードからLaunch Instanceを押下してください。
Step1：Amazon Machine Imageを選択してください。
Step2: インスタンスタイプを選択してください。
Step3: VPCを設定してください。
Step4: ストレージを設定してください。
Step5、Step6 : Tagの設定を行なってください。セキュリティグループの設定ページで、お客様のポリシーに合わせてインターネットアクセスへの制限等の設定を行なってください。
Step7: 設定内容を確認し、Launchを選択してください。
Step8: キーペアを選択、ダウンロードしてInstanceをLaunchしてください。
ご利用の端末から、キーペアを利用しインスタンスへログインしてください。
ディスクのフォーマットを行なってください。
SCPでSenseLink GE V2.2.0のイメージファイル
（SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gzファイル）をインスタンスに配備してください。
（下記のlaunch.pemを適切なssh private key fileに置き換えてください）
以上でAmazon EC2の事前準備は完了です。事前準備が完了したお客様は、第6章をスキップし第7章へお進みください。
にインスタンスを長期間停止後再起動するとUDIDが変更・ディアクティベートされ再度アクティベーションできなくなる可能性があります。 可能な限りインスタンスを停止しないようお願い申し上げます。 新しいUDIDのライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。
エラーメッセージについて記載されています。
エラーメッセージ
原因・説明
Data loading error, click to refresh and try again
データロードに失敗しました。Webブラウザを更新して再度データロードしてください。
This operation cannot be resumed
操作を続けることができません。不正なデータや操作をなくしてから操作してください。
The file is greater than 2M, please upload again
複数顔登録に利用するExcelファイルが2MB以上のサイズです。2MB以下のファイルを利用してください。
Please upload the Excel file with the suffix XLS first
複数顔登録に利用するExcelファイルはXLSX形式ではなくXLS形式のものを利用してください。
Image upload error
画像アップロードのエラーが発生しました。
Image quality does not meet the requirements,please re-upload
画像の品質が要件を満たしません。要件を満たす画像をアップロードしてください。
[Insufficient capacity] The server disk space is less than 20G, and the new data will automatically overwrite the historical data. Please contact the operation and maintenance team as soon as possible to clean up the data
ストレージの残容量が20GB以下になりました。
[Authorization is about to expire] Your SenseLink Enterprise license will expire in {lessTime} days. To avoid affecting usage, please contact SenseTime or the agent to update the certificate as soon as possible
ライセンス有効期間が{lessTime}日以下となりました。
Response error,please try again later
レスポンスエラーが発生しました。再度操作してください。
Request error,please try again later
リクエストエラーが発生しました。再度操作してください。
Logouting,please wait
ログアウト時に時間がかかる場合に表示されます。
Session Error
セッションエラーが発生しました。
Your session has expired. Please sign in and try again
長時間操作しなかった場合は再度操作してください。
複数登録や複数削除などの従業員管理、デバイスアップデート管理で利用するToolKitの利用方法について記載されています。
本マニュアルでは、ビルディングアクセスソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0と一緒にご利用いただくSenseLink ToolKit （以下「ToolKit」）V1.1.2について記載しています。
APIの利用方法について記載されています。
本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）が提供するAPIの利用方法や仕様について記載しています。
本マニュアルはIT部門に所属するお客様、HTTP/HTTPSベース、JSON形式のWeb APIを利用したアプリケーションの開発・運用経験があるお客様を対象にしています。
本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE V1.10.7をSenseLink GE Enterprise V2.2.0にアップデートいただいた際に必要になる手順について記載しています。
本マニュアルはIT部門に所属するお客様、Linux、Kubernetes、Docker、クラウドなどの利用・運用経験があるお客様を対象にしています。
日付
改訂内容
2020/07/01
初版
当マニュアルは、SenseLink GE V1.10.1またはSenseLink GE V1.10.7（以下「SenseLink GE V1.x」）をご利用中でV2.2.0以上のSenseLink GE Enterprise （以下「SenseLink GE Enterprise 」）へメジャーアップデートを行うユーザー向けのマニュアルです。
初めてご利用になるSenseLinkが SenseLink GE Enterpriseのユーザーは、当マニュアルに記載される手順の実施は不要です。
SenseLink GE V1.xでは一部の入力およびエクスポート・表示において、登録された従業員の電話番号と従業員番号が逆転するバグが発生していました。SenseLink GE Enterprise V2.2.0で当バグは修正されましたが、SenseLink GE V1.xから SenseLink GE Enterpriseへアップデートするにあたり一部データの逆転が発生します（V1.xで登録された電話番号と従業員番号が、SenseLink GE Enterpriseアップデート後従業員番号、電話番号として逆転して登録されます）。
SenseLink GE V1.xからSenseLink GE Enterpriseのへアップデートを行うユーザーは、当マニュアルに記載される手順を実施し、データの逆転を解消するようお願い申し上げます。
アクセスを許可するタイムテーブルを管理することができます。 ナビゲーションメニューの①「Strategic management」→②「Access Timetable」をクリックし、アクセスタイムテーブルの一覧を表示します。
③「Add」をクリックしアクセスタイムテーブル登録画面を表示してください。
Timetable欄にタイムテーブル名を入力してください。入力可能な文字は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号です。1~30文字（半角換算）で入力してください。
Effective date（有効期間）欄のStart DateとEnd Dateをそれぞれクリックし、このアクセスタイムテーブルを有効にする期間を指定してください。
Monday〜Holidayの各欄では、各曜日および祝日のアクセスを許可する時間帯の設定を行います。
各曜日の右側にある編集ボタンをクリックしてください。タイムセクション登録画面が表示されます。 なお、全ての時間帯を選択する場合は編集ボタンをクリックせずSelect Allを選択してください。
タイムセクション登録画面で + （プラス）ボタンをクリックしてください。Time section-1 が追加されます。
Time sectionにアクセスを許可する時間帯の開始時間と終了時間を指定してください。時間帯を二つに分けたい場合（例：12:00-13:00のお昼時間を除く営業時間のみアクセスを許可する場合）は、 + （プラス）ボタンをもう一度クリックするとTime sectionを増やすことができます。
Time sectionを削除する場合は、-（マイナス）ボタンをクリックしてください。 設定が完了したら、Saveボタンをクリックしてください。
アクセスタイムテーブル登録画面に戻ると、タイムセクション登録画面で登録した時間帯が青色で表示されます。
タイムテーブルに祝日を登録したい場合は、ページ下部にあるAdd holidaysをクリックしてください。
祝日登録画面が表示されます。Date欄で祝日の年月日を選択してください。毎年日付が変わらない祝日は Every yearにチェックを入れてください。春分の日や秋分の日など毎年日付が変わる祝日は、年ごとに登録する必要があります。
Remark欄に祝日の名前を入力し、Saveボタンをクリックしてください。 アクセスタイムテーブル登録画面に戻ると、祝日が一覧に追加されています。
すべての設定が完了したら、ページ最下部にあるSaveボタンをクリックして保存してください。 アクセスタイムテーブルの一覧画面に保存したタイムテーブルが登録されていることを確認してください。
登録されたアクセスタイムテーブル修正します。 ナビゲーションメニューの①「Strategic management」→「Access Timetable」をクリックし、アクセスタイムテーブルの一覧を表示します。
修正したいタイムテーブルの③「Detail」をクリックしアクセスタイムテーブル詳細画面を表示してください。
ページ最下部にあるEditボタンをクリックすると編集モードになります。
編集後Saveボタンをクリックし登録内容を反映してください。
登録されたアクセスタイムテーブル修正します。
ナビゲーションメニューの①「Strategic management」→「Access Timetable」をクリックし、アクセスタイムテーブルの一覧を表示します。
修正したいタイムテーブルの③「Delete」をクリックしてください。 「This operation cannot be undone, confirm to delete?」（この操作は取り消しできません。削除しますか？）というメッセージが表示されます。削除しても問題ない場合、Confirmをクリックしてください。
アクセスルールでは登録されたアクセスタイムテーブルに対し、デバイスや登録者グループを連携します。 ナビゲーションメニューの①「Strategic management」→「Access Strategy」をクリックし、アクセスルールの一覧を表示します。
③「New」をクリックし、アクセスルール登録画面を表示してください。
Application device欄をクリックし、アクセスルールに連携するデバイスを選択してください。デバイスは複数選択できます。一度選択したデバイスを取り消すには、デバイス名の右にある×をクリックしてください。
デバイスを選択すると、そのデバイスに連携されている登録者グループの一覧が表示されます。アクセスルールに連携したいグループのチェックボックスを選択してください。
Access Timetable欄で連携したいアクセスタイムテーブルを選択してください。一つのアクセスルールに対して、アクセスタイムテーブルは1件のみ連携可能です。
設定が完了したら、ページ最下部にあるSaveボタンをクリックしてください。アクセスルール一覧画面に戻ります。 アクセスルール一覧画面で登録したアクセスルールがデバイスごとに表示されていることを確認してください。
アクセスルールは一度登録すると修正できません。デバイスのアクセスルールを修正したい場合は次章の手順に従い一度ルールを削除し、もう一度設定してください。
アクセスルールを削除します。
ナビゲーションメニューの①「Strategic management」→②「Access Strategy」をクリックし、アクセスルールの一覧を表示します。
アクセスルールの一覧で削除したいアクセスルールにチェックを入れ（③）、④「Multi Delete」をクリックしてください（削除するアクセスルールが1件の場合もMulti Deleteをクリックしてください）。 「This operation cannot be undone, confirm to delete?」（この操作は取り消しできません。削除しますか？）というメッセージが表示されます。削除しても問題ない場合、Confirmをクリックしてください。
当ソフトウェアは、物理サーバーまたはAmazon Web Service社が提供する仮想サーバー Amazon Elastic Compute Cloud （Amazon EC2）、ソフトバンク株式会社が提供するAlibaba Cloud Elastic Compute Service （Alibaba ECS）にインストールしてご利用いただけます。その他の仮想サーバーではご利用いただけませんのでご注意ください。
当ソフトウェアのサーバー要件は、登録者数及び接続する顔認証デバイス数に応じます。
各型番の要件は以下の通りです。要件を満たすAmazon EC2およびAlibaba ECSのインスタンスタイプについては、Amazon Web Service社、ソフトバンク株式会社へお問い合わせください。
※HDD容量の見積もりについては、参考値を記載しております。次項HDD容量サイジング指標をご参照ください。データ保存用ストレージのHDDを追加マウントする方法の参照例は8.2節を参照ください。
顔認証1件の履歴データとして約700KBがHDDに追加で保存されます。1日の顔認証人数と頻度、データ保存年数年数から適切なHDDの容量をお見積もりください。
登録者を勤務地別、階層別など任意のグループにまとめて管理する登録者グループ管理について記載されています。
従業員、ビジター、ブラックリストの登録者はそれぞれ勤務地別、階層別など、任意のグループにまとめて管理できます。グループは顔認証デバイスと紐づくため、ドアやゲート別のアクセス権限をグループで管理することができます。一人の登録者は同時に複数のグループに登録することが可能です。異なる登録者タイプのグループには登録できません。
以下では従業員情報の場合を例に操作手順を記載します。ビジター、ブラックリストの登録者・グループの場合はそれぞれVisitor Managementメニュー、Blacklist ManageMentメニューに読み替えて同様の手順を実施してください。
新しいグループを追加することができます。
ナビゲーションメニューの①「Personnel Management」→②「Employee Group Management」 → ③「Add」 の順にクリックするとグループ新規追加画面が表示されます。
Nameにグループ名を入力し、Accessed devicesで連携するするデバイスを選択し、「Save」をクリックすると新しいグループが追加されます。 グループに登録された従業員は連携されたデバイスのみに顔認証データが連携され、顔認証を行うことができます。登録されたグループが連携されないデバイスで顔認証を行った場合、未登録者として認証されます。
既存のグループ情報を修正することができます。
ナビゲーションメニューの①「Personnel Management」 → ②「Employee Group Management」 → ③アイコン の順にクリックするとグループ情報の詳細画面が表示されます。
情報を修正し、Saveボタンをクリックしてください。
既存のグループを削除することができます。
ナビゲーションメニューの①「Personnel Management」 → ②「Employee Group Management」 → ③アイコン の順にクリックするとグループ削除の確認画面が表示されます。
「There are still N people in the group. Are you sure to delete the group?」（N人の登録者がグループに登録されています。本当に削除しますか？）というメッセージが表示されます。Confirmボタンをクリックして削除を完了させてください。
登録者は当該のグループから登録が解除され、従業員の登録情報自体は削除されません。
グループに登録者を登録することができます。 ナビゲーションメニューの①「Personnel Management」→②「Employee Group Management」→③追加したいグループを選択し、追加したいグループの登録者一覧が表示される状態にしてください。④「Add to group」をクリックすると登録者追加画面が表示されます。
登録者追加画面の左側Selections欄でグループに登録したい登録者名を選択し、Addボタンをクリックしてください。登録者がSelected欄に移動します。編集後、Ensureボタンをクリックするとグループに登録者が追加されます。
検索窓では登録者名または部署名を入力し絞り込み検索を行うことができます。 登録を解除する場合はSelected欄で登録者を選択肢Removeボタンをクリックしてください。Ensureボタンをクリックすると編集が完了します。
登録者が登録されているグループから、その登録者を削除することができます。
ナビゲーションメニューの①「Personnel Management」→②「Employee Group Management」→③追加したいグループ→ ④削除したい登録者→⑤「Delete」 の順にクリックするとグループから従業員が削除されます。 ※従業員は当該のグループからのみ削除され、従業員の登録情報自体は削除されません
本章ではAlibaba ECSの事前準備の概要について記載します。物理サーバーをご利用のお客様は前々章を、Amazon ECSをご利用のお客様は前章をご確認ください。また、Alibaba ECSの他Alibaba Cloudが提供するサービスの設定や利用方法の詳細については、ソフトバンク株式会社へお問い合わせください。
なお、メニュー名やAlibaba Cloudのコンソール図を英語表記とさせていただいております。ご了承ください。コンソール図内の設定情報はお客様の環境によって異なります。
Step1: Alibaba CloudのWebコンソールからElastic Compute Serviceを選択し、Create Instanceボタンを押下してください。
Step2: 基本設定を行います。Billing MethodとリージョンRegionを選択してください。
$ ssh -i launch.pem [ユーザー名]@[IPアドレス]$ sudo lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
xvda 202:0 0 20G 0 disk
xvda1 202:1 0 20G 0 part /
xvdh 202:112 0 1000G 0 disk
$ sudo mkfs.ext4 /dev/xvdh
$ echo -e "/dev/xvdh\t/data\text4\tdefaults\t0 0" >> /etc/fstab$ scp -i launch.pem SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gz [ユーザー名]@[IPアドレス]:[配備先パス]
バックアップ済みのデータ保存ディレクトリをリストアしてください。データ保存ディレクトリを別のディレクトリにリストアした場合は、新たなリストア先をconfigファイルに設定してください。
SenseLink GE Enterpriseをインストールする手順について記載されています。
本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）をインストールする手順について記載しています。
本マニュアルはIT部門に所属するお客様、Linux、Kubernetes、Docker、クラウドなどの利用・運用経験があるお客様を対象にしています。
SL-Server-Std
SL-Server-Std
クロック
3.2GHz 以上
3.4GHz 以上
1.7GHz 以上
キャッシュ
6MB 以上
8MB 以上
20MB 以上
メモリ
DDR3 16GB 以上
DDR4 32GB 以上
DDR4 32GB 以上
ストレージ
HDD※
SATA 1TB 以上
SATA 1TB 以上
SATA 4TB 以上
SSD
SATA 64GB 以上
SATA 64GB 以上
SATA 128GB以上 推奨
SATA 64GB 以上
SATA 128GB以上 推奨
デバイス数/
登録者数
20
50
300
1000
SL-PLC-Std
SL-PLC-Pro
SL-Server-Std
20000
SL-PLC-Pro
SL-PLC-Pro
SL-Server-Std
50000
カテゴリ
詳細
SL-PLC-Std
SL-PLC-Pro
SL-Server-Std
CPU
モデル
Intel Core i5
Intel Core i7
Xeon
コア数
4 以上
4 以上
SL-Server-Std
12 以上
Step3: インスタンスタイプを選択してください。以下の図は一例です。お客様の利用用途や環境に合わせたインスタンスタイプを選択してください。
Step4: Imageを選択してください。
Step5: ストレージの設定を行なってください。System Disk、Data Disk両方の設定が必要です。
Step6: ネットワークの設定を行なってください。VPC、VSwitchともに既存のものまたは新規作成を選択いただけます。
Step7: ネットワークのBilling Methodの設定を行なってください。
Step8: セキュリティグループの設定を行なってください。既存のセキュリティーグループまたは新規作成を選択いただけます。
ポートの22番と443番が許可されていることを確認してください。また、セキュリティグループの設定ページで、お客様のポリシーに合わせてインターネットアクセスへの制限等の設定を行なってください。
Step9: Logon Credentialsの設定を行なってください。既存のキーペアまたは新規作成を選択いただけます。キーペアはダウンロードして安全に保管してください。
Step10: プレビューより、インスタンスの設定が正しく行われていることを確認してください。確認後、Create Instanceを押下してください。
インスタンスが立ち上がるまでお待ちください。
ご利用の端末から、キーペアを利用しインスタンスへログインしてください。
ディスクのフォーマットを行なってください。
SCPでSenseLink GE V2.2.0のイメージファイル
（SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gzファイル）をインスタンスに配備してください。
（下記のlaunch.pemを適切なssh private key fileに置き換えてください）
以上でAlibaba ECSの事前準備は完了です。
ライセンスのアクティベーション後にインスタンスを長期間停止後再起動するとUDIDが変更・ディアクティベートされ再度アクティベーションできなくなる可能性があります。 可能な限りインスタンスを停止しないようお願い申し上げます。 新しいUDIDのライセンスの再発行が必要な場合JCV製品提供窓口までご連絡ください。なお、ライセンスの再発行には数日頂戴する場合がございます。
当製品の概要について記載されています。
ビルディングアクセスソリューションおよびAI温度検知ソリューションは管理者のアクセス管理の負担を軽減し、よりセキュアで快適なアクセスを可能にする日本コンピュータビジョン株式会社（以下「JCV」」）の顔認証ソリューションです。本ソリューションは顔認証サービスを通じて、受付、入退室管理、勤怠管理など様々の利用シーンにおいて、セキュリティ強化と利便性向上に貢献します。また、豊富な管理者向け機能を持っており、既存アクセス管理システムと柔軟に連携できます。
本マニュアルでは、ビルディングアクセスソリューションの管理プラットフォームであるSenseLink GE と一緒にご利用いただくSenseLink ToolKit （以下「ToolKit」）V1.1.2について記載しています。 ToolKitは、SenseLinkへの複数の従業員の一括登録や一括修正を、およびSensePass2とSensePass Pro、SenseThunder E、SenseThunder MiniのAPKやファームウェアアップデートを行うことができます。
また、本マニュアルはMac版、言語設定を英語の前提で用語、図が記載されています。Windows版やLinux版、中国語を設定してご利用になる場合は一部用語や図が異なる場合があります。適宜読み替えてご利用ください。
ToolKit V1.1.2は以下のSenseLinkに接続してご利用いただけます。記載されないSenseLinkのバージョンおよびモデルではご利用いただけません。なおこの情報は本マニュアル発行時点のものであり、追加や変更が発生する可能性があります。追加や変更はJCVよりお客様へ周知されます。
SenseLink GE Enterprise V2.2.0
3種類のToolKitをそれぞれの動作環境でご利用いただけます。
ToolKitを利用する環境にはMicrosoft Excelの2007以降、または互換性を持つソフトウェアが必要です。 拡張子が.xls及び.xlsxの形式のファイルを編集する必要があります。
ToolKitを利用する前に実施していただく事前準備およびログインについて記載されています。
SenseLink Toolkit Setup 1.1.2_20200413.exe をご利用中のWindows PCの任意のフォルダに格納してください。 ダブルクリックするとToolKitが起動します。
SenseLink Toolkit Setup 1.1.2_20200413.debをご利用中のLinux PCの任意のディレクトリに配備してください。
端末（ターミナル）を開いてください。以下のコマンドでToolKitを配備したディレクトリに移動します。
パッケージのインストールコマンドを実行します。
ToolKitが起動します。
SenseLink Toolkit Setup 1.1.2_20200413.dmgをご利用中の Apple社のPCでの任意のフォルダに配備してください。
クリックまたはダブルクリックするとToolKitのインストールが開始されます。以下の画面が表示されたら、SenseLink ToolKitのアイコンをApplicationsのアイコンへドラッグアンドドロップしてください。
アプリケーションにインストールされます。アプリケーション内のSenseLinkToolKitのアイコンをクリックすると、ToolKitが起動します。「インターネットからダウンロードされたアプリケーションです。開いてもよろしいですか？」という警告メッセージが表示される場合、開くをクリックしてください。
ToolKitを起動するとLANGUAGE（言語）の選択タブがあります。簡体中文（簡体中国語）、繁体中文（繁体中国語）、ENGLISH（英語）から選択いただけます。
ToolKitを起動してください。接続先にSenseLink CloudとSenseLink Enterpriseが表示されています。SenseLink Enterpriseを選択してください。
3つの入力欄が表示されます。上から順にSenseLinkのアドレス、アカウント、パスワードを入力してください。アドレスはhttpまたはhttpsから指定する必要があります。末尾にスラッシュは入力しないでください。
アカウントとパスワードをToolKitに記憶させるには、「Remember account and password」にチェックを入れてください。
3つの接続情報を入力後、Loginボタンをクリックしてください。ToolKitがSenseLikに接続されホーム画面が表示されます。
ssh -i launch.pem [ユーザー名]@[IPアドレス]$ sudo lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
vda 253:0 0 20G 0 disk
`-vda1 253:1 0 20G 0 part /
vdb 253:16 0 1000G 0 disk
$ sudo mkfs.ext4 /dev/vdb
$ echo -e "/dev/vdb\t/data\text4\tdefaults\t0 0" >> /etc/fstab$ scp -i launch.pem SenseLinkGE-Enterprise-2.2.0.yyyymmdd.tar.gz [ユーザー名]@[IPアドレス]:[配備先パス]ツール名
動作環境（OS）
SenseLink Toolkit Setup 1.1.2_20200413.exe
Microsoft Windows用
Windows 7
Windows 8
Windows 10
すべて32ビット版、64ビット版サポート
SenseLink Toolkit Setup 1.1.2_20200413.deb
Linux用
Ubuntu 12.04 LTS 以降
Fedora 21 以降
Debian 8 以降
すべてデスクトップ/ワークステーション用環境のみサポート
SenseLink Toolkit Setup 1.1.2_20200413.dmg
macOS用
OS X Yosemite 以降
（macOS Sierra 以降含む）
SenseLink GE Enterpriseの運用中に必要な手順について記載されています。
本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）の運用中に必要な各運用手順について記載しています。
本マニュアルはIT部門に所属するお客様、Linux、Kubernetes、Docker、クラウドなどの利用・運用経験があるお客様を対象にしています。
SenseLink V1.xのユーザーは、SenseLink GE Enterprise V2.2.0以上のインストールマニュアル 「アップード」に従いアップデートを実施してください。SenseLink GE V1.xからSenseLink GE Enterpriseのご指定のバージョン（以下「SenseLink GE Enterprise」）へアップデートされます。以降の手順はアップデートド完了した時点から記載されています。
以降の手順では、SenseLink GE V1.xに5人の従業員が登録されており、SenseLink GE Enterpriseでも同数が登録されているとして各図やExcelの例が記載されています。お客様の利用状況によって表示される人数やデータ数が異なりますので、適宜読み替えて手順を実施してください。
SenseLink ToolKit（以下「ToolKitを開いてSenseLinkに接続します。Toolkitの詳しい利用方法については、ToolKitのユーザーマニュアルをご参照ください。以下ではToolKit V1.1.2の画面を例に説明します。ご利用中の表示が異なる場合がございます。
SenseLinkのURLアドレス、アカウント、パスワードをToolKit入力してログインしてください。
※URLアドレスやアカウントは例です。ご利用の環境に合わせて入力してください。
ToolKitにログインしたら、「Batch Modify」ボタンを押下します。
Batch Modifyメニューの ①「Export employee list」ボタンを押下し、従業員情報をExcelファイルにエクスポートします。
Download Tipsには「エクスポートするExcelファイルはパスワードで保護されています。パスワードは現在ログイン中のアカウントです。」という旨のメッセージが表示されます。Excelファイルを開くときのために、アカウントを覚えておくようにしてください。
Confirm（確認）ボタンを押下してください。任意の保存場所を選択し保存してください。
Toolkitはそのまま開いた状態にしてください。
任意の場所に保存・エクスポートされたExcelファイルを開いてください。ファイルはパスワードで保護されています。パスワードは2.2.1項のログインで利用したアカウントです。
1行目のPromptメッセージ、2行目のラベルを含むすべてのデータを新しいExcelファイルの新しいシートにコピーします。
3行目以降のC列のPhone Number（電話番号）とF列Employee Number（従業員番号）を入れ替えて、Excelファイルを保存します。1行目や2行目のデータは入れ替えないでください。
データ入れ替え後、Excelファイルを任意の場所に保存してください。保存する際は、Excelファイルをパスワードで保護しないでください。
もう一度Toolkitを開いてください。2.2.2項の操作後Toolkitを終了させた場合、2.2.1項の手順に従いもう一度ログインし、ログイン後トップメニューに表示される「Batch Modify」ボタンを押下してください。
Batch Modifyメニューの②「Upload the list of modified employees」ボタンを押下し、2.2.3項で作成したExcelファイル選択してください。ファイルを選択すると、ファイルに記載されたデータが即インポートされます。
ファイルを選択した際にエラーメッセージが表示された場合は、エラーメッセージに従い対応してください。
WebブラウザからSenseLink GE V2.2.0にアクセスし、従業員情報の電話番号と従業員IDが正しく入れ替わったことを確認します。
以上で手順は終了です。
cd [ToolKitを配備したディレクトリ]sudo apt install ./SenseLink Toolkit Setup 1.1.2_20200413.deb日付
改訂内容
2020/07/01
初版
2020/08/03
オペレーションログに関する補足を追加
従業員の出退勤時間や勤務地のルールの設定、認証レコードを元に出退レコードや遅刻、早退などの勤怠管理について記載されています。
SensePass GE V1.2.1、SensePass GE V1.2.3では勤怠管理機能はサポートされません。
ナビゲーションメニューの①「Attendance Management」→②「Attendance Rule」をクリックしてください。勤怠ルールの一覧が表示されます。
初期はDefault attendance groupという名前の勤怠ルールが登録されています。登録されたすべての従業員はデフォルトでDefault attendance groupの勤怠ルールが適用されます。
Default attendance groupの設定項目は修正することも可能です。
③「Add」をクリックすると勤怠ルール登録画面が表示されます。
登録項目とDefault attendance groupの設定値は以下です。
勤務エリアの管理を行います。勤務エリアはデバイスと連携することができ、従業員が顔認証を行なった際にそのデバイスに登録された勤務エリアが勤怠レコードに記録されます。勤務エリアが登録されないデバイスで顔認証を行なった場合、デバイスのLocation（設置場所）が勤務エリアとして記録されます。
（勤務エリアの活用例）
複数のビルに拠点を持つ企業が、各ビル内の複数のゲートに顔認証デバイスを設置する場合に活用できます。
同一ビル内のすべてのデバイスを共通の勤務エリア（例：[ビル名]）として登録すれば、従業員がどのゲートで顔認証を行なったかに関わらず、出勤した[ビル名]を記録することができます。
ナビゲーションメニューの①「Attendance Management」→②「Attendance Area」をクリックしてください。勤怠ルールの一覧が表示されます。
③「Add」をクリックして勤務エリア登録画面を表示します。
Attendance area欄に勤務エリア名を入力してください。半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~50文字（半角換算）で登録可能です。
Location欄にはAttendance area欄と同値を登録してください。
Radium(m)の項目はサポートされない機能です。利用できません。値を変更しないでください。
Associated device欄で連携するデバイスを選択してください。
設定が完了したらSaveボタンをクリックしてください。 勤務エリア一覧に登録した勤務エリアが表示されます。
従業員の勤怠レコードを管理します。出退勤時間や、登録された勤怠ルールに基づく勤怠ステータスが管理されます。
ナビゲーションメニューの①「Attendance Management」→②「Attendance Record」をクリックしてください。当日の勤怠レコードの一覧が表示されます。
Status（State、勤怠ステータス）は以下の種類があります。
指定した期間内の従業員別の勤怠一覧を管理します。
ナビゲーションメニューの①「Attendance Management」→②「Attendance Statistics」をクリックしてください。デフォルトで30日前から当日までの従業員別の勤怠一覧が表示されます。 日付を変更すると勤怠一覧の数値が再計算され表示されます。
勤怠レコードを最大100,000件までExcelファイルにエクスポートすることができます。
ナビゲーションメニューの①「Attendance Management」→②「Attendance Record」→③「Export」をクリックしてください。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると勤怠レコードが記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
ファイル名は attendance record_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_.xls です。[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]は勤怠レコード一覧検索で設定された開始日時と終了日時が指定されます。
ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログイン中のアカウントです。
従業員別勤怠レコードをExcelファイルにエクスポートすることができます。 ナビゲーションメニューの①「Attendance Management」→②「Attendance Statistics」→③「Export」をクリックしてください。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると従業員別勤怠レコードが記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
ファイル名は attendance statistics_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_.xls です。[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]は従業員別勤怠レコード一覧検索で設定された開始日時と終了日時が指定されます。
ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログイン中のアカウントです。
05:00:00
Working hour
規定の始業時間
09:00:00
End
規定の終業時間
18:00:00
Within [mm] mins is acceptable
始業時間または就業時間に対する顔認証時間の許容時間の設定。
（例）始業時間が09:00:00、許容時間が10分に設定されていた場合、従業員が09:10:59に顔認証を行なっても（出勤しても）遅刻とみなしません。09:11:00から遅刻とみなします。
10
Overtime rule - Work over
何時間以上勤務した場合に残業時間とみなすかを設定します。leave afterの設定とAND条件です。
Workday: 12.0
Holiday: 8.0
Overtime rule - leave after
何時以降に退勤した場合に残業時間とみなすかを設定します。Work overの設定とAND条件です。
Workday: 21:00:00
Holiday: 18:00:00
Special Working day
特別出勤日
土日で出勤を行い勤怠ルールを適用する場合に設定します。
日付と出勤日名（Remark）を設定します。出勤日名は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~45文字（半角換算）で登録可能。
なし
Holiday
祝日
勤怠ルールを適用しない祝日を設定します。
日付と祝日名（Remark）を設定します。出勤日名は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~45文字（半角換算）で登録可能。
なし
残業（祝日）
Absence
欠勤。顔認証が行われなかった場合。
Missing attendance
打刻忘れ。一日に1度のみ顔認証が行われ、始業と終業の時間が記録できない場合。
外勤
登録された勤務エリア以外で顔認証を行なった場合
項目
概要
Default attendance group
設定値
Name
勤怠ルール名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~30文字（半角換算）で登録可能
Default attendance group
Staff
勤怠ルールを適用する従業員または所属部署グループ(Department)の選択
他の勤怠ルールに登録されないすべての従業員
Frequency
顔認証頻度の選択
Monday to Friday, twice a day の場合、月曜日〜金曜日に1日2回の顔認証を行う場合に選択。1日3回以上顔認証を行なった場合、最後の顔認証時刻が退勤時間として記録されます。
勤怠ルールによる勤怠管理を行わない場合はNo attendanceを選択してください。
Monday to Friday, twice a day
Start time
項目
概要
Normal
通常勤務。勤怠ルール通りの場合。
Late Arrival
遅刻。始業時間が勤怠ルールより遅れた場合。
Early leave
早退。就業時間た勤怠ルールより早い場合。
Late Arrival and Early leave
遅刻および早退
Overtime (weekdays)
残業（勤務日）
勤怠管理上の日付変更時間の設定。
（例）Start timeが04:00:00に設定されている場合、5月1日の03:59:00に顔認証を実施すると4月30日の勤怠記録として記録されます。5月1日の04:01:00に顔認証を実施すると5月1日の勤怠記録として記録されます。
Overtime (holiday)
Super Admin
Sub Admin
General Admin
Device Admin
Visitor Admin
Dashboard
ダッシュボード。認証レコードやデバイスのステータスなどをダッシュボード画面で確認できます。
◯
◯
◯
◯
◯
Device List
デバイスリスト。顔認証デバイスの登録や削除、設定変更などを行います。
◯
◯
△
◯
✕
Personnel Management
登録管理。従業員、ビジター、ブラックリストなど顔認証を行う対象者の情報を登録管理します。
◯
◯
△
✕
△
Strategic Management
ルール管理。デバイスや登録者グループごとにアクセス可能な（認証可能な）期間や時間帯を設定します。
◯
◯
△
✕
✕
Event Management
イベント管理。認証レコードや登録者別認証レコード、デバイスアラートを管理します。
◯
◯
◯
✕
△
Attendance Management
勤怠管理。勤務日や休日、出退勤時間を登録し従業員の勤怠を管理します。
◯
◯
△
✕
✕
System Management
システム管理。企業情報の管理、各アカウントの管理、Open Platformの管理、操作ログ管理など、システム管理者向けの機能を管理します。
◯
△
△
△
△
◯：更新・参照権限あり
△：参照権限のみあり、または一部のサブメニューのみに更新権限あり
✕：更新・参照権限なし
ボタン
機能・設定項目
ハンバーガーボタン
ナビゲーションメニュー（エリアA）の縮小表示、通常表示を操作できます。デフォルトでは通常表示が選択されています。
設定ボタン
ダッシュボード画面の表示方法の設定を行います。 詳細は を確認してください
※SensePass GE V1.2.1、SensePass GE V1.2.3で発生したアラートの表示と管理はサポートされません。
※Show AlarmをOnにした際に表示されるアラートはTamper Alarm、Door Force Alarm、Doorsensor Timeout、Thermal Imager Abnormal、FireAlarmのみです。Password Cracking、Offline Alert、Camera Blurrer、Non-living Attach、Face Feature Extraction Failedは表示されません。イベント管理のデバイスアラートの管理から確認してください。
Document
現在利用できません。クリックしても画面が遷移しないのでご注意ください。
Language
言語選択ボタン SenseLinkの表示言語設定を行います。英語（English）、簡体中国語（簡体中文）、繁体中国語（繁体中文）から選択できます。SenseLink GE Enterprise V2.2.0は日本語に対応していません。ボタンをクリックし言語を選択してください。
[アカウント名]
アカウントボタンクリックするとAboutとLogoutをお選びいただけます。Aboutを選択すると、ご利用中のSenseLinkの概要が表示されます。Logoutを選択すると、ログアウトされます。SenseLinkをご利用にならない時、また共有のパソコンでSenseLinkを利用し利用が終わった時は、セキュリティ上必ずログアウトを行うようにしてください。
設定項目
概要
Exhibition Mode
ナビゲーションメニューを表示させないExhibition ModeOn/Offの設定を行います。デフォルトではOffでナビゲーションメニューは表示されます。
Dynamic data
ダッシュボードに表示される各統計・ステータスを自動更新する設定を行います。デフォルトではOffで自動更新されません。Onにした場合1秒〜20秒の間で自動更新の間隔を設定できます。Select Board TypeでBody Temperature Monitoringが選択されている場合、この項目は設定できません。
Show Alarm
各種アラートが発生した場合に、ダッシュボードにアラートを表示させるかを設定できます。デフォルトではOnです。アラートが発生すると、図4.2.1にある赤枠のアラートがダッシュボード上に表示されます。
Select Board Type
Default Display Mode（各統計・ステータスの表示）またはBody Temperature Monitoringを選択できます。Body Temperature Monitoringでは異常な温度検知結果数やマスク未着用者数など、SenseThunder による測定に関するデータに特化して情報を表示します。デフォルトではDefault Display Modeが選択されています。
項目
概要
Statistics
当日の認証レコード数や登録タイプ別レコードの延べ数を表示します。
Devices
登録されているデバイス数やステータスを表示します。
Daily Check-in
従業員と来訪予定ビジターの当日の認証状況を表示します。ユニーク数が表示されます。
Daily Access Control Alarm
当日発生したアラートの一覧を表示します。
Yesterday Attendance
前日の勤怠状況を表示します。
項目
概要
Statistics
当日の温度検知数や温度検知結果（通常温度検知数、異常温度検知数）、マスク着用状況を表示します。
Data Map
温度検知結果やマスク着用の状況、時間毎の推移をグラフで表示します。
Abnormal Events
異常温度検知数、マスク未着陽数をグラフで表示します。
Events
温度検知レコードを表示します。
メニュー名
概要
計算方法
により計算されます。タイムスタンプおよびAppシークレットを利用してください。
例：
sign、timestamp、および Appキー（app_key）の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。
http://host:port/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
sign、timestamp、およびAppキー（app_key） の 3 つのパラメーターを、次のようにリクエストしてください。
http://host:port/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng×tamp=1477881215000
オプションパラメーターはリクエスト本体に配置され、form-data またはインターフェースドキュメントで指定された application/json に従って呼び出され、リクエストがサーバーへ送信されます。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。
一部のインターフェースでは id をリクエストに配置する必要があります。詳細については、APIの利用方法をご参照ください。
コード
メッセージ
原因
10001
App Key Not Exist
キーがありません
10002
App Expired
キーが期限切れです
10003
Request Expired
リクエストが期限切れです
10004
GET
リクエストパラメーター
パラメーター名
型
必須
説明
user_id
long
Yes
登録者ID
time_valid_from
long
No
認証開始時間
valid_time
認証パラメーター
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
エラーレスポンスのフィールド
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。登録者が存在しません。
サーバーのTerminal（端末）を開き、root権限を取得したうえで必要なソフトウェアをインストールしてください。
root権限を取得しパスワードを入力してください。
※要件を満たすハードディスクの設定がすでに完了している場合、またAmazon EC2及びAlibaba ECSをご利用の場合、このステップをスキップしてください。 ディスク管理ツールを立ち上げるため、次のコマンドを入力してください。
ファイルシステムタイプはお客様のHDD設備に合わせて変更してください。
次のステップを進めると、お客様の既存Docker環境が使用できなくなります。お客様の既存環境に影響を及ぼさない為に、当ソフトウェアの専用環境を構築することを推奨します。
システム環境にdocker、docker.io、docker-engineがすでにインストールされている場合、すべてアンインストールしてから次のステップに進んでください。
Ubuntu 18.04を使用する場合は以下です。
Ubuntu 16.04を使用する場合は以下です。
手順1：daemon.jsonという名前のファイルを下記ディレクトリに保存します。
/etc/docker/daemon.json
例：Dockerコンテナ保存先を/dataにする場合
手順2：Dockerを再起動します。
設定ファイルを変更してください。
設定ファイルの、
GRUB_CMDLINE_LINUX=...
の行を以下のように変更してください。
GRUB_CMDLINE_LINUX="cgroup_enable=memory swapaccount=1"
（設定ファイルのデフォルト値はご利用になるOSのバージョンによって異なります）
上記変更後、新しい設定を適用させるため以下のコマンドを入力してください。
次に、サーバーを再起動してください。再起動コマンドは以下です。
ターミナルでroot権限を取得してください。その後、chomd 775 -Rで 解凍されたSenseLinkのディレクトリに読込み、書込み及び実行する権限を付与してください。
※アップグレードパッケージの保存ディレクトリおよびアップグレードパッケージ名は、お客様の環境に合わせて変更してください。
senselink_config_pathを適切なデータ保存ディレクトリに変更してください。
本文ではsenselink_config_path=/data/sensetime/senselinkを前提で記述しています。
configファイルをvimで開き、time_zoneを適切に変更してください
例
SSLサーバー証明書の使用有無（SSL/TLS対応有無）によってインストールする前の事前作業が異なります。
お客様が準備したSSLサーバー証明書を「./public/web_service/Cert/」の直下にコピーして、「senselink.crt」と「senselink.key」にリネームしてください。
（本製品に同梱する「senselink.crt」と「senselink.key」は参照例です、使用しないでください。）
run_all.sh内で実行するweb_serviceのシェルを、run.sh（https用）からrun_http.sh（http用）に変更してください。
run_all.shの内容を変更します。変更コマンドは以下です。
スクリプト内の下記箇所
を
に変更してください。
その後、アクセス可能なドメイン名を設定してください
add_header 'Access-Control-Allow-Origin' *; の部分が複数箇所存在します。
add_header 'Access-Control-Allow-Origin' http://xxx.xxx.com; に変更してください。（*の部分をアクセス可能なドメイン名を設定してください）
上記の準備完了後、install.shを実行して、インストールを開始してください。（約5分以内で完了します。）
install.shの実行時、ハードウェア要件に満たすかどうかのチェックが実施されます。やむを得ずハードウェア要件に満たさないサーバーをご利用する場合、install.shと同ディレクトリにあるverify-env.shを修正する必要があります。下記の図の通りにハードウェアチェックの部分をコメントアウトしてからinstall.shを実行してください。
なお、ハードウェア要件に満たさないサーバーで本製品を稼働する場合、アプリケーションの動作が不安定となる恐れがあるため、ご了承ください。
インストール後でもデータベースのパスワードは変更可能です。全ての初期パスワードを変更するように推奨します。
変更するにはまずdatabase_serviceコンテナにログインして、MySQL、MongoDB、Redisのパスワードをそれぞれ変更した後（デフォルトパスワードはconfigファイルから確認できます）、configファイルのパスワードを変更し、restart.shを実行することでサービスを再起動してください。
sign=md5 (timestamp#app_secret)app_secret=2323dsfadfewrasa3434
timestamp=1477881215000
sign=md5 (1477881215000#2323dsfadfewrasa3434) =e5ef72ef839bdf5397b4906b199b9fbf{
"code": 200,
"message": "OK",
"desc": "",
"data": "slqr-614yJpzW8bbvc27UySglfHwpbvG3WQNO"
}sudo su -long
No
有効期間
entry_times
int
No
入室時間
string
Yes
タイムスタンプ
string
QR コードのコンテンツ
日付
改訂内容
2020/07/01
初版
IP Invalid
IPアドレスがホワイトリストにありません
10005
Signature Failed
無効な署名です
20001
Company Out Of Date
企業の利用期間の期限が切れました
20002
Permission Denied
権限がありません
30001
Param Invalid
無効なパラメーターです
30002
Similar User Exist
追加された登録者は既存の登録者と非常に類似しています
30003
No Face Detected In The Image
写真内で顔を検出できません
30004
Missing Param
パラメーターが不足しています
30005
Avatar File Invalid
不正な写真形式です
50001
RPC Failed
サーバー同期エラー
50002
Internal Server Error
内部サーバーエラー
50003
Multi Request Error
一括リクエストエラー
50004
Request Method Not Allowed
不正なリクエストメソッドです
99999
Unknown Error
不明なエラーです
620
Record non-existent Error
不正なパラメーターです。対応するレコードが見つかりません
610
Similar record Exist
類似するレコードが存在します (同じ名前の部署が同じレベルに存在するなど)
650
Cannot delete unless include nothing
部署または従業員が配下にあるため削除できません。
サーバーのTerminal（端末）を開き、root権限を取得してください。
sudo su -カレントディレクトリをパッケージのインストールディレクトリへ変更してください。
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はパッケージのインストールディレクトリに置き換えてください
cd /home/root6/Desktop/{senselinkge-standardalone}※パッケージのインストールディレクトリはお客様の環境に合わせて変更してください。
docker psを実行し、動いているdockerコンテナを確認します。
./uninstall.shを実行して、SenseLinkをアンインストールします。
./uninstall.sh参照：下記のアンインストールログが出力される想定です。
docker psを実行し、dockerコンテナが動いてないことを確認します。
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES次のステップを進むと、お客様の全データが消去されます。バックアップする必要がある場合は、運用マニュアルのデータバックアップとリストアを参照ください。
最後に、データ保存ディレクトリを削除します。
sudo gnome-disks sudo apt-get purge $(sudo dpkg -l | \
grep -e docker -e containerd -e runc | awk '{ print $2 }')#Ubuntu 18.04の場合
$ sudo apt-get update
$ sudo apt-get install \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo apt-key fingerprint 0EBFCD88
$ sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
$ sudo apt-get update
$ sudo apt-get install docker-ce=5:19.03.5~3-0~ubuntu-bionic docker-ce-cli=5:19.03.5~3-0~ubuntu-bionic containerd.io
# Check that docker version has been 19.03.5
$ sudo docker version$ sudo apt-get update
$ sudo apt-get install \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo apt-key fingerprint 0EBFCD88
$ sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
$ sudo apt-get update
$ sudo apt-get install docker-ce=5:19.03.5~3-0~ubuntu-xenial docker-ce-cli=5:19.03.5~3-0~ubuntu-xenial containerd.io
# Check that docker version has been 19.03.5
$ sudo docker version{
"data-root": "/data"
}sudo service docker restartvim /etc/default/grubsudo update-grubreboot# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
chmod 775 –R /home/root6/Desktop/{senselinkge-standardalone}# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config
# vimを開く後、time_zone部分を変更
time_zone=GMT+9:00# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cp {お客様のCert格納ディレクトリ}/sample.crt /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/Cert/senselink.crt
cp {お客様のCert格納ディレクトリ}/sample.key /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/Cert/senselink.key# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/public/run_all.sh cd ../web_service
./run.sh ${web_version}cd ../web_service
./run_http.sh ${web_version}# httpの場合は./public/web_service/defaultを編集してください
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/public/web_service/default_https# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/{senselinkge-standardalone}
./install.sh# login to database_service container
docker exec -it database_service bash
# login to mysql, please change "senselink_2018_local" to your mysql password
mysql -u senselink -psenselink_2018_local
# change password for current user, please change "new_password" to your password
mysql> set password="new_password";
Query OK, 0 rows affected (0.00 sec)
mysql> exit
Bye
# login to mongodb
mongo
> use sensekeeper
switched to db sensekeeper
# please change "username","password" to your username/password in config file
> db.auth("username","password")
1
# now you can change the password
> db.changeUserPassword("username","new_password")
> exit
bye
# redis passowrd can be changed by modifying the config file and restart
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
vim /home/root6/Desktop/{senselinkge-standardalone}/config
# modify “redis_password=senselink_redis” to “redis_password={new_password}”
# 下記"/home/root6/Desktop/{senselinkge-standardalone}"はインストールパッケージのディレクトリに置き換えてください
cd /home/root6/Desktop/{senselinkge-standardalone}
./restart.shCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
eb2d63eb1051 senselink/tk_service:v2.2.0-GE "java -XX:+UseCGroup…" 31 seconds ago Up 31 seconds tk_service
d0801f270553 senselink/nebula_service:v2.2.0-GE "java -XX:+UseCGroup…" 32 seconds ago Up 32 seconds nebula_service
f58b9aca792f senselink/lgapi_service:v2.2.0-GE "./lgapi" 33 seconds ago Up 33 seconds lgapi_service
5ccad7f954c1 senselink/fs_service:v2.2.0-GE "./fs" 33 seconds ago Up 33 seconds fs_service
1e523bfaa561 senselink/slinkpush_service:v2.2.0-GE "./slpush" 34 seconds ago Up 33 seconds slinkpush_service
a9381e21e7b8 senselink/emq_service:v2.2.0-GE "./bin/emqttd console" 44 seconds ago Up 44 seconds emq_service
84d4880411bb senselink/web_service:v2.2.0-GE "nginx -g 'daemon of…" 45 seconds ago Up 44 seconds web_service
c68744c6a042 senselink/sntp_service:v2.2.0-GE "./sntp" 45 seconds ago Up 45 seconds sntp_service
7638096d022e senselink/java_websocket_service:v2.2.0-GE "java -Xms512m -Xmx1…" 46 seconds ago Up 45 seconds java_websocket_service
92e990d0fe4a senselink/java_openapi_service:v2.2.0-GE "java -Xms512m -Xmx1…" 47 seconds ago Up 46 seconds java_openapi_service
abff7e180431 senselink/infra2_service:v2.2.0-GE "./infra" 47 seconds ago Up 47 seconds infra_service
8a07ce0d36c2 senselink/schedule2_service:v2.2.0-GE "./schedule" 48 seconds ago Up 47 seconds schedule_service
12ec8b98bcf7 senselink/java_service:v2.2.0-GE "java -XX:+UseCGroup…" About a minute ago Up About a minute java_service
351a72010eaa senselink/event_service:v2.2.0-GE "java -XX:+UseCGroup…" About a minute ago Up About a minute event_service
38f37ae77028 senselink/sync_service:v2.2.0-GE "./sync" About a minute ago Up About a minute sync_service
5363a00ec71a senselink/feature_service:v2.2.0-GE "./feature" About a minute ago Up About a minute feature_service
c68cd1ec6ee6 senselink/opq_service:v2.2.0-GE "startopq.sh" About a minute ago Up About a minute opq_service
6f941a999947 senselink/zookeeper_service:v1.11.0-p "/bin/sh -c '/usr/sb…" About a minute ago Up About a minute zookeeper_service
373e00200606 senselink/database_service:v2.2.0-GE "/bin/bash /senselin…" About a minute ago Up About a minute database_service##### Start to Stop All Services #####
eb2d63eb1051
d0801f270553
f58b9aca792f
5ccad7f954c1
1e523bfaa561
a9381e21e7b8
84d4880411bb
c68744c6a042
7638096d022e
92e990d0fe4a
abff7e180431
8a07ce0d36c2
12ec8b98bcf7
351a72010eaa
38f37ae77028
5363a00ec71a
c68cd1ec6ee6
6f941a999947
373e00200606
##### All Services Stopped, Start to Remove Containers #####
eb2d63eb1051
d0801f270553
f58b9aca792f
5ccad7f954c1
1e523bfaa561
a9381e21e7b8
84d4880411bb
c68744c6a042
7638096d022e
92e990d0fe4a
abff7e180431
8a07ce0d36c2
12ec8b98bcf7
351a72010eaa
38f37ae77028
5363a00ec71a
c68cd1ec6ee6
6f941a999947
373e00200606
##### All Containers Removed, Start to Remove Images #####
Untagged: senselink/fs_service:v2.2.0-GE
Deleted: sha256:f4ce67410f198c27808a0ec50dc82037b669885681a2d7bb0c431cc9043ecd0d
Deleted: sha256:a158a7af682820526921b78b36c7dbfc2d3b39bf8595b8d6fb9e04d0cbeb9d98
Deleted: sha256:909ee6a803bcb98d6363c4ea7e0a694318b554851f72e2084b19232b25cd81c4
Deleted: sha256:9d7869fb3408acd978c140739569b0eac5005a5bb17f10744c361b8ae4419a26
Deleted: sha256:651df2c95539c81889005983406a7b8c0677c76e4389bdb34109e4347aab7ecf
Deleted: sha256:1b2562b347da975a3301b1b81195fab0941b138bac2318948a4f953c5d7ad546
Untagged: senselink/database_service:v2.2.0-GE
Deleted: sha256:562054a82ef9a91e15a3cc1e2615d4b849c3665321757c78936718f33649fe4d
Deleted: sha256:8199baaf896b2f8c68b5f434d061673c01d7a728eeaecac7ab0d45272159f5ae
Deleted: sha256:5be71221a7cd26d659883201aec14ae188ba7a88a47ec6a6b034e8de97728301
Deleted: sha256:aa4ac212aa3a5bcbb5aee42379e9c46c6ef9c2fb8e514d77a91c479c7e0b1c2c
Deleted: sha256:4ad00fc4ef21fd4286bc2d713f69b472770e3939d9610ae707f53b4abdb467e9
Deleted: sha256:d4c2f3f1a4882ec55c1fac5da44f1f2f04c5ac80bbe17ebaa905696d93ce8fa0
Deleted: sha256:6c28687436e9864f27bd27c2eca6f5c290034f7dafcb18cabdf9150a9c0b5d9d
Deleted: sha256:51d40c1197cc0e303ac28fe59fe26e89a6aaa0cf137babbab03545b5591fd1ec
Deleted: sha256:ee3f2f7346a5149d27515105301dcef09002e3eb2591a9e1c8943bd916ca4376
Deleted: sha256:386ce00247234851c4a6dab043f12e3f258d38179e5427d09251e41f8e852899
Deleted: sha256:15bef5abb5bcb055bfc0764c13164275b3f97294099a444457a2a9ad11c90c88
Deleted: sha256:b9a263e90705a41a6b3a149275ab3467ffaf84ac4d1717aef6b323dfaf534430
Deleted: sha256:7b0521ec142848c21bc3738380b17a7f067b62fc01a40bedff60799d37545c7d
Untagged: senselink/feature_service:v2.2.0-GE
Deleted: sha256:14449ae121055d86e6dccb8fa461a517a227d575847e325b9e6e60b4d37e590f
Deleted: sha256:ce4fe6101dbb425766c11950fa989a7ce696dfc3b037c0ae48136e1dba48af49
Deleted: sha256:f4f26809ba211fdb95c524d7e9781dbcfd5d350457e2c1e6210bab13f82e662c
Deleted: sha256:4fb0fd38d38ef01c17f5c23029a8bfca7f6e77ed87e1b793e881bd596ea7fbb3
Deleted: sha256:b718029ac5e31e5f5563efba0602eb4295b683bea422f618c691deef5f38d2ed
Deleted: sha256:449bda1a1acd0ed49057a35dd225b30fda62ad4d14c0100a9592957a31861efa
Deleted: sha256:be511edcfc655f4ac4697cd52435d0edd4dc92358a79ce38bf7c5c28a800926e
Untagged: senselink/sync_service:v2.2.0-GE
Deleted: sha256:1679d3f20ec69a8c0ace27862f588a95def714a8cbab04cb19db392020fc3565
Deleted: sha256:3f1e97950be072f7c6e8aa2f44df8031bef888d7c57bc216debcafd1775a1231
Deleted: sha256:cc835a43468778a61a4dc6f43c7d40178a8c9f8e0e71439062e6e1774adbf97d
Deleted: sha256:f1177a8920becf7d64554bf6fab76a0e2943f4132a844cf9c00792c1f5d7dc76
Deleted: sha256:f5a735912fa7aaf3a57f76787b65b2c6cc0458fcba688a7ae0650846f558cbfe
Deleted: sha256:b0fa160b15bdb23949172254cf61ddfe0408d35b5c5ccba3b5214988097c2919
Untagged: senselink/schedule2_service:v2.2.0-GE
Deleted: sha256:282eb9a0e575c6ee42530ccf9b11f33556852980dadd1494269faed9c4fb6d4f
Deleted: sha256:44b639e0bc6edf4a2dce2c585ba9c120f8387c7b1fb1051a02b4e405a94c7135
Deleted: sha256:f01b5a7a8ae12578d63145352645c7142c0f4f1ff901c5b808ea9e73a3538950
Deleted: sha256:109d945969fd6575852650b9960e84b042a33029204e8cd3a7e25663fef65f89
Deleted: sha256:38ebcaf942663721a702c5dafd051403db49831d5ad762a3ebde8d4613aae644
Deleted: sha256:0e85d7969335077f6a283ae1bd334ab1d88736ebc5f7b428c23f74c14209746c
Untagged: senselink/nebula_service:v2.2.0-GE
Deleted: sha256:8ae2ff620a009c864059e09073596477a245487e23f21ddf41cc2ed4e2298a1e
Untagged: senselink/tk_service:v2.2.0-GE
Deleted: sha256:5fcebe9d0679cdadc35ca8be185042b339cccce44b58079a8c6cfaeb6dcf50b5
Deleted: sha256:5ccfefe086d8dd18571ae938300c509a62199309f1031355c0941898af0e072c
Untagged: senselink/lgapi_service:v2.2.0-GE
Deleted: sha256:602f3efd7fc323194ab4964a2e9a4b8d99a1a311a977b3e0e161b19153c9f4ad
Deleted: sha256:2386edbcfe9f7d424f9fdb15fe052124212c6ca172999429d6f8687c92f2c829
Deleted: sha256:b5ffea875bcd446027f34e80c02cb3d65ec9268e7d586e12ad5b4de8349b70b5
Deleted: sha256:47449953561eb99a987293e75d4f1b7fee18959f210451a960dd1ce67ff15333
Untagged: senselink/event_service:v2.2.0-GE
Deleted: sha256:1c6128e4821c527387f81abc5e2e00757ec0c78bfe970c91294da8ed31d6e918
Deleted: sha256:efa460c83228aa25fb107ce8f62438dd3aab879f645d6ae9dd8f135477f080c1
Untagged: senselink/net_service:v2.2.0-GE
Deleted: sha256:dd155860ef46f1be279a36092df2418d9c29c073d66399119521b8dc71bc9cda
Deleted: sha256:ed0ff16e9b31150be31e198be5fdba8d3e9ac495e22ec5b3737f1628dab2ac1d
Deleted: sha256:991382d05a0f51ef7cc40faed481ecda546ffd45060460e32460ca2035d25bbf
Deleted: sha256:e8e4316661a814a2cd8a7dcc167563bd7fe92a2f05f3d98e64e699219a5f2ae5
Deleted: sha256:6cc7786853ba8164d1848a04e0e330559ac479720a1d76d1bbaf8e9a9b3fea94
Deleted: sha256:1fe4199fb57af52918f298b77c74fd95f5018afb49a075ad9781fde394b1775d
Untagged: senselink/java_websocket_service:v2.2.0-GE
Deleted: sha256:2adc215a3f0c89229635ce0a606c96699fe022aad059360e33402e97f217400b
Deleted: sha256:977edd558d7f8e6484448c64b5ad89c19544b4a432b1f57865dd67e9ac1cd7c3
Deleted: sha256:5a065ded243edc86115abbffeec86fdbdd3dcb45c6687b1278e601292d2dcc5f
Deleted: sha256:f0c549a7eab204de3f3638ac4bcde05aa263c0221f247cc6a700ca0aa0f3fce0
Untagged: senselink/sntp_service:v2.2.0-GE
Deleted: sha256:f440b1e20da77c06005824ccd68c0d3556187080984c679bf29d6074330aa5ed
Deleted: sha256:242d898acea257800dedf5a8dcddfe47d63c362b95fa943c15bd9fd83a513076
Deleted: sha256:b62f3e9dcb06358cc89fa103a61198c294abbcbebb8504ab0eb55ad86361d6c8
Deleted: sha256:131f74211fefde7d5bbfb8574e6c6f19bfcab920b04ff922192c2cbc3996aa87
Untagged: senselink/infra2_service:v2.2.0-GE
Deleted: sha256:0b15e0e9fc4bc218abacd235f7e58c1c58cf16aa90c9d7fefbb920f24c2a13a0
Deleted: sha256:e37a0c19b80b7fc5c3bc1fdfc85f292769a03efcd7f0f7ccec436fb02f885334
Deleted: sha256:d231f65d2642a48e6dc20c8228563e85140972689199932a0ecbf8d5fc6210a3
Deleted: sha256:5fa8f8e96c4cf092cc7ee5db2f09c5e79733e1ebb0279101faeb56f81d14663e
Deleted: sha256:175c67a3f00f7552721c55891b32c1cb92c370340dfb01e0ecc86f10d734a7d4
Deleted: sha256:da1daeb63353cbc3b17abda56f5ae0f6fd04a7b98a5e66802019f1cb405bcb7b
Untagged: senselink/web_service:v2.2.0-GE
Deleted: sha256:e4786830dd76ee35ce185fc32bfd97b7bec8f76e7f2489abcb91134841bda6dc
Deleted: sha256:5df41161b88667c4d1f741bc57094096a811ef4efd6eebec736dffc41aedadf4
Deleted: sha256:ae142d91ffd19edbd27474dd3d9570602c0aa6f73ce62874ca038834ba8b2643
Deleted: sha256:3cf101f87d3fcfd4c1b02e93d08cf59e109aeaf8cf7df09a1649c908385dbb2d
Deleted: sha256:f2cb0ecef392f2a630fa1205b874ab2e2aedf96de04d0b8838e4e728e28142da
Untagged: senselink/java_openapi_service:v2.2.0-GE
Deleted: sha256:f4a08949f6f7e4462ec34ad800e6b6fc510e6e1e19751c9f0ffc57db06e03bbe
Deleted: sha256:38500f63e9f7837e8ae1ff2356dcf0d6a01efb4373b72776f0b7163c6ab24ea7
Deleted: sha256:e69921031958a70b423d2591e4aa5508981181ec7c19955691ce09111e2d561f
Deleted: sha256:3cf06af6e744509babd8d7423b4202ca83f4a4bd7c0f3f7fe95c4eac57635f35
Deleted: sha256:d4b717754f528d4a6f179078f225ce61b42e6f7d24df555f7067d9ab934deed4
Deleted: sha256:6131e2878f196e0ad50cb2872dbbc3c476b2abea6cf65772a7cb2a73a0db066a
Deleted: sha256:fdc47e80ad3dbe1767a5c2141442c0c7aa93a14a817357a0d4353cd8ae48ee58
Deleted: sha256:2b4ed599a73ad82b15d4e3488d95af4f387037b90401d63ad6cb433374b3e3d3
Deleted: sha256:8f06e3a624319de717230f0d766dd8922d048441adb9e0387860a8047d000409
Deleted: sha256:6cebf3abed5fac58d2e792ce8461454e92c245d5312c42118f02e231a73b317f
Untagged: senselink/java_inner_service:v2.2.0-GE
Deleted: sha256:fc9c3afef522d90aa2631b2b59226f6fe4602e1c6b7f19b8d5c5c1aa9f5867e3
Deleted: sha256:15f028f4106bcffe65d6ba1ec40a908db97aeb0b9cde602c35f49d6203d084bf
Deleted: sha256:501a7d1c78b91509904fa5e9fd35cf9876b2c2f449498e236e345bef7722ffd7
Deleted: sha256:a22b8959c973eadc9ff5af5a0ccf9283727a6baf242335bc4a8c2554c58fd1ce
Untagged: senselink/java_service:v2.2.0-GE
Deleted: sha256:95aa9934fafd823dede76a0682b4902dd3178a62aa2d3c2e88e78ac543f0abea
Deleted: sha256:165afcdc925c101a79f0a3177d14679b8dbb7e8b9c700ca4b87db6ab3f105372
Deleted: sha256:76a3063b75e5b83128259603a09ef09467fead5e8a7a10fbc0587ce057267c47
Deleted: sha256:6cfc026f1394278d87aecd3d997683b9519d000da418add6581a1ebad4d10a4b
Deleted: sha256:37724463e5961b25c21009c22390709a676e8e371abf31c2961821f0c3b11c1a
Deleted: sha256:a654ba9723932ac8f9cd236d615a4ba67ee7abdf20b7517aeff8b886a7168715
Deleted: sha256:027b23fdf3957673017df55aa29d754121aee8a7ed5cc2898856f898e9220d2c
Deleted: sha256:0dfbdc7dee936a74958b05bc62776d5310abb129cfde4302b7bcdf0392561496
Deleted: sha256:02571d034293cb241c078d7ecbf7a84b83a5df2508f11a91de26ec38eb6122f1
Untagged: senselink/slinkpush_service:v2.2.0-GE
Deleted: sha256:895f8666ecffa51b116d81f4faaf5f158993611adc4135d0d0133e0e661d91e1
Deleted: sha256:6b667019f87d32bea4879ed1bfe434597e8c8fc9444ac4d49a4f5ad67fe10831
Deleted: sha256:2b04baa9fe8562031df05f1256d898767d1666da0993e757c8779b4e4be8e91b
Deleted: sha256:a6902b802c368254ea0109838e4269be09e83fa51a8e775b24031a09a4d8cb36
Deleted: sha256:a164720499275cd3f68a43fdd53355e5d288214491f9751fb1c4737a4370871e
Deleted: sha256:28d30ad1bcdcf18c0e2de5361cbb033f13020e9202d2b3eccaf3dd1d6484d3f4
Deleted: sha256:7444ea29e45e927abea1f923bf24cac20deaddea603c4bb1c7f2f5819773d453
Untagged: senselink/emq_service:v2.2.0-GE
Deleted: sha256:a5c8076e1dcc47bbb75d70c8ba616ed3ba49d4d315df0a7a00aca6a20e1e6fdb
Deleted: sha256:87e8a2069efd4e5637bfb6b6e6beb2517850625020fa8390c76937cb9b4b55bf
Deleted: sha256:7949d88156b969d53b902822c2f47c2faa5456210eeded287fd8c5308775c2c2
Deleted: sha256:0c39ae07db6fd9c0bd49009201faa56c6d2d4c3e663c6557b8221af909fc821c
Deleted: sha256:5f9f51e42a3322f3ce43594fc8f9b4851191173b1ea944048b15025040ee91e7
Untagged: senselink/opq_service:v2.2.0-GE
Deleted: sha256:16d8b60481d163d8946094893aa01dc6988e87f9cabf11d7de048850cc4c743a
Deleted: sha256:c55a5f981c2f09f6ec5097b56a6bc373538d87f010cfe29f7f16937c97c4227a
Deleted: sha256:77d6b179e5714fe559605210e5b432e69417578090c0c11f9954255a55514f40
Deleted: sha256:a97227ba8a902c7c7783e8f439f8ca0b6bbfa0b40973001e656d8a94eaadaa30
Deleted: sha256:64faa61fee08d0b8d55db6f4ccb42bf1b13d5af065b2e1f89d2e7f3b8b9e7b7b
Deleted: sha256:535043c66dacfed1a2769597f6447adb0a114031f4f02df3d153c0de48ed1617
Deleted: sha256:b4d3af941054c99b15c27b809f4115ddc94c307aa97705c53c52b1b687298ba5
Deleted: sha256:36fb0d2dd04845e4d517cdb206bc16303172273150b8a74387ebc24157fc5bc6
Deleted: sha256:7c66d02ec02b23556302d9826e1966a6c94b775ec87bc5779acf26b0365ed2fb
Deleted: sha256:9e6f810a2aabaa90d8e79f52847c74617a94e78fe223f4f067d84a6bd63b9393
Untagged: senselink/zookeeper_service:v1.11.0-p
Deleted: sha256:351aa00d2fe9804ed202bb3c1e0f7a337f2a2c316ad87f5e4b3cd052f263782b
Deleted: sha256:cd2cf3704aef513d20c2de71164ca0d61dee828cf5cda22f5d94a6e236c1f537
Deleted: sha256:3d86bd6c82f3d2134f20020ae1dcdb4c35622dfffd846653225348328adc11e1
Deleted: sha256:112613615c3c5830200f6482eb3f7f70679af3829e313b86734373429b0740fd
Deleted: sha256:3180e0cfed96b34b850951884921a54e74ccdb08ba2a412a48a67f3684592a2d
Deleted: sha256:08d496b872a7df357d286f951478725989d59f1d02f429d1b6777a41e259b7d2
Deleted: sha256:43ae9ff4372226476c99eea6d425d7ea95b5a5fb2f74a1b9bbd502a9c3bb9686
Deleted: sha256:feb06b3539913d2c817a6a4aa15ce87925ec57e87fe001fdb21e19a4dc34205c
Deleted: sha256:8a0be0ba98a0a5645b5d23bed652380aec4a501b0136854bf6979ef3652b9a8a
Deleted: sha256:69914bc13886a16f82d734f05b6d31535e32578b0b8027ecd0876f7eee226195
Deleted: sha256:0a6a558061d2753ff3d7a3b2f699b4141afa286c46c64d7479c70680ffb3b31c
Deleted: sha256:16aae303a3e3fc8a3fa161fb753ac18df7fb5cdc3d118bbb1edceb86d846f7ed
Deleted: sha256:d20413971c378e688f6981c69378d2dbf146dce8c69e3281e38b03ff181d8064
Deleted: sha256:0f72e5b180fabc7d295dd2a09fea1b629c83eb6bd13d2e640716251cdbcb3094
Deleted: sha256:1020c0c0f4edc7a5b695351d2dcb8c4e9d70ebd4366d17574ca7e27dfe543fdf
Deleted: sha256:ee468bb36d6d7ef3483378dff5c7920a1340b1e4f5f8c54158d1098e04b79f63
Deleted: sha256:b94a4e48c2c794072e2311cf565a05b12fcff9ab097a294fc57ed9110fd90795
Deleted: sha256:a94a7b5aa8b29d57798c38c7245945c812febe492107770ba965b154d86e869f
Deleted: sha256:9297f600c87d20c6baa252eb509ba3ed6704804237d9d8feec34ddd4ec99184b
Deleted: sha256:f4808639fed5aa49d2b3250683b566a96bdd6652fb0f91ff9024fa0ab89a6bc4
Deleted: sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef
##### Uninstall SenseLink Successfully! #####
# 下記"{/data/sensetime}"はデータ保存ディレクトリに変更してください。
sudo rm -rf {/data/sensetime}
概要
現在のシステムのバージョン番号を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/server/version
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
概要
企業情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/company
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
必須
タイムスタンプ
Yes
タイムスタンプ
背景 ID
welcome
string
Welcomeメッセージ
introduction
string
企業プロフィール
threshold
float
顔認証の閾値
language
string
利用中の言語
serviceConfig
string
サービス構成
createBy
int
作成者 ID
contact
string
担当者
createAt
string
作成時間
updateAt
string
更新時間
validFrom
string
ライセンス有効開始時間
validTo
string
ライセンス有効終了時間
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
edition
string
バージョン番号
date
string
バージョンのリリース日
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
id
int
企業ID
name
string
企業名
logo
string
ロゴ ID
background
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
string
string
string
{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"edition": "1.10.0",
"date": "20190617"
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 58,
"name": "日本コンピュータビジョン",
"logo": "5b238d7ec6681b0001466d5e",
"background": "5b238d7ec6681b0001466d5f",
"welcome": "日本コンピュータビジョンへようこそ ",
"introduction": "独創性をもち、AIに人類の進歩を牽引する企業",
"contact": "太郎",
"createAt": "2018-05-28 17:31:32.0",
"updateAt": "2018-06-28 15:57:55.0",
"validFrom": "2018-06-15 00:00:00.0",
"validTo": "2018-07-31 00:00:00.0",
"createBy": 17,
"threshold": 0.85,
"language": "zh",
"serviceConfig": ""
}
}POST: form-dataリクエストパラメーター
パラメーター名
型
必須
説明
face_avatar
file
Yes
認証用顔写真
app_key
string
Yes
Appキー
sign
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
不正なリターンの説明
face_number
エラーレスポンスのフィールド
コード
メッセージ
説明
30001
Param Invalid
認証用顔写真のタイプが不正です。
30003
No Face Detected In The Image
顔が検出されませんでした。
概要
認証用顔写真の品質を検出します。
リクエストアドレスの例
https://HOST:PORT/api/v1/recognition/quality
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
face_avatar
file
Yes
認証用顔写真
app_key
string
Yes
Appキー
sign
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
qa_code
int
リターンコード
qa_msg
string
リターンメッセージ
qa_desc
string
リターンの説明
qa_code の説明
リターンコード
リターンメッセージ
リターンの説明
0
PASS
通過
101
BAN:face count is over the max
顔の数が最大数の制限を超えています。
10201
BAN:image size wrong, two small
認証用顔写真が小さすぎます。
10301
エラーレスポンスのフィールド
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
{
"code": 200,
"message": "OK",
"face_number": 4
}{
"code": 200,
"message": "OK",
"data": {
"qa_code": 1030301,
"qa_desc": "the face pose pitch score is [22.19]-float",
"qa_msg": "BAN:the face pose pitch is substandard"
}
}string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
int
顔の数
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
BAN:the alignment score is substandard
検知スコアが低すぎます。
1030201
BAN:the face rect's pixels is too low
顔フレームのピクセルが少なすぎます。
1030301
BAN:the face pose pitch is substandard
ピッチ角が大きすぎます。
1030302
BAN:the face pose yaw is substandard
転向角が大きすぎます。
1030303
BAN:the face pose roll is substandard
ロール角が大きすぎます。
10401
BAN:the face quality{distance to center} is substandard
対面距離が基準を満たしていません。
10402
BAN:the face quality{face size} is substandard
顔サイズ比が小さすぎます (顔の長方形の領域 / 画像領域)
10403
BAN:the face quality{face cover} is substandard
顔が遮られすぎています。
10404
BAN:the face quality{brightness} is substandard
明るさが基準を満たしていません。
10405
BAN:the face quality{sharpness} is substandard
明度が基準を満たしていません。（写真がぼやけています
10406
BAN:the face quality{mouth opened} is substandard
口が開き過ぎています。
10407
BAN:the face quality{face missing} is substandard
欠けた顔が多すぎます。
認証レコードやアラートなど様々なイベントを管理する管理について記載されています。
SensePass GE V1.2.1、SensePass GE V1.2.3ではイベント管理機能勤怠管理はサポートされません。
ナビゲーションメニューの①「Event Management」→②「Recognition Records」をクリックしてください。顔認証レコードの一覧が表示されます。
以下の情報が顔認証レコードとして記録されます。
検索機能として登録者タイプ、認証方法、誤認証タイプ、異常検知タイプ、登録者グループ、認証期間、デバイス、登録者名があります。 検索項目を選択し、Searchボタンをクリックしてください。検索結果が表示されます。
SenseLinkのユーザーは、認証レコードを確認し、認証結果が誤りだと判断した場合に誤認証のタグをレコードに付与して管理することができます。
誤認証には以下のタイプがあります。
誤認証タグを付与する認証レコードのsnap shotをホバーしてください（①）。写真全体が表示され、写真の下部に「Mark misidentification」が表示されるのでクリックしてください（②）
誤認証タグ付与画面が表示されます。誤認証タイプを選択肢、必要であればRemark欄に特記事項を記入しSubmitボタンをクリックしてください。
「This operation cannot be recovered. Confirm mark?」（この操作は取り消ししません。タグを付与しますか？）のメッセージが表示されます。Confirmボタンをクリックしてください。
誤認証タグを付与した認証レコードのMisidentification Type欄に、付与した誤認証タイプのタグが表示されていることを確認してください。
登録者別に顔認証レコードを管理することができます。 ナビゲーションメニューの①「Event Management」→②「Recognition Statistics」をクリックしてください。登録者別の認証レコードの概要が表示されます。登録者の認証レコードの詳細を確認する場合は、Operation欄のDetailをクリックしてください。
Recognition Record（顔認証レコード）ページに遷移し、、選択した登録者のみの認証レコードが一覧で表示されます。
現在、監視（ナビゲーションメニューの「Event Management」→「Monitoring」）はサポートされていません。
デバイスが検知した様々なアラートを管理することができます。なお、SensePass GE V1.2.1、SensePass GE V1.2.3で発生したアラートの管理はサポートされません。
ナビゲーションメニューの①「Event Management」→②「Device Alarm」をクリックしてください。デバイスアラートの一覧が表示されます。
検索機能として日付、デバイス、アラートタイプ、アラートのステータスがあります。検索項目を設定し、Searchボタンをクリックしてください。検索結果が表示されます。
アラートの確認後、アラートを解除することができます。
アラートが発生中の場合、アラート一覧のAlarm Status（アラートステータス）がAlerting（アラート発生中）となります。
解除したいアラートの「Remove Alarm」（アラート解除）ボタンをクリックしてください。 アラートのステータスがAlerting（アラート発生中）からReleased（解除完了）になります。
顔認証レコードの一覧をExcelファイルをエクスポートすることができます。写真はエクスポートできません。 ナビゲーションメニューの①「Event Management」→②「Recognition Records」→③「Export」をクリックしてください。
「Please Select Extras Field」のメッセージが表示されます。追加エクスポート項目を選択してConfirmをクリックしてください。
エクスポート項目は以下です。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると顔認証レコードが記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
ファイル名は registration_record_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_.xls です。[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]は認証レコード一覧検索で設定された開始日時と終了日時が指定されます。
ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログイン中のアカウントです。
登録者別顔認証レコードのサマリーをExcelファイルにエクスポートすることができます。写真はエクスポートできません。 ナビゲーションメニューの①「Event Management」→②「Recognition Statistics」→③「Export」をクリックしてください。
「Please Select Extras Field」のメッセージが表示されます。追加エクスポート項目を選択してConfirmをクリックしてください。
エクスポート項目は以下です。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると顔認証レコードが記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
ファイル名は recognition_statistics_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_.xls です。[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]は認証レコード一覧検索で設定された開始日時と終了日時が指定されます。 ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログイン中のアカウントです。
認証方法。現在 Face （顔認証）のみサポートされています。
Group
登録者グループ
Direction
認証方向
Device name
デバイス名
Abnormal type
異常検知タイプ。サポートされる異常検知タイプは以下です。
その他の異常検知タイプはサポートされません。
Misidentification type
誤認証タイプ。誤認証タイプは別をご参照ください。誤認証レコードの管理方法については次章をご参照ください。
Time
認証時刻
Mask wearing
マスク着用検知結果
Body Temperature
温度検知結果
（サポートされない機能です。利用できません。）
Thermal Imager Abnormal
SenseThunderのサーモグラフィカメラ部分の接続に不具合がある場合に発生します。
Camera Blurred
デバイスのカメラ部分の汚れ等により認証ができない場合に発生します。
Non-living Attach
写真やビデオ、3Dマスクなどによるなりすましを検知した場合に発生します。
Fire alarm
消防アラート。デバイス側でGPIO端子による消防アラートシステム等との接続設定がされている場合のみ有効です。
Face feature extraction failed
特徴量抽出エラー。顔認証時にデバイスが顔特徴量の抽出に失敗した場合に発生します。
Yes
Device
デバイス名
Yes
Time
認証日時
Yes
Verification method
認証方法
Yes
IC Card No.(Read by device)
（サポートされない機能です。利用できません。）
Yes
ID Card No.(Read by device)
（サポートされない機能です。利用できません。）
Yes
Abnormal Type
異常検知タイプ
Yes
Phone Number
携帯電話番号
No
Department
部署
No
Position
役職
No
Employee Number
従業員番号
No
User's IC Card Number
ICカード番号
No
Eメールアドレス
No
User's ID Card Number
（サポートされない機能です。利用できません。）
No
Body Temperature
温度検知
No
Wear Mask or Not
マスク
No
Yes
Last Pass
最終認証時間
（検索期間内）
Yes
Total
合計認証回数
Yes
Phone Number
携帯電話番号
No
Department
部署
No
Position
役職
No
Employee Number
従業員番号
No
User's IC Card Number
ICカード番号
No
Eメールアドレス
No
User's ID Card Number
（サポートされない機能です。利用できません。）
No
項目
概要
Snapshot
認証時にデバイスが撮影した写真。一覧では顔部分のみ表示されますが、ホバーすると全体が表示されます。
Recognized photo
登録者情報に認証用顔写真として登録された写真。
ID photo
（サポートされない項目です）
Name
登録者氏名
Identity
登録者タイプ
誤認証タイプ
概要
Misjudged as Others
登録者が他の登録者として認証された場合
Misjudged as Strangers
登録者が未登録者として認証された場合
Misjudged as Non-living
写真やビデオ、3Dマスクなどによるなりすましではないのに生体認識の結果なりすましであると認識された場合
Stranger Breakthrough
未登録者が登録者として認証された場合
Non-living breakthrough
写真やビデオ、3Dマスクなどによるなりすましなのに、なりすましではないと認識された場合
誤認証タイプ
概要
Misjudged as Others
登録者が他の登録者として認証された場合
Misjudged as Strangers
登録者が未登録者として認証された場合
Misjudged as Non-living
写真やビデオ、3Dマスクなどによるなりすましではないのに生体認識の結果なりすましであると認識された場合
Stranger Breakthrough
未登録者が登録者として認証された場合
Non-living breakthrough
写真やビデオ、3Dマスクなどによるなりすましなのに、なりすましではないと認識された場合
アラートタイプ
概要
Tamper Alarm
盗難アラート。デバイスにある盗難アラートボタンが押された場合に発生します。
Door Force Alarm
ドア・ゲート強制突破アラート。通行者が規定の方法以外でドアまたはゲートの通行（突破)）たことを検知した場合に発生します。デバイス側でGPIO端子によるドア開閉センサーの設定がされている場合のみ有効です。
Doorsensor Timeout
ドアセンサータイムアウト。デバイスの設定項目「Door Open Time」の設定時間内にドアの開閉を終えない場合に発生します。デバイス側でGPIO端子によるドア開閉センサーの設定がされている場合のみ有効です。
Password cracking
パスワードクラッキング。パスワードの入力を5回間違った場合に発生します。不審者による不正ログインを検知できます。
Offline Alert
オフラインアラート。デバイスがオフラインになった場合に発生します。
項目名
概要
デフォルトエクスポート項目
Name
登録者名
Yes
Identity
登録者タイプ
Yes
Group
登録グループ
Yes
Direction
項目名
概要
デフォルトエクスポート項目
Name
登録者名
Yes
Identity
登録者タイプ
Yes
Group
登録グループ
Yes
First Pass
Verification Method
Bluetooth Battery Low
方向
初回認証時間
（検索期間内）
概要
デバイスアラートのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/alarm/list
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
オンラインデバイスにアラート解除コマンドを送信します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/alarm/disarm
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
No
デバイスのID
code
int
No
アラートのタイプ。10001 デバイスの盗難アラート、10002 ドア・ゲート強制突破アラート、10003 ドアセンサータイムアウト、10004 パスワードクラッキング、10005 （サポートされないアラートです。現在利用できません）、10006 サーモグラフィカメラ接続異常、20001 カメラの汚れ、20002 Non-Living アタック（非生体による認証）、20003 消防アラート、30001 デバイスオフラインアラート、40001 特徴量抽出エラー
status
int
No
アラートのステータス。1 : アラート作動中、2 : 解除中、3 : 解除済み
page
int
No
ページ番号 (デフォルトは 1）
size
int
No
ページサイズ (デフォルトは 20、最大 1000)
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
現在のページ番号
page_size
int
ページサイズ
total_page
int
ページ合計
アラートの説明
status
int
アラートのステータス。1 : アラート作動中、2 : 解除中、3 : 解除済み
traceId
string
デバイスが生成するアラートのシリアル番号であり、アラートの固有の識別番号です。
deviceId
long
デバイスのID
deviceName
string
デバイス名
deviceSn
string
デバイスの LDID 番号
deviceLocation
string
デバイスの設置場所
alarmTime
string
アラート時間
alarmTimeL
long
アラートのタイムスタンプ（ミリ秒単位）
releaseTime
string
アラートのリリース時間
alarmPhoto
string
アラート写真
resolveOption
int
アラートの解除オプション。0 : 解除不要、1 : デバイスエンドでの解除のみをサポート、2 : リモート解除のみをサポート、3 : デバイスエンドまたはリモートでの解除
0 解除不要 : 10004 パスワードクラッキング、20002 Non-Living アタック（非生体による認証）、40001 特徴量抽出エラー
1 デバイスエンドでの解除のみをサポート : 10003 ドアセンサータイムアウト、20001 カメラの汚れ
3 デバイスエンドまたはリモートでの解除10001 デバイスの盗難アラート、10002 ドア・ゲート強制突破アラート、20003 消防アラート
userId
long
登録者ID 。コード内でパスされます。40001
userName
string
登録者名。コード内でパスされます。40001
userType
int
登録者のタイプ。1 : 従業員、2 : ビジター、3 : ブラックリストコード内でパスされます。40001
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
イベント説明が長すぎます。
50001
RPC FAILED
リモートサービスの呼び出しに失敗しました。
パラメーター名
型
必須
説明
dateFrom
string
No
yyyy-MM-dd 形式の開始時間
dateTo
string
No
yyyy-MM-dd 形式の終了時間
deviceId
パラメーター名
型
説明
total
int
総計
size
int
サイズ
data
object
page_num
パラメーター名
型
説明
id
long
アラートレコードのID
level
int
アラートのレベル。1 は通常のアラートを示し、2 は異常を示します
code
int
アラートのタイプ。10001 デバイスの盗難アラート、10002 ドア・ゲート強制突破アラート、10003 ドアセンサータイムアウト、10004 パスワードクラッキング、10005 （サポートされないアラートです。現在利用できません）、10006 サーモグラフィカメラ接続異常、20001 カメラの汚れ、20002 Non-Living アタック（非生体による認証）、20003 消防アラート、30001 デバイスオフラインアラート、40001 特徴量抽出エラー
description
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
traceId
string
Yes
アラートのシリアル番号
description
string
No
イベントの説明
app_key
code
メッセージ
エラーの説明
498
Param Invalid
リモートで解除できないアラートです。（
「サーモカメラ接続アラート」のみ）
620
Record non-existent Error
アラートは解除されています。
620
Record non-existent Error
アラートのシリアル番号が存在しません。
30001
long
int
string
string
Param Invalid
{
"code": 200,
"message": "OK",
"data": {
"total": 639,
"data": [{
"traceId": "SGBD1566376557396gpknft",
"alarmPhoto": "5d5d026df684640001b260f0",
"code": 20002,
"releaseTime": "",
"level": 2,
"resloveOption": 0,
"alarmTime": "2019-08-21 16:35:57",
"deviceId": 283,
"deviceName": "SensePassTest",
"deviceSn": "SGBD-b8b2201baea00d3918c49989838d81c0",
"alarmTimeL": 1566376557395,
"id": 378018,
"deviceLocation": "306.Michael",
"status": 0
}],
"size": 20,
"totalPage": 32,
"pageSize": 20,
"pageNum": 1
}
}{
"code": 200,
"message": "OK",
"data": {}
}Total：SenseLinkに登録したデバイスの総台数
Online：オンラインのデバイス台数
Offline：オフラインのデバイス台数
Device Name：デバイス名で検索できます。
Device Type：デバイスの種類を絞り込み検索できます。
SenseThunder V1.0.3をご利用中で絞り込み検索させる場合は、SensePass Proを選択してください。SenseHello、SenseAikeはサポートされないデバイスです。選択しないでください。
Device State：デバイスのオンライン/オフラインを絞り込み検索できます。
Resetボタン：各フィルタの値をリセットさせすべてのデバイスを表示させさせます。
Batch settingsボタン：デバイス設定を一括で行います。詳細は5.7節 Device Settings: デバイスの設定（一括）を参照してください。
Add Deviceボタン：サポートされない機能です。選択・クリックしないでください。
LDID：デバイスの識別番号
Device Name：デバイス名（設定例：2階1号ゲート入館方向）
Location：デバイスの設置場所
Type：デバイスの種類
State：デバイスのオンライン/オフラインステータス
Detail：デバイス設定
デバイスの設定を行います。デバイスリスト画面で、設定したいデバイスのDetail欄にある > 印をクリックしてください。デバイスの設定項目が表示されます。各設定項目の詳細については5.3節以降を参照してください。なお、Person Infoは現在サポートされていません。
各設定項目を設定するには、Operationボタンをクリックし Editを選択して編集モードにしてください。一部の設定項目はデバイスがオンラインステータス時のみ編集できます。
設定を編集後、OperationボタンをクリックしSaveを選択して設定内容を反映してください。 設定の編集をキャンセルする場合は、OperationボタンをクリックしCancelを選択してください。 デバイスとSenseLinkとの連携を解除しデバイス一覧からデバイスを削除する場合、編集モードにしてからOperationボタンをクリックし、Deleteを選択してください。
デバイスリスト画面で、設定したいデバイスのDetail欄にある > 印をクリックしてください。Device information：Device informationをクリックすると、デバイス情報が表示されます。OperationボタンからEditをクリックし、編集モードにしてください。
以下の項目を表示・編集できます。
カテゴリ
項目
詳細
Basic information
LDID
デバイスの識別番号
変更不可
Type
デバイス種類
変更不可
Device IP
デバイスのIPアドレス
変更不可
編集後、OperationボタンをクリックしSaveを選択して設定内容を反映してください。 編集内容を破棄、キャンセルする場合はOperationボタンをクリックしCancelを選択してください。
デバイスリスト画面で、設定したいデバイスのDetail欄にある > 印をクリックしてください。Device Settings：デバイス設定をクリックすると、デバイス設定の設定項目が表示されます。OperationボタンからEditをクリックし、編集モードにしてください。編集はデバイスがオンラインステータス時のみ可能です。
以下の項目を表示・編集できます。デバイスがオンラインステータス時のみ編集できます。 利用するデバイスによって一部表示項目が異なる場合があります。
項目
詳細
Enabled state
デバイスのOn/Offの設定（Run：オン；Halt：オフ、デバイスが利用できなくなります）
Mode Selection
モードの切り替え
SenseThunder またはSensePass Proの場合、シングル顔認証/複数顔認証から選択
SenseThunder MiniまたはSensePassの場合、ゲートモード/ドア（Access）モードから選択
Authentication mode
認証モードの切り替え設定 Face：顔認証のみ利用可能です。それ以外の認証モードを選択しないでください。
Identification mode
（一部デバイスのみ）
Client FRまたはServerFR（変更不可）
Voice Broadcast
温度検知・認証時の音声ブロードキャスト設定
ON：英語音声
OFF：ビープ音（ピッ、ビビビビ）
項目
詳細
Main prompt of device メインメッセージ
デバイスの顔認証待機時、デバイス画面上部に表示するメッセージの設定（最大50半角文字、任意）
Prompt after successful recognition 認証メッセージ
認証成功時に画面に表示するメッセージの設定（任意）
Prompt after rejected recognition 認証エラーメッセージ
認証失敗時（未登録者の認証時、アクセス時間外の登録者認証時など）に画面に表示するメッセージの設定（任意）
Extra display field 認証従業員情報
認証成功時表示する従業員情報の設定 (Job number、Department、Position、Identify number、Custom number）（任意）
Show avatar 写真表示
認証成功時の登録顔写真表示/非表示の設定（On/ Off、デフォルトOn）
項目
詳細
Liveness detection
生体認識
生体認識On/Offの設定 Onの場合、写真やビデオ、3Dマスクなどによるなりすましを防止することができます
（On / Off、デフォルトOn）
Liveness threshold
生体認識閾値
生体認識閾値の設定
(設定範囲：0～1.00、デフォルト0.98）
Facial recognition threshold
顔認証閾値
顔認証閾値の設定 （設定範囲：0～1.00、デフォルト0.90）
ID card recognition threshold
IDカード認証閾値
（利用できません）
Facial recognition distance(m)
顔認証距離
顔認証距離の設定
設定範囲は顔認証デバイスタイプによります。デフォルト1.5メートル）
項目
詳細
Door open mode
ドアオープンモード
ドアオープンシグナル種類の選択
Local relay
Wiegand26(8+16bit ID)
Wiegand32
Open time(s) ドアオープン時間
ドアオープンシグナル継続時間の設定 （設定範囲：1～30秒、デフォルト6秒）
Door open interval(s) 認証インターバル
同一人物の顔認証時にドアオープンシグナルをエクスポートする間隔時間の設定
（設定範囲：3～30秒、デフォルト5秒）
GPIO A-output port GPIO A-output ポート
GPIO B入力シグナル種類の選択
（Null、Door magnet、Out button、Fire signal、デフォルトNone）
GPIO B-input port GPIO B-output ポート
GPIO B入力シグナル種類の選択
（Null、Door magnet、Out button、Fire signal、デフォルトNone）
項目
詳細
Language
言語設定
言語設定（中文/English/日本語）（デバイスによります）
Standby
スタンバイ
デバイスのオートスタンバイOn/Offの設定
（On / Off、デフォルトOn）
Standby time (min)
スタンバイ時間
デバイスがスタンバイモードに切り替わる時間の設定
（設定範囲：3～30分、デフォルト5分）
Automatic restart
オートリブート（再起動）のOn/Off設定
（On / Off、デフォルトOn）
デバイスリスト画面で、設定したいデバイスのDetail欄にある > 印をクリックしてください。Access Settingsa：アクセス設定をクリックすると、アクセス設定の設定項目が表示されます。OperationボタンからEditをクリックし、編集モードにしてください。（OperationボタンにあるAccess Strategy、View recognition recordsを選択するとそれぞれアクセスルール設定ページ、認証レコードページに遷移します。）
項目
詳細
Direction
方向
デバイスのアクセス方向の設定
（Null：設定しない、In：入館、Out：退館）
Staff group
従業員グループ
デバイスと連携する従業員グループの設定
設定したグループの従業員の情報のみがデバイスに連携され、認証可能です。
Visitor group
ビジターグループ
デバイスと連携するビジターグループの設定
設定したグループのビジターの情報のみがデバイスに連携され、認証可能です。※
Blacklist group
ブラックリストグループ
デバイスと連携するブラックリストグループの設定 設定したグループのブラックリストの情報のみがデバイスに連携され、認証可能です。
Door Status
サポートされない機能です。利用できません。
編集後、OperationボタンをクリックしSaveを選択して設定内容を反映してください。 編集内容を破棄、キャンセルする場合はOperationボタンをクリックしCancelを選択してください。
Attendance Management （勤怠管理）にあるAttendance Area （勤怠エリア ）をデバイスと連携することができます。登録された従業員がデバイスで顔認証を行うと、連携されたAttendance Areaが勤怠レコードの位置情報として記録されます。設定を行わない場合、Device InformationのLocationが位置情報として利用されます。
編集後、OperationボタンをクリックしSaveを選択して設定内容を反映してください。 編集内容を破棄、キャンセルする場合はOperationボタンをクリックしCancelを選択してください。
オンラインステータスのデバイスは、Device Settingsの設定項目をデバイスタイプごとに一括で設定することができます。Batch settingsボタンをクリックしてください。
一括設定画面に遷移します。
Device Typeをクリックし設定するデバイスタイプを選択してください。SenseAikeはサポートされないデバイスのため、選択しないで下さい。
Applied devicesに選択したデバイスタイプのデバイス一覧が表示されます。設定を行うデバイスを選択してください。なお、State（ステータス）がオンラインのデバイスのみ選択、一括設定を行うことができます。
デバイスの選択後、設定内容の編集を行います。Applied settingsの項目にDevice Settings：デバイス設定 の設定項目が表示されます。5.4節 Device Settings：デバイス設定 の設定（個別） を参照し、各項目を設定してください。
設定後、ページ最下部にあるApplyボタンをクリックして設定をデバイスに反映してください。 Cancelをクリックすると、デバイスリストのページに戻ります。 Reset to defaultをクリックすると、すべての設定値がデフォルト値になります。
デバイスをSenseLinkから削除します。削除したデバイスがオンライン状態の場合、顔認証やSenseLinkに関するデータがデバイスから消去、ログアウトされ、認証を行うことができなくなります。デバイスがオフライン状態の場合はオンライン状態になるまで認証を行うことができますが、オンライン状態に変わると同様に認証を行うことができなくなります。
デバイスリスト画面で、削除したいデバイスのDetail欄にある > 印をクリックしてDevice Informationのページを表示してください。Editボタンをクリックし編集モードにしてください。もう一度Editボタンをクリックすると、Deleteボタンが表示されます。 クリックすると「This operation cannot be undone, confirm to delete?」（この操作は取り消しできません。削除しますか？）というメッセージが表示されます。削除しても問題ない場合、Confirmをクリックしてください。
※SenseLinkではデバイスを登録できませんのでご注意ください。削除したデバイスを再度SenseLinkに登録する場合はデバイス側から登録操作を行なってください。
Websocketプロトコルを利用したPush通知機能について記載されています。
デバイスの認証レコードやデバイスのアラートをPushするには、websocket プロトコルを利用します。
注記 :本Push通知はSenseLink GE V1.10.7を利用していたユーザー向けの機能です。 SenseLink GE V2.2.0以降では標準としてイベントサブスクリプションがサポート、利用が推奨されています。
接続アドレス :
ws://HOST:9000/websocket/record/{app_key}/{timestamp}/{sign}
接続パラメーター :
Wiegand34
Network Relay+Relay IP
Wiegand26(24bit ID)
Network(TCP)
Device Name
デバイス名
必須項目
半角全角英数、ひらがな、全角カタカナ、漢字 -_/%（半角）半角文字数1~50
Location
デバイスの設置場所 必須項目
半角全角英数、ひらがな、全角カタカナ、漢字 -_/%（半角）半角文字数1~50
Description
デバイスの説明
半角全角英数、ひらがな、全角カタカナ、漢字 -_/%（半角）半角文字数1~50
First online time
初回オンライン時刻
変更不可
Last online time
最終オンライン時刻
変更不可
Last update time
最終設定変更時刻
変更不可
Status Info
Door Status
接続ドアステータス
変更不可
Thermal Imager Status
サーモカメラステータス
変更不可
App Information
App package name
アプリケーションのパッケージ名
変更不可
App version name
アプリケーションのバージョン
変更不可
App version code
アプリケーションのバージョンコード
変更不可
Firmware Information
Product model
デバイスの型番
変更不可
Product Serial Number
デバイスのシリアルナンバー
変更不可
Firmware version
デバイスのファームウェアバージョン
変更不可
Manufacturer
デバイスの開発元
変更不可
Hardware version code
デバイスのハードウェアバージョンコード
変更不可
Strong Prompt
（一部SenseThunderシリーズのみ）
温度検知・認証時、デバイス画面の表示を変更します。成功すると緑色、失敗すると黄色になります。
Touch Recognition
認証が行われない間デバイスが待機モード表示に切り替わります。認証時画面をタッチすることで認証モードに切り替わります。
Show Username 氏名表示
認証成功時の登録車の氏名表示/非表示の設定（On / Off、デフォルトOn）
Door open for blacklist
ブラックリストドアオープン
認証者がブラックリスト登録者だった場合にドアオープンシグナルをエクスポートするかの設定
（On / Off、デフォルトOff）
GPIO C-input port GPIO C-output ポート
GPIO C入力シグナル種類の選択
（Null、Door magnet、Out button、Fire signal、デフォルトNone）
Wiegand input
Wiegand入力
Wiegandシグナル入力の設定
Wiegand26(8+16bit ID)
Wiegand26(24bit ID)
Wiegand32
Wiegand34
デフォルトNone
Buzzer Alarm Switch
盗難アラート
デバイス盗難アラートOn/offの設定
（On / Off、デフォルトOn）
Normally Open Period
サポートされない機能です。利用できません。
Normally Closed Period
サポートされない機能です。利用できません。
install.sh
ファイル
インストール
restart_lightweight.sh
ファイル
サービスの再起動
（Dockerイメージの停止、再起動）
restart.sh
ファイル
サービスの再起動
（Dockerイメージの停止および削除、再作成、再起動）
uninstall.sh
ファイル
アンインストール
update.sh
ファイル
アップデート
verify-env.sh
ファイル
環境チェック
version
ファイル
サービスバージョン一覧
public
ディレクトリ
下位ディレクトリ
scripts
ディレクトリ
下位ディレクトリ
ファイル名
ディレクトリ名
タイプ
概要
check_status.sh
ファイル
java_serviceステータスのチェック、インストール時使用
delete_all.sh
ファイル
停止したコンテナの削除
load_all.sh
ファイル
イメージファイルの読み込み
rmi_all.sh
サービス名
サービスポート
Grpcポート
Mysql
3306
MongoDB
27017
Redis
6379
Opq
下記2のポート以外はSenseLinkの内部サービス間の通信のみに使われ、外部との通信では必要がないため、開放する必要がありません。
下記2つのポートは外部との通信で利用するため、開放してください。
80 (httpでSenseLinkを利用する場合)
443 (httpsでSenseLinkを利用する場合)
上記以外のポートは外部からの通信を許可しない設定にすることをお勧めします。ただし、デバイスからSenseLinkのNTPサービスを使う場合、ポート123を開く必要があります。
ファイアウォールを使ってポートの外部通信を許可しない設定にすることが可能です。
ubuntuにはデフォルトで「ufw」というファイアウォールツールが存在しています。詳細な使い方については、ubuntuのオフィシャルドキュメントをご参照ください(https://help.ubuntu.com/community/UFW)
本書では、「ufw」を使ってポートの外部通信をブロックする方法を例としてご紹介します。
ターミナル（端末）を開き、まず、すべてのポートをブロックしてください。
SenseLinkのために80番もしくは443番のポートを、その他お客様ご自身がご利用になるアプリケーションのためのポート（例：SSH通信のための22番）に外部通信を許可してください。
メールサービスが必要な場合、必要に応じてアウトバンドポートを開いてください。
smtpポートを開く例：
ufwを有効化してください。
イメージファイル名
サイズ（MB）
含まれるサービス
senselink/database_service
943
Mysql; MongoDB; Redis
senselink/opq_service
266
Opq
senselink/feature_service
60
Feature
senselink/sync_service
イメージ
ディレクトリ
コンテナ内ディレクトリ
内容
senselink/database_service
/data/sensetime/senselink/mysql/data
/var/lib/mysql
Mysqlデータ
/data/sensetime/senselink/mongodb/data
/data/mongodb
MongoDBデータ
すべてのイメージ
上記マウントディレクトリ/data/sensetime/senselinkは8.8 データ保存ディレクトリの変更の設定次第で変化します。
ファイル名
ディレクトリ名
タイプ
概要
config
ファイル
パス設定
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
メッセージ本体 :
code:30000 認証レコード
code:30100 アラートレコード
概要
すべてのデバイスの認証レコードPushをリアルタイムで受信します (WebSocket)。
code=30000
メッセージ本体データ
パラメーター名
型
説明
id
int
レコード ID
userId
int
認証されたユーザーの ID
name
string
認証されたユーザーの名前
direction
group フィールドの説明
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ。1 : 従業員グループ、2 : ビジターグループ、5 : ブラックリストグループ
例
接続成功 :
接続失敗 :
ハートビート検知 :
メッセージPush本体 :
概要
すべてのデバイスのアラートレコードのPush (WebSocket) を受信します。
code=30100
メッセージ本体データ
パラメーター名
型
説明
id
long
アラートレコードのID
level
int
アラートレベル。1 : アラート、2 : 異常
code
int
アラートのタイプ。10001 - デバイスの盗難アラート、10002 - ドアの強制開放、10003 - ドアセンサータイムアウト、10004 - パスワードクラッキング、10005 - （サポートされないアラートです。現在利用できません）、10006 - サーモグラフィカメラ接続異常、20001 - カメラの汚れ、20002 - Non-Living アタック（非生体による認証）、20003 - 消防アラート、30001 - デバイスオフラインアラート、40001 - 特徴量抽出エラー
description
例
接続成功 :
接続失敗 :
ハートビート検知 :
メッセージPush本体 :
パラメーター名
型
必須
説明
$ sudo ufw default DENY$ sudo ufw allow 22
$ sudo ufw allow 80
$ sudo ufw deny 443$ sudo ufw allow out to any port {smtp port} proto tcp$ sudo ufw allow out to any port 465 proto tcp$ sudo ufw enable{
"code": 30000,
"desc": "",
"message"： "",
"data": {
...
}
}{
"code": 20000,
"message": " Connected!",
"desc": "Connected!"
}{
"code": 20002,
"message": "Permission Denied!",
"desc": "app key not exist"
}{
"code": 10000,
"desc": "heart beat",
"message": "heart beat"
}{
"code":30000,
"message":"push record",
"data":{
"id":1364591,
"userId":0,
"name":"",
"type":3,
"avatar":"",
"direction":0,
"verifyScore":0,
"receptionUserId":0,
"receptionUserName":"",
"groups": [
{
"id": 1,
"name": "Default group",
"type": 1
}
],
"deviceName":"bella pro",
"sn":"SPSP-f26131cf5301be29b3a6f7be150ed330",
"signDate":"2019-09-29",
"signTime":1569725174,
"signAvatar":"5d901af663cdaf0001252bb9",
"signBgAvatar":"5d901af663cdaf0001252bba",
"mobile":"",
"icNumber":"",
"idNumber":"",
"jobNumber":"",
"remark":"",
"entryMode":1,
"signTimeZone":"+08:00",
"docPhoto":"",
"location":"306",
"abnormalType":0
}
}{
"code": 20000,
"message": "Connected!",
"desc": "Connected!"
}{
"code": 20002,
"message": "Permission Denied!",
"desc": "app key not exist"
}{
"code": 10000,
"desc": "heart beat",
"message": "heart beat"
}{
"code": 30100,// アラートレコード
"desc": "",
"message"： "push alarm",
"data": {
"id": 0,
"level": 0,
"code": 0,
"description": "",
"status": 0,
"traceId": "",
"deviceId": 0,
"deviceName": "",
"deviceSn": "",
"deviceLocation": "",
"alarmTime": "",
"releaseTime": "",
"alarmPhoto": "",
"resloveOption": 0
}
}ファイル
イメージファイルの削除
run_all.sh
ファイル
コンテナの生成と起動
sedConfigs.sh
ファイル
config情報設定、インストール時使用
setMasterInfo.sh
ファイル
master情報設定、インストール時使用
start_all.sh
ファイル
コンテナの起動
stop_all.sh
ファイル
コンテナの停止
database_service
ディレクトリ
−
admin_web_service
ディレクトリ
−
emq_service
ディレクトリ
−
feature_service
ディレクトリ
−
event_service
ディレクトリ
−
java_inner_service
ディレクトリ
−
lgapi_service
ディレクトリ
−
fs_service
ディレクトリ
−
gateway_service
ディレクトリ
−
infra_service
ディレクトリ
−
java_openapi_service
ディレクトリ
−
java_service
ディレクトリ
−
nebula_service
ディレクトリ
−
tk_service
ディレクトリ
−
tools
ディレクトリ
−
java_websocket_service
ディレクトリ
−
net_service
ディレクトリ
−
opq_service
ディレクトリ
−
schedule_service
ディレクトリ
−
slinkpush_service
ディレクトリ
−
sntp_service
ディレクトリ
−
sync_service
ディレクトリ
−
web_service
ディレクトリ
−
zookeeper
ディレクトリ
−
9001, 9022
Feature
50052
Sync
1010
50051
Link
8080, 20860
8081
OpenAPI
8099
Schedule
8091
infra
50009
50010
Web
80
SNTP
10080, 123
50080
Emq
1883, 8083, 8883, 8084, 18083, 18084
Slinkpush
50055
fs
20080
Websocket
9000
9099
Netcheck
30080
ZooKeeper
2181
event
8089
20870
lgapi
40080
nebula
55555
20861
tk
8092
20880, 50011
37
Sync
senselink/java_service
198
Link
senselink/java_openapi_service
219
OpenAPI
senselink/schedule2_service
12
Schedule
senselink/infra2_service
8
Infra
senselink/web_service
180
Web
senselink/sntp_service
35
ntp
senselink/emq_service
190
Emq
senselink/slinkpush_service
28
Slinkpush
senselink/fs_service
33
Fs
senselink/java_websocket_service
219
Websocket
senselink/net_service
34
Net
senselink/zookeeper_service
495
ZooKeeper
senselink/event_service
330
Event
senselink/lgapi_service
29
Lgapi
senselink/nebula_service
330
Nebula
senselink/tk_service
219
Tk
/etc/localtime
/etc/localtime
すべてのコンテナとローカルタイムの一致
すべてのログ
/data/sensetime/senselink/log
/slink/api/log
ログ
int
デバイスのアクセス方向
type
int
ユーザーの識別子タイプ
verifyScore
float
認証スコア
receptionUserId
int
認証されたユーザーの応対者の ID
receptionUserName
string
認証されたユーザーの応対者の名前
groups
list<group>
認証されたユーザーのグループ情報
deviceName
string
デバイス名
sn
string
この認証レコードのデバイス LDID 番号をアップロードします
signDate
string
認証レコードの日付
avatar
string
認証用顔写真
signAvatar
string
認証時写真（サムネイル）
signBgAvatar
string
認証時写真（大）
signTime
timestamp
認証時間 (秒)
mobile
string
認証されたユーザーの携帯電話番号
icNumber
string
認証されたユーザーの IC カード番号
idNumber
string
認証されたユーザーの ID 番号（利用できません）
jobNumber
string
認証されたユーザーの従業員ID
remark
string
備考
entryMode
int
認証モード (1 : 顔認証、2 : QR コード、3 : カード、4 : 顔認証とカード、5 : ID カード、6 : 顔認証と ID カード)
signTimeZone
string
認証レコードのタイムゾーン
docPhoto
string
ID 写真
location
string
デバイスの設置場所
abnormalType
int
認証レコードの異常のタイプ。0 - なし、10001 -IDカード不一致、10002 -認証カード不一致、10003 - 認証コード不一致、20001 -ビジターが有効期限外、20002 - アクセス時間外、30001 - 無効な ID カード、30002 - 無効な IC カード、30003 - 無効な QR コード、40001 - 異常な体温、50001 - マスク着用なし
bodyTemperature
float
体温
mask
int
マスク着用識別子。0 - 不明、0 - 着用なし、2 - 着用あり
string
アラートの説明
status
int
アラートのステータス。1 : アラート作動中、2 : 解除中、3 : 解除済み
traceId
string
アラートのシリアル番号。デバイスによって生成されるアラート固有の識別番号です。
deviceId
long
デバイスの ID
deviceName
string
デバイス名
deviceSn
string
デバイスの LDID
deviceLocation
string
デバイスの設置場所
alarmTime
string
アラート時間
releaseTime
string
アラートの解除時間
alarmPhoto
string
アラート写真
resloveOption
int
アラートの解除オプション。0 : 解除不要、1 : デバイスエンドでの解除のみをサポート、2 : リモート解除のみをサポート、3 : デバイスエンドまたはリモートでの解除
0 解除不要 : 10004 : パスワードクラッキング、20002 : Non-Living アタック（非生体による認証）、30001 : デバイスオフラインアラート
1 デバイスエンドでの解除のみをサポート : 10003 ドアセンサータイムアウト、20001 カメラの汚れ、10005 （サポートされないアラートです。現在利用できません）、10006 サーモグラフィカメラ接続異常
3 デバイスエンドまたはリモートでの解除10001 デバイスの盗難アラート、10002 ドア・ゲート強制突破アラート、20003 消防アラート
No
デバイスシリアル番号
type
int
No
タイプ : { 1 : 従業員、2 : ビジター、3 : 未登録人物； 5 : ブラックリスト}
user_id
long
No
登録者ID
date_time_from
string
No
開始日。デフォルト値は現在の日付の 0 時。
date_time_to
string
No
終了日。デフォルト値は現在の日付の 23:59:59。
name
string
No
登録者名
page
int
No
ページ番号 (デフォルトは 1 です)
size
int
No
1 ページあたりのデータの数（デフォルトは 20)。最大値は 100。
entry_mode
int
No
認証モード (1 : 顔認証、2 : QR コード、3 : カード、4 : 顔認証とカード、5 : ID カード、6 : 顔認証と ID カード) 1 : 顔認証のみ利用できます。
user_id
long
No
登録者ID
group_id
long
No
グループID
mis_type
int
No
誤認証タイプ。1 : 別の人物、2 : 未登録人物、3 : 非生体、4 : 未登録人物からの攻撃、5 : 非生体からの攻撃
abnormal_types
int
No
認証レコードの以上検知タイプ。0 - なし、10001 – IDカード不一致、10002 -認証カード不一致、10003 - 認証コード不一致、20001 - ビジターが有効期限外、20002 - アクセス時間外、30001 - 無効な ID カード、30002 - 無効な IC カード、30003 - 無効な QR コード、40001 - 体温が異常、50001 - マスク着用無し
Yes
タイムスタンプ
現在のページ番号
page_size
int
ページサイズ
total_page
int
ページ合計
未登録者レコードの数
record_list
list<recordItem>
認証レコード
携帯電話番号
remark
string
特記事項
groups
list<group>
グループ
capture_picture
string
認証時にデバイスが撮影した写真（サムネイル）の ID
capture_bg_picture
string
認証時にデバイスが撮影した写真（大）の ID
avatar
string
認証用顔写真
user_id
int
登録者 ID
user_name
string
登録者名
user_type
int
登録者タイプ
group_id
int
グループ ID
group_name
string
グループ名
device_name
string
デバイス名
device_ldid
string
デバイス LDID
sign_time
string
認証時間
entry_mode
int
認証モード
sign_time_zone
string
タイムゾーン
verify_score
float
認証スコア
mis_id
int
誤認証 ID
mis_type
int
誤認証タイプ
doc_photo
string
ID カード写真（利用できません）
ic_number
string
IC カード番号
id_number
string
ID カード番号読み込み（利用できません）
abnormal_type
int
異常レコードタイプ0 - なし、10001 -IDカード不一致、10002 -認証カード不一致、10003 - 認証コード不一致、20001 - ビジターが有効期限外、20002 - アクセス時間外、30001 - 無効な ID カード、30002 - 無効な IC カード、30003 - 無効な QR コード、40001 - 体温が異常
job_number
string
従業員ID
user_ic_number
string
登録者 IC カード番号
user_id_number
string
登録者 ID 番号
reception_user_id
long
受付担当者 ID
reception_user_name
string
受付担当者名
user_remark
string
登録者コメント
sign_date
string
認証日
body_temperature
float
体温
mask
int
マスク着用識別子。0 - 不明、1 - 着用なし、2 - 着用あり
パラメーター名
型
必須
説明
start_record_id
long
No
認証レコード の開始ID
end_record_id
long
No
認証レコード の終了ID
device_sn
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
total
int
総計
size
int
容量
data
object
認証レコードの情報
page_num
パラメーター名
型
説明
total
int
総計
user_count
int
従業員レコードの数
guest_count
int
ビジターレコードの数
stranger_count
パラメーター名
型
説明
id
int
認証レコード ID
direction
int
デバイスのアクセス方向
location
string
勤務地
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
string
string
int
int
string
{
"code": 200,
"message": "OK",
"data": {
"total": 118,
"size": 3,
"data": {
"total": 118,
"user_count": 35,
"guest_count": 0,
"stranger_count": 65,
"record_list": [
{
"id": 1361801,
"direction": 0,
"latitude": null,
"longitude": null,
"address": null,
"location": "306lsh",
"remark": null,
"mobile": "",
"groups": [
{
"id": 1,
"name": "Default group",
"type": 1,
"devices": null,
"is_default": null
}
],
"capture_picture": "5d886e584bb1c40001ad458e",
"capture_bg_picture": "5d886e584bb1c40001ad458f",
"avatar": "5d7a680a4bb1c40001ac80f6",
"user_id": 100100,
"user_name": "Liping Xiao アップデート",
"user_type": 1,
"group_id": null,
"group_name": null,
"device_name": "lsh02",
"device_ldid": "SPS-257bfefb52b1b88237d195c1ad944063",
"sign_time": 1569222232,
"country_code": null,
"place_code": null,
"on_business": 0,
"entry_mode": 1,
"sign_time_zone": "GMT+08:00",
"verify_score": null,
"mis_id": null,
"mis_type": null,
"doc_photo": "",
"ic_number": "",
"id_number": "",
"abnormal_type": null，
"job_number": "",
"user_ic_number": "",
"user_id_number": "",
"reception_user_id": 0,
"reception_user_name": "",
"sign_date": 2019-11-26",
"user_remark": ""，
"body_temperature": 37.3，
}
]
},
"page_num": 1,
"page_size": 3,
"total_page": 40
}
}当製品を利用して顔認証デバイスのファームウェアやぷりケーションをアップデートする方法について記載されています。
ToolKitを利用して、SenseLinkに連携された顔認証デバイスのファームウェアやアプリケーションをSenseLink経由でアップデートすることができます。
以下では、ToolKitからSenseLinkにアップデートするファームウェアまたはアプリケーションをアップロードすること「アップロード」、SenseLinkからデバイスへファームウェアまたはアプリケーションを配信しアップデートすることを「配信」と呼びます。
ファームウェアのアップデートを行います。Home画面のFirmwareをクリックしてください。プロダクトモデル一覧画面（Firmwareタブ）が表示されます。Upload Firmwareボタンをクリックしてください。
ファームウェアアップロード画面が表示されます。
各項目にアップロードするファームウェアの情報を入力します。
*は必須入力・選択項目です。
※1 ファームウェア名の例：sensepass-ota-user.jinpingmi.v2.3.1.20yymmddd.nnnnn.zip （zipファイルは解凍しないでください。）
すべての項目を入力・選択したら、ページ最下部にあるUploadボタンをクリックしてください。ファームウェアがSenseLinkにアップロードされます。Firmware upload progress欄のメーターが100%になるとアップロード完了です。
アップロードが完了したら、Firmware uploadのタブからFirmwareのタブに移動してください。
アップロードしたファームウェアのプロダクトモデルが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのファームウェアの一覧が表示されます。先ほどアップロードしたファームウェアのOperation欄にある Publish upgradeをクリックしてください。
Upgrade Strategy（アップデート方法）とUpgrade scope（配信範囲）を指定します。
Update Strategy（アップデート方法）の種類
Upgrade scope（配信範囲）でファームウェアを配信するデバイスを指定してください。
All devices（すべてのデバイス）またはSelected devices（デバイスの指定）から選択できます。 デバイスの指定を選択した場合は、デバイス一覧から配信するデバイスにチェックを入れ選択する必要があります。デバイスの一覧にはハードウェアバージョンが一致するデバイスのみ表示されます。
すべての項目の設定が完了したら、Publish upgradeボタンをクリックしてください。デバイスにファームウェアが配信され、設定したアップデート方法に合わせたアップデートが開始されます。
アップロードしたファームウェアのステータス変更を行います。ステータスを変更することによって誤配信を防ぐことができます。 プロダクトモデル一覧画面でアップロードしたファームウェアのプロダクトモデルが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのファームウェアの一覧が表示されます。ステータスを変更したいファームウェアのEnables status欄のスイッチをクリックし、not enablesステータスに変更してください。
利用しなくなったファームウェアをSenseLinkから削除します。誤配信を防ぐためにも、定期的に不要なファームウェアの削除を行なってください。
プロダクトモデル一覧画面でアップロードしたファームウェアのプロダクトモデルが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのファームウェアの一覧が表示されます。ステータスを変更したいファームウェアの upgrade.deleteボタンをクリックしてください。 ファームウェアが削除されます。
プロダクトモデルごとのファームウェアの配信ステータスを確認することができます。 プロダクトモデル一覧画面でアップロードしたファームウェアのプロダクトモデルが表示されます。確認するプロダクトモデルのOperation欄にあるVersion distributionボタンをクリックしてください。
ファームウェア配信ステータスが表示されます。 上段はすべてのデバイス数やファームウェアの数の概要とグラフが表示されます。 下段はデバイスごとの詳細情報が表示されます。
アプリケーションのアップデートを行います。Home画面のApplicationをクリックしてください。パッケージ一覧画面（Applicationタブ）が表示されます。Upload appボタンをクリックしてください。
アプリケーションアップロード画面が表示されます。
各項目にアップロードするファームウェアの情報を入力します。
*は必須入力・選択項目です。
すべての項目を入力・選択したら、ページ最下部にあるUploadボタンをクリックしてください。アプリケーションがSenseLinkにアップロードされます。Application upload progress欄のメーターが100%になるとアップロード完了です。
App UploadタブからApplicationタブに移動してください。
パッケージ一覧画面（Applicationタブ）でアップロードしたアプリケーションのパッケージが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのアプリケーションの一覧が表示されます。先ほどアップロードしたアプリケーションのOperation欄にあるPublish upgradeをクリックしてください。
Upgrade Strategy（アップデート方法）とUpgrade scope（配信範囲）を指定します。
Update Strategy（アップデート方法）の種類
Upgrade scope（配信範囲）でファームウェアを配信するデバイスを指定してください。
All devices（すべてのデバイス）またはSelected devices（デバイスの指定）から選択できます。 デバイスの指定を選択した場合は、デバイス一覧から配信するデバイスにチェックを入れ選択する必要があります。デバイスの一覧にはパッケージが一致するデバイスのみ表示されます。
すべての項目の設定が完了したら、Publish upgradeボタンをクリックしてください。デバイスにアプリケーションが配信され、設定したアップデート方法に合わせたアップデートが開始されます。
アップロードしたアプリケーションのステータス変更を行います。ステータスを変更することによって誤配信を防ぐことができます。
パッケージ一覧画面（Applicationタブ）でアップロードしたアプリケーションのパッケージが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのアプリケーションの一覧が表示されます。ステータスを変更したいアプリケーションのEnables status欄のスイッチをクリックし、not enablesステータスに変更してください。
利用しなくなったアプリケーションをSenseLinkから削除します。誤配信を防ぐためにも、定期的に不要なアプリケーションの削除を行なってください。
パッケージ一覧画面（Applicationタブ）でアップロードしたアプリケーションのパッケージが表示されます。左側に表示される > ボタンをクリックしてください。アップロード済みのアプリケーションの一覧が表示されます。ステータスを変更したいアプリケーションの upgrade.deleteボタンをクリックしてください。 アプリケーションが削除されます。
パッケージごとのアプリケーションの配信ステータスを確認することができます。 パッケージ一覧画面（Applicationタブ）でアップロードしたアプリケーションのパッケージが表示されます。確認するパッケージのOperation欄にあるVersion distributionボタンをクリックしてください。
アプリケーション配信ステータスが表示されます。 上段はすべてのデバイス数やアプリケーションの数の概要とグラフが表示されます。 下段はデバイスごとの詳細情報が表示されます。
Model Management（モデル管理）はサポートされない機能です。利用できません。
*ROM ver
ファームウェアのバージョン。
半角英数
V1.2.3 のように大文字Vから始まり二つの.（ドット）で区切られる3桁の数字、またはV1.2.3-yyyymmdd-[管理番号]の形式で指定してください。
6
255
*Applicable hardware version
適用するハードウェアアバージョン。
SensePass ProまたはSenseThunder Eをご利用中の場合はSPS020PROV2を、
SensePass2またはSenseThunder Miniをご利用中の場合は
SPS020V3入力してください。
8
11
*Update Title
更新タイトル。ファームウェアの管理のために任意のタイトルを利用いただけます。
半角英数、-/*+
1
255
*Chinese Description
アップデート内容。中国語以外も入力いただけます。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
255
English description
アップデート内容。英語以外も入力いただけます。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
0
255
Manufacturer
開発元
JCVより指定がない限り固定値：SenseTimeを入力してください。
0
255
*Upgrade Type
アップデートタイプ
JCVより指定がない限りFull Packageを指定してください。
-
*Version name
アプリケーションのバージョン
半角英数、.（ドット）
V1.2.3 のように大文字Vから始まり二つの.（ドット）で区切られる3桁の数字、またはV1.2.3-yyyymmdd-[管理番号]の形式で指定してください。
6
255
*Version code
アプリケーションのバージョンコード
半角数字、.（ドット）
最大値2147483647
VやVerなど英字は利用できません。数字のみ入力してください。
2
11
*Update Title
更新タイトル。アプリケーションの管理のために一意のタイトルを利用いただけます。
半角英数、-/*+
1
255
*Chinese Description
アップデート内容。中国語以外も入力いただけます。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
255
English description
アップデート内容。英語以外も入力いただけます。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
0
255
Manufacturer
開発元
JCVより指定がない限り固定値：SenseTimeを入力してください。
0
255
*Upgrade Type
アップデートタイプ
選択できません。
-
項目
詳細
入力可能文字種、フォーマット、
注意事項など
最小入力文字数制限（半角換算）
最大入力文字数制限（半角換算）
*Select firmware file
※1
アップロードするファームウェアの選択。ToolKitをご利用中のPC/サーバー上に保存されたファームウェアを指定してください。
-
-
*Product Model
SPS020-PRO
または
SPS020-STDの選択
SensePass ProまたはSenseThunder Eをご利用中の場合はSPS020-PROを、
SensePass2またはSenseThunder Miniをご利用中の場合はSPS020-STDを選択してください。
-
種類
概要
Ordinary upgrade
ノーマルアップデート
アップデート操作後デバイスの画面上に更新メッセージが表示され、ユーザーが許可した場合のみアップデートが開始されます。
Silence upgrade
サイレンスアップデート
アップデート操作後即アップデートが開始されます。デバイスの画面上に更新メッセージは表示されません。
Timing upgrade
設定時間アップデート。設定された時間にアップデートが行われます。
項目
詳細
入力可能文字種、フォーマット、
注意事項など
最小入力文字数制限（半角換算）
最大入力文字数制限（半角換算）
*Select application file
※1
アップロードするアプリケーションの選択。ToolKitをご利用中のPC/サーバー上に保存されたアプリケーションフィアルを指定してください。
-
-
*Package name
パッケージ名
SensePass ProまたはSenseThunder Eをアップロードする場合はcom.sensetime.sensepassproegeを、
SensePass2またはSenseThunder Miniをアップロードする場合はcom.sensetime.sensepassgeを選択してください。
-
種類
概要
Ordinary upgrade
ノーマルアップデート
アップデート操作後デバイスの画面上に更新メッセージが表示され、ユーザーが許可した場合のみアップデートが開始されます。
Silence upgrade
サイレンスアップデート
アップデート操作後即アップデートが開始されます。デバイスの画面上に更新メッセージは表示されません。
Timing upgrade
設定時間アップデート。設定された時間にアップデートが行われます。
Force upgrade
強制アップデート
アップデート操作後デバイスの画面上に更新メッセージが表示され、そのままアップデートが開始されます。
当製品を利用して従業員を登録、変更、削除する方法について記載されています。
従業員情報を最大50,000件まで一括で登録することができます。
（ただしアップロードするExcelファイルや合計の認証用顔写真ファイルのサイズに上限があります。ご注意ください。）
ホーム画面のEmployee Management欄にあるBulk Import（複数登録）をクリックしてください。 Bulk Importのタブが追加表示されます。Start Importボタンをクリックしてください。
Step 1が表示されます。
従業員情報情報を入力するためのExcelテンプレートをダウンロードします。
①Downloadボタンをクリックしてください。ファイル名とダウンロード先を指定し保存してください。デフォルトのファイル名は senselink_employee_upload_template_en.xlsx です。
保存されたExcelファイルを開いてください。
Excelファイルの1行目と2行目は編集、削除しないようにご注意ください。3行目から従業員情報を入力できます。テンプレートの3行目にPeterという氏名の従業員の入力例が記載されていますが、こちらはご確認後削除・上書きして登録してください。
名前は必須項目、その他はオプション項目です。電話番号、従業員番号、ICカード番号は異なる従業員が重複して登録することができません。
すでに登録済みの従業員情報を上書き・修正することはできません。修正が必要な場合は 3.2節 複数修正を参照してください。
※1 「Name」氏名は入力必須項目です。
※2 携帯電話番号は一意である必要があります。
※2 従業員で重複する名前が存在する場合、必ず携帯電話番号を入力して管理してください。次項のStep2で顔写真の登録ができません。また3.2節 複数修正 など以降の操作でエラーが発生します。
準備した従業員の認証用顔写真のファイル名が従業員の氏名の場合（例：山田 太郎.jpg）、認証用顔写真ファイル名からExcelファイルのName欄を記入してExcelファイルを生成することができます。
Select Avatar Folderボタンをクリックし、認証用顔写真ファイルが保存されているフォルダを選択してください。
指定したフォルダの1階層上のフォルダ内に、Name欄が入力されたExcelファイルが保存されます。このExcelファイルを利用して、その他の従業員情報を入力してください。
Excelファイルの準備ができたら、アップロードします。
②Uploadボタンをクリックして従業員情報を入力したExcelファイルを選択してください。Excelファイルのサイズは2MB以下である必要があります。
③Importボタンをクリックしてください。
Excelファイルの内容に誤りがある場合、エラーメッセージが表示されインポートが完了しません。エラーメッセージの内容にしたがってExcelファイルを修正し、もう一度アップロードおよびインポートを行なってください。
エラーメッセージのフォーマット
従業員情報のインポートが完了すると、自動的に従業員の認証用顔写真のアップロード用のページに遷移します。
Face quality detection levelの欄で認証用顔写真品質チェックレベルを選択します。
Low（低）： 自分の顔以外他人の顔が映っていないこと、写真データのフォーマットはJPEG、またはPNGであること、写真データのサイズが4,000,000バイト （=約3.8MB、約3,900KB）以下であることの3点をチェックします。
High（高）： 写真のすべての規格項目をチェックします。
Select Avatar Folderをクリックして認証用顔写真が保存されているフォルダを選択してください。
認証用顔写真およびフォルダは以下の規格を満たす必要があります。
認証用顔写真の規格はSenseLink GE Enterprise ユーザーマニュアル 登録写真の規格 の節を参照してください。Face quality detection levelで低を選択している場合は、「写っている人物が一人のみで、他人の顔が写っていないこと」、および認証用顔写真ファイルサイズのみチェックします。
フォルダ内の認証用顔写真ファイル数が50,000件以下であること
フォルダ内の認証用顔写真ファイルサイズの合計が2GB以下であること
認証用顔写真ファイル名が従業員名であること
フォルダ選択後、Nextボタンをクリックしてください。認証用顔写真のアップロードが開始されます。 フォルダまたは認証用顔写真ファイルに誤りがある場合、エラーメッセージが表示されアップロードが開始されません。エラーメッセージの内容にしたがってフォルダまたは認証用顔写真ファイルを修正し、もう一度アップロードを行なってください。
アップロードが開始されるとImages upload progress欄で認証用顔写真アップロードの進捗状況が確認できます。
Costに経過時間、Remainingに予想残り時間が表示されます。
認証用顔写真のアップロードが完了すると、認証用顔写真の特徴量抽出等の処理が開始されます。Images processing progress欄で認証用顔写真処理の進捗状況が確認できます。
全てのプロセスが完了すると、完了メッセージが画面上部に表示されます。
認証用顔写真アップロードの結果をエクスポートします。View Import Resultボタンをクリックしてください。Excelファイルがエクスポートされ、ファイルが開きます。View Import ResultボタンをクリックしないとExcelファイルはエクスポートされません。
または、SenseLinkのWebページから認証用顔写真アップロードの結果をエクスポートすることもできます。
認証用顔写真アップロード完了時に「Unable to obtain avatar import status, please check operation log via SenseLink web page」のメッセージが表示された場合もSenseLinkのWebページから確認してください。 ナビゲーションメニューの[System Management]-[Operation Log]からDownload Detailをクリックしてください。
View Import ResultボタンまたはDownload Detailsをクリックするとemployeeimport_result[エクスポートコード].xls がエクスポートされます。ファイルを開いてください。
Resultシートには各認証用顔写真の登録結果が記載されています。
A列に各認証用顔写真ファイル名が記載されます。
B列のResultがアップロード結果です。failの場合失敗、successの場合成功です。Failの場合C列にエラーの原因が記載されます。
Overviewシートには認証用顔写真アップロードの概要が記載されています。
すでに登録済みの従業員情報の修正を行います。従業員の認証用顔写真の修正を行う場合は次項を参照してください。
Home画面のBatch Modifyボタンをクリックしてください。
複数修正画面へ遷移します。
登録済みの従業員情報をエクスポートします。①Export employee list をクリックしてください。
「Excel file will be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックするとエクスポートするファイル名と保存先を指定できます。
ファイル名はデフォルトでsenselink_employeelist_export.xlsx です。 ファイル名と保存先を指定したら保存し、エクスポートされたファイルを開いてください。ファイルを開く際にパスワードを求められます。パスワードはToolKitにログイン中のアカウントです。
Excelファイルを開いたら、修正したい情報を修正してください。
Excelファイルの1行目と2行目は編集、削除しないようにご注意ください。3行目以降の従業員情報を修正できます。A列はSenseLinkが各従業員に付与し管理するための内部IDです。編集、削除しないでください。 B列以降は以下の項目です。
※1 氏名は入力必須項目です。
※2 携帯電話番号は一意である必要があります。
※2 従業員で重複する名前が存在する場合、必ず携帯電話番号を入力して管理してください。
修正が完了したら、Excelファイルのパスワードによる保護を解除してください。
ファイルを[名前をつけて保存]してください。
Windowsをご利用中の場合 ファイル名および保存先選択画面の[ツール]をクリックし、[全般オプション]をクリックします。パスワードを消去してOKをクリックし、ファイルを保存してください。
Macをご利用中の場合 ファイル名および保存先選択画面の[オプション]をクリックしてください。パスワードを消去してOKをクリックし、ファイルを保存してください。
Linuxをご利用中でMicrosoft Office Excel と互換性のあるソフトウェアをご利用中の場合 ソフトウェアのマニュアルに従ってパスワードによる保護を解除してください。
Upload the list of modified employeeボタンをクリックして、修正したExcelファイルをアップロードしてください。
アップロードが完了すると、Batch modification succeededのメッセージが画面上部に表示されます。
Excelファイルの内容に誤りがある場合、「Error message：The current table has an error of N, please re-upload after modification」 (アップロードしたテーブルにN個のエラーが存在します。修正して再度アップロードしてください。) のエラーメッセージが表示されます。ファイルの内容を修正してもう一度アップロードしてください。
すでに登録済みの従業員の認証用顔写真の修正を行います。Home画面のBatch Importボタンをクリックしてください。Bulk Importのタブが追加表示されます。Start Importボタンをクリックしてください。
Step 1が表示されます。Step 1のSkipボタンをクリックしてください。
「Only employees who already exist in the database can register avatars. If the avatars name does not match the employee's name, the avatars will not be registered. Confirm to skip the employee info upload?」（すでに登録済みの従業員のみ写真を登録することができます。写真ファイル名が従業員の氏名と一致しない場合、登録できません。従業員情報の登録をスキップしますか？）のメッセージが表示されます。Confirmボタンをクリックしてください。
以降の手順は3.1.2項 従業員の認証用顔写真のアップロード（Step 2） を参照してください。
半角数字
+ -（半角）
入力フォーマット制限
国別/エリアコード（日本の場合81）、-（マイナス）記号を記載の上、番号の入力を行なってください。先頭に+（プラス）記号は付与しないでください。
日本の携帯電話番号が090-1234-5678の場合、81-9012345678が有効な入力値です
XXX-YYYYYY形式の場合
6
20
C
Department
所属部署
入力内容に従って自動的に部署の階層が登録されます。最上位部署から記入を開始し、下位部署は半角ハイフンの後に入力してください。（例：海外ビジネス部門-マーケティング本部）, 一人の従業員は一つの部署のみに所属することができます。部署名に半角ハイフン(-)を含むことはできません。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号 左欄の文字数は1部署名の制限です。
1
30
D
Position
役職
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
E
Employee ID
従業員
半角数字
-
20
F
Head of this department (Y/N)
所属部署の責任者
所属部署の責任者の場合Yを、責任者ではない場合Nを入力してください。
-
-
H
Ext
外線電話番号
半角数字
-
20
I
Working place
勤務地
勤務地 半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
J
IC card※3
ICカード番号
半角英数字 Hexiadecima（16進数）またはDecimal（10進数）表記に従って入力
-
20
K
ID card
IDカード番号
中国国籍の方が持つ番号です。サポートされない機能のため、入力しないでくだし。
-
-
L
Entry time
入社日
入力フォーマットはYYYY-MM-DDです。2020年4月1日入社の場合、半角数字と半角ハイフンで2020-04-01 と入力してください。
-
-
M
BIrthday
生年月日
入力フォーマットはYYYY-MM-DDです。1975年1月1日生まれの場合、半角数字と半角ハイフンで1975-01-01 と入力してください。
-
-
N
Employee Group
従業員グループ
デフォルトグループに所属させる場合 Default group と指定してください。groupのgは小文字である必要があります。一人の従業員を複数の従業員グループに登録させる場合、グループ名を半角カンマ(,)で区切ってください 右欄の文字数は1グループ名の入力制限です。
1
30
O
Custom prompt
顔認証時に表示するカスタムメッセージ
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
P
Remark
特記事項
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
200
ただし氏名が重複する従業員が存在する場合、以下のフォーマットであること
[氏名] +[携帯電話番号].jpg （または.png）
携帯電話番号は前項で登録した国別コード付きの番号であること o
従業員の氏名が[山田 太郎]、電話番号が[81-8012345678]の場合、山田 太郎+81-8012345678.jpg （または.png）が規定のファイル名です
半角数字
+ -（半角）
入力フォーマット制限
国別/エリアコード（日本の場合81）、-（マイナス）記号を記載の上、番号の入力を行なってください。先頭に+（プラス）記号は付与しないでください。
日本の携帯電話番号が090-1234-5678の場合、81-9012345678が有効な入力値です。
XXX-YYYYYY形式の場合
Xは1～10桁までの半角数字
6
20
D
Department
所属部署
入力内容に従って自動的に部署の階層が登録されます。最上位部署から記入を開始し、下位部署は半角ハイフンの後に入力してください。（例：海外ビジネス部門-マーケティング本部）, 一人の従業員は一つの部署のみに所属することができます。部署名に半角ハイフン(-)を含むことはできません。
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
右欄の文字数は1部署名の制限です。
1
30
E
Position
役職
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
F
Employee ID
従業員
半角数字
-
20
G
Head of this department
(Y/N)
所属部署の責任者
所属部署の責任者の場合Yを、責任者ではない場合Nを入力してください。
-
I
Ext
外線電話番号
半角数字
-
20
J
Working place
勤務地
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
K
IC card※3
ICカード番号
半角英数字
Hexiadecima（16進数）またはDecimal（10進数）表記に従って入力
-
20
L
ID card
IDカード番号
（中国国籍の方が持つ番号です。サポートされない機能のため、入力しないでくだし。）
-
M
Entry time
入社日
入力フォーマットはYYYY-MM-DDです。2020年4月1日入社の場合、半角数字と半角ハイフンで2020-04-01 と入力してください。
-
N
Birthday
生年月日
入力フォーマットはYYYY-MM-DDです。1975年1月1日生まれの場合、半角数字と半角ハイフンで1975-01-01 と入力してください。
-
O
Employee Group
従業員グループ
デフォルトグループに所属させる場合 Default group と指定してください。groupのgは小文字である必要があります。一人の従業員を複数の従業員グループに登録させる場合、グループ名を半角カンマ(,)で区切ってください
左欄の文字数は1グループ名の入力制限です。
1
30
P
Custom prompt
顔認証時に表示するカスタムメッセージ
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
Q
Remark
特記事項
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
200
列
項目
詳細
入力可能文字種、フォーマット、注意事項など
最小入力文字数 （半角換算）
最大入力文字数 （半角換算）
A
Name※1
氏名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
30
B
Phone Number (Telephone) ※2
No
Name
Telephone
Error Details
エラーが発生した
Excelファイルの行番号
エラーが発生した
従業員名
エラーが発生した
従業員の携帯電話番号
エラーメッセージ
列
項目
詳細
入力可能文字種、フォーマット、注意事項など
最小 入力文字数制限 （半角換算）
最 大入力文字数制限 （半角換算）
B
Name※1
氏名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
30
C
Phone Number
(Telephone)
※2
携帯電話番号
携帯電話番号
Xは1～10桁までの半角数字
Yは6～17桁までの半角数字
+、-はそれぞれ1個まで
X、Y、+、- 合計最大20桁まで
YYYYYYの重複がチェックされます。
例：81-123456 と12-123456 は同一携帯電話番号として判断し、同時に登録できません 中国本土の番号の場合、国別コードの入力は不要です。
+、-はそれぞれ1個まで
X、Y、+、- 合計最大20桁まで
YYYYYYの重複がチェックされます。
例：81-123456 と12-123456 は同一携帯電話番号として判断し、同時に登録できません
中国本土の番号の場合、国別コードの入力は不要です。
アカウント管理やSenseLinkを運用するシステムの設定など、主にシステム管理者の方に利用いただくシステム管理について記載されています。
企業名や企業ロゴ、企業プロフィールなどの企業情報を管理できます。 ナビゲーションメニューの①「System Management」→②「Enterprise Information」をクリックしてください。
以下の項目を登録できます。
項目
アカウントの管理では、新しいアカウントの作成や既存アカウントの登録情報の修正、パスワード忘却時のリセットなどを行います。
利用用途に合わせて異なるロールのアカウントを管理し、安全にSenseLinkを利用することができます。
新規アカウントの登録はSuper AdminとSub Adminのみ行えます。
ナビゲーションメニューの①「System Management」→②「Account Permissions」→③「Create」をクリックしてください。
新規アカウント登録画面が表示されます。
以下の項目を入力してください。
項目入力後、Saveをクリックしてください。アカウントが発行されます。
パスワード生成方法でRandom Password by mailを選択した場合、登録したアカウントのEメールアドレスにアカウント名とパスワードの連絡が送信されます。
default passwordを選択した場合は、Super Adminが対象のユーザーにアカウントとパスワードを連絡してください。
Super Adminはすべてのアカウントの、それ以外のアカウントは自身のアカウントの修正を行うことができます。 ナビゲーションメニューの①「System Management」→②「Account Permissions」→③「Edit」または「Modify」をクリックしてください。
アカウント修正画面が表示されます。
Super Admin、それ以外のアカウントともに、自身のアカウントで修正できる項目はパスワードのみです。 現在のパスワードと新しいパスワード、新しいパスワードの確認の3つの項目を入力しSaveボタンをクリックしてください。
Super Adminは自身以外のアカウントのアカウント名、ロール、パスワード生成方法、特記事項を修正、およびアカウントの削除ができます。
修正後、Saveボタンをクリックしてください。 削除する場合はDeleteボタンをクリックしてください。
Super Admin以外がパスワードを忘却した時や、Super Admin以外の強制的なパスワードのリセットが必要な時に、Super Adminはパスワードをリセットすることができます。
Super Admin自身がパスワードを忘却した場合は、リセットすることができないので注意してください。
ナビゲーションメニューの①「System Management」→②「Account Permissions」→でアカウント一覧を表示し、パスワードをリセットしたいアカウントの③「Reset」をクリックしてください。
以下のメッセージが表示されます。
「Do you want to use a random password or a default password?(Admin1234@)？
Note: Random password will be sent to administrator mailbox
([登録されたメールアドレス])」
（ランダムパスワードとデフォルトパスワードのどちらを利用しますか？ ランダムパスワードはアカウントのメールボックス（[登録されたメールアドレス]）に送信されます）
どちらかを選択してください。
デフォルトパスワードを選択した場合、新しいパスワードは Admin1234@ です。
ランダムパスワードを選択した場合、アカウントに登録されたメールアドレスに新しいランダムなパスワードが送信されます。
オープンプラットフォームでは、SenseLinkを様々な外部システムと連携させるための機能を管理することができます。
SenseLinkのAPIを利用して、SenseLinkを様々な外部システムと連携することができます。
APIの利用方法の詳細についてはSenseLink GE Enterprise V2.2.0 APIマニュアルを参照してください。
本章ではAPIを利用するために必要なAppキーとAppシークレットの取得方法やAppシークレットのリセット方法について説明します。
ナビゲーションメニューの①「System Management」→②「Open Platform」をクリックしてください。
App Key（Appキー）とApp Secret（Appシークレット）が表示されています。 セキュリティ向上を目的にAppシークレットはデフォルトで非表示になっています。Showボタンをクリックして表示させてください。
SenseLinkのサブスクリプションサービスを利用して、外部システムはSenseLinkのイベントをサブスクライブすることができます。
SenseLinkは現在、デバイスの認証とアラート（以下「イベント」）をPOSTリクエスト（以下Push）することができます。
イベントのPush後、外部システムは5秒以内にレスポンスを返却するか、リターンコード200を返却する必要があります。
レスポンスが5秒以内に返却されない場合またはリターンコードが200以外の場合エラーとみなされ、SenseLinkはもう一度イベントをPushします。 エラーが3回続いた場合、SenseLinkは外部システムのサブスクリプションステータスが異常であるとみなし、サブスクリプションサービスのステータスをExceptionに変更します。以降イベントはPushされません。
● メソッド
POST application/json
● パラメーター：認証レコード
顔認証レコードのdataフィールド
groupsフィールド
● パラメーター：アラート
アラートのdataフィールド
● 認証レコードの例
● アラートの例
ナビゲーションメニューの①「System Management」→②「Open Platform」→③Subscription Service Status欄のConfigureをクリックしてください。
サブスクリプションサービス設定画面が表示されます。
Event Processing Addressの欄に連携する外部システムのサーバーアドレスを入力してください。http、httpsをサポートしています。
Subscription event type欄では、サブスクライブするイベントのタイプを選んでください。
デバイスで認証が行われた際に認証レコードをPUSHで受け取るにはRecognition Recordsを、デバイスアラートが派生した場合にPUSHで受け取るにはDevice Alarmを選択してください。
両者を選択することも可能です。
設定が完了したらSaveボタンをクリックしてください。オープンプラットフォームの画面に戻ります。 Subscription Service StatusがNormalまたはAbnormalと表示されていれば、イベントがサブスクライブされています。
Subscription Service StatusのDetailをクリックすると、サブスクリプションサービスの設定画面が表示されます。
サブスクリプションサービスの設定を変更するにはSubscription Service StatusのDetailをクリックし、サブスクリプションサービスの設定画面にあるModify Subscriptionボタンをクリックしてください。 サブスクリプションサービスを停止するにはStop Subscriptionボタンをクリックしてください。サービスが停止され、外部システムにイベントがPushされなくなります。
Subscription Service StatusのDetailをクリックし、サブスクリプションサービスの設定画面にあるView logボタンをクリックするとログを確認することができます。
ログは最大100件まで保存され、古いものから順に削除されます。各ログのDetailボタンをクリックするとイベントの詳細を確認することができます。 send test eventボタンをクリックすると、テストイベントを連携中の外部システムにPush することができます。
SenseLinkのシステム設定を行うことができます。
ナビゲーションメニューの①「System Management」→②「System Setting」をクリックしてください。 システム設定項目が表示されます。
ストレージの容量確認や、レコードの自動削除の設定を行います。
Storage Settings欄のDisk Space欄でご利用のシステムのストレージ全容量と利用済容量、空き容量を確認できます。
Automatically clean up expired records欄でレコードの削除設定を行います。
認証用顔写真品質チェックレベルを選択します。 Face quality detection levelの欄でModifyをクリックし編集モードにしてください。
● Low（低）： 自分の顔以外他人の顔が映っていないこと、写真データのフォーマットはJPEG、またはPNGであること、写真データのサイズが4,000,000バイト （=約3.8MB、約3,900KB）以下であることの3点をチェックします。
● High（高）： 写真のすべての規格項目をチェックします。すべての規格については 登録する認証用写真の規格 の章を参照してください。デフォルトはHighが設定されています。
Super Adminが新規アカウントを登録した際やパスワードをリセットした際に、アカウントユーザーにメールを発信するEメールサーバーを設定します。
サービス設定画面のEmail Settings欄にあるEmail configuration serverボタンをクリックしてください。
Eメールサーバー設定画面が表示されます。Eメールサーバーのアドレス、ポート、アカウント名、パスワードを入力してください。 メールサーバーへの接続にSSL/TLSを利用する場合は、SSL safe connect欄でStart up を選択してください。デフォルトではNot start upが設定され、SSL/TLSは利用されません。
設定後Saveをクリックしてくだい。サービス設定画面に戻ります。
Email Settings欄の Send test Email をクリックするとテストメールを送信することができます。
システム時間の設定を行います。システム時間の設定はマニュアル設定かNTPサーバーとの連携から選択できます。 システム設定画面のTime setting欄にあるTime calibrationボタンをクリックしてください。
Time calibration（時間設定）画面が表示されます。
Calibration method欄で設定方法を選択してください。
NTP server time calibration（NTPサーバーの設定）を選択した場合、NTP server time calibration欄にNTPサーバーのアドレスを入力してください。
Manual calibration（マニュアル設定）を選択した場合、Current time欄の時間を手動で設定してください。
設定後、Saveをクリックしてください。
Super Adminアカウントはすべてのアカウントのオペレーションログを、その他のロールのアカウントは自身のアカウントのオペレーションログを確認することができます。 ナビゲーションメニューの①「System Management」→②「Operation Log」をクリックしてください。オペレーションログが表示されます。
オペレーションログには以下の項目が記録されています。
オペレーションログはExcelファイルにエクスポートすることができます。オペレーションログ画面上のExportボタンをクリックしてください。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると勤怠レコードが記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
ファイル名は operation_log_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]_.xls です。[YYYY]-[MM]-[DD] [HH]_[MM]-[SS]はオペレーションログの絞り込み検索で設定された開始日時と終了日時が指定されます。
ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログイン中のアカウントです。
ライセンスの有効期限の確認や、ライセンスの更新を行います。
ナビゲーションメニューの①「System Management」→②「License Information」をクリックしてください。ライセンス管理情報が表示され、有効期限を確認できます。
ライセンスの更新を行います。
③「License Update」をクリックすると、編集モードになります。
JCV製品窓口より納品された次年度用のアクティベーションコードをActivation Code欄に貼付してください。License Upload欄のSeleft Fileボタンをクリックし、次年度用のライセンスファイルをアップロードしてください。
ページ最下部にあるUpdateボタンをクリックしてください。アクティベーションコードとライセンスファイルが反映されます。 14章 SenseLinkサーバのシャットダウンと再起動手順の章を参照し、SenseLinkを再起動してください。
ライセンスの有効期限7日前になると、ログイン時画面上部に「[Authorization is about to expire] Your SenseLink Enterprise license will expire in {lessTime} days. To avoid affecting usage, please contact SenseTime or the agent to update the certificate as soon as possible」（SenseLink Enterpriseのライセンスの有効期限があと{lessTime}日で切れます。ライセンスを更新してください）のメッセージが表示されます。お早めにライセンスを更新するようお願い申し上げます。
従業員、ビジター、ブラックリストの登録者の登録や削除、管理について記載されています。
SenseLinkでは顔認証の対象者を以下の登録者タイプに分けて登録・管理できます。
※ SensePass GE V1.2.1、SensePass GE V1.2.3ではビジターおよびブラックリストの顔認証をサポートしていません。
SenseLinkに登録する認証用顔写真は、以下の規格に合うものをご準備ください。なお、Face quality detection level（認証用顔写真品質チェックレベル）の設定がLowの場合は「自分の顔以外他人の顔が映っていないこと」、「写真データのフォーマットはJPEG、またはPNGであること」、「写真データのサイズが4,000,000バイト （=約3.8MB、約3,900KB）以下であること」の3点以外の顔写真品質チェックを行わずに登録が可能です。Face quality detection levelの設定方法については11.5.2項 認証用顔写真品質チェックレベルの設定 とSenseLink ToolKitユーザーマニュアルを参照してください。
3カ月以内に撮影したもの
正面、無帽、無背景
カラー写真
鮮明であること（ピントが合っていること）
個別登録とは、従業員を一人ずつ登録する方法です。
登録に必要な写真および情報をご準備ください。 -
従業員の写真
従業員情報（詳細は「登録項目詳細」をご参照ください）
ナビゲーションメニューの①「Personnel Management」→②「Employee Management」→ ③「Add」→④「Single」の順にクリックすると個別登録画面が表示されます
※1 「Identification portrait」認証用顔写真登録は登録を行わず内容を保存することは可能ですが、登録を行うまで顔認証は行われません（本人が顔認証を行なっても「未登録者」として検知されます）
※2 「Name」氏名は入力必須項目です。
※3 携帯電話番号は一意である必要があります。
※3 従業員で重複する名前が存在する場合、必ず携帯電話番号を入力して管理してください。ToolKitによる複数登録や複数修正などでエラーが発生します。
※4 デバイス設定でゲート（ドア）連動でWiegand（26bit(8+16)、26bit(24)、32bit、34bit）のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号を入力いただく必要があります。各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しない可能性があります。ゲート（ドア）連動でのWiegandの選択に関わらず、10進数で入力ください。
※5 SensePass GE V1.2.1、SensePass GE V1.2.3ではDisplay Portrait（認証時表示用顔写真）をサポートしていません。認証時はIdentification Portrait（認証用顔写真）が表示されます。
必要な情報の入力後、ページ最下部にあるSaveボタンをクリックして登録してください。登録完了まで数秒かかる場合があります。
登録に必要な写真および情報をご準備ください。
ビジターの写真
ビジター情報（詳細は「登録項目詳細」をご参照ください）
ナビゲーションメニューの①「Personnel Management」→②「Visitor Management」→ ③「Add」の順にクリックすると登録画面が表示されます。
※1 「Name」氏名は入力必須項目です。
※1 「Identification portrait」認証用顔写真登録は登録を行わず内容を保存することは可能ですが、登録を行うまで顔認証は行われません（本人が顔認証を行なっても「未登録者」として検知されます）
※2 来訪期間外にビジターが顔認証を行なった場合、アクセス権限なしと見なされ顔認証デバイスに「通行権限なし」のメッセージが表示されます。ドアオープンシグナルは発信されず、ドア/ゲートが開きません。SenseLinkの顔認証レコードにはOut of Visit Period（来訪期間期間外）の異常検知として記録されます。
※3 携帯電話番号は一意である必要があります。
※4 デバイス設定のゲート（ドア）連動でWiegand（26bit(8+16)、26bit(24)、32bit、34bit）のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号を入力いただく必要があります。各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しない可能性があります。ゲート（ドア）連動でのWiegandの選択に関わらず、10進数で入力ください。
必要な情報の入力後、ページ最下部にあるSaveボタンをクリックして登録してください。登録完了まで数秒かかる場合があります。
登録に必要な写真および情報をご準備ください。
ブラックリストの写真
ブラックリスト情報（詳細は「登録項目詳細」をご参照ください）
ナビゲーションメニューの①「Personnel Management」→②Blacklist Management」→ ③「Add」の順にクリックすると登録画面が表示されます。
※1 「Name」氏名は入力必須項目です。
※1 「Identification portrait」認証用顔写真登録は登録を行わず内容を保存することは可能ですが、登録を行うまで顔認証は行われません（本人が顔認証を行なっても「未登録者」として検知されます）
※2 携帯電話番号は一意である必要があります。
※3 デバイス設定のゲート（ドア）連動でWiegand（26bit(8+16)、26bit(24)、32bit、34bit）のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号を入力いただく必要があります。各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しない可能性があります。ゲート（ドア）連動でのWiegandの選択に関わらず、10進数で入力ください。
必要な情報の入力後、ページ最下部にあるSaveボタンをクリックして登録してください。登録完了まで数秒かかる場合があります。
登録者情報を修正することができます。以下では従業員情報の場合を例に操作手順を記載します。ビジター、ブラックリストの場合はそれぞれVisitor Managementメニュー、Blacklist ManageMentメニューに読み替えて同様の手順を実施してください。
SenseLinkのメニュー ①「Personnel Management」→②「Employee Management」→③「Detail」を選択し、登録者情報詳細を表示してください。ページ最下部にあるEditボタンクリックすると編集モードになります。 情報を修正した後ページ最下部にあるSaveボタンをクリックすると修正が保存されます。
登録者情報を削除することができます。以下では従業員情報の場合を例に操作手順を記載します。ビジター、ブラックリストの場合はそれぞれVisitor Managementメニュー、Blacklist Managementメニューに読み替えて同様の手順を実施してください。
SenseLinkのメニュー ①「Personnel Management」→②「Employee Management」の順にクリックすると従業員情報一覧が表示されます。
削除したい登録者にチェックを入れ、④「Delete」をクリックしてください。
「This operation cannot be undone, confirm to delete?」（この操作は取り消しできません。削除しますか？）のメッセージが表示されます。 「Confirm」をクリックして削除してください。削除された登録者は復元でないのでご注意ください。
または、登録者情報詳細ページからも削除が行えます。①「Personnel Management」→②「Employee Management」→③「Detail」を選択し、登録者情報詳細を表示してください。ページ最下部にあるEditボタンクリックすると編集モードになります。
同ページ最下部にあるDeleteをクリックすると「This operation cannot be undone, confirm to delete?」（この操作は取り消しできません。削除しますか？）のメッセージが表示されます。
「Confirm」をクリックして削除してください。
従業員またはビジターとして登録された登録者をブラックリストの登録者に変更することができます。なお、一度ブラックリストとして登録すると従業員またはビジターに変更することができませんのでご注意ください。
ブラックリストに登録したい従業員またはビジターの登録者情報の詳細を表示してください。 ナビゲーションメニューの①「Personnel Management」→②「Employee Management」または[Visitor Management]→から登録者一覧を表示させ、ブラックリストに登録したい登録者の ③「Detail」をクリックすると詳細が表示されます。
ページ最下部にあるEditボタンをクリックして編集モードにしてください。
編集モードにすると、同ページ最下部のボタンに move into the blacklist（ブラックリストに登録する）ボタンが表示されます。
move into the blacklistボタンをクリックしてください。登録するブラックリストグループを選択します。
選択後、Saveボタンをクリックすると「This operation will cause the unbinding of groups and department, confirm this operation?」（現在のグループや部署の登録が解除されます。実行しますか？）のメッセージが表示されます。Confirmボタンをクリックしてください。
操作完了後、①「Personnel Management」→②「Blacklist Management」のブラックリスト一覧に、ブラックリストに登録者タイプを変更した登録者が登録されていることを確認してください。Original Identityには登録者のオリジナルの登録者タイプとしてStaffまたはVisitorが記録されています。
一度に複数の従業員を登録することが可能です。登録方法の詳細はをご参照ください。
一度に複数の従業員情報を修正することが可能です。修正方法の詳細は をご参照ください。
登録者ごとの登録レコードを管理することができます。登録レコードはToolKitを利用して登録した場合のみ記録、管理されます。6.3節 従業員の新規登録：個別登録、6.4節 ビジターの新規登録、6.5節 ブラックリストの新規登録 の手順で登録された場合は記録、管理されないのでご注意ください。
ナビゲーションメニューの①「Personnel Management」→②「Registration Record」をクリックすると登録レコードが表示されます。 検索機能として登録者タイプ選択、登録日付絞り込み、登録者名や携帯電話番号などがあります。
登録者を写真で検索することができます。 ナビゲーションメニューの①「Personnel Management」→②「Search By Pictures」をクリックしてください。写真検索画面が表示されます。
Upload Image欄をクリックして検索に利用したい写真をアップロードしてください。写真の規格は 6.2節登録写真の規格 を参照してください。
Compere Threshold （閾値）※の値を設定してください。0.5~1.0の間で設定できます。
TOP N で類似度の上位何人を検索結果として表示するかを設定してください。
設定が完了したら、Searchボタンをクリックしてください。検索結果が表示されます。 検索結果は類似度が高い順に表示されます。類似度はSimilarityの欄に表示されます。各検索結果のView recognitionボタンをクリックすると、登録者の認証レコードを確認することができます。
登録者情報をExcelファイルにエクスポートすることができます。写真はエクスポートできません。以下では従業員情報の場合を例に操作手順を記載します。ビジター、ブラックリストの場合はそれぞれVisitor Managementメニュー 、Blacklist ManageMentメニューに読み替えて同様の手順を実施してください。
ナビゲーションメニューの①「Personnel Management」→②「Employee Management」をクリックしてください。エクスポートしたい登録者または登録者グループを選択し、 ③「Export」をクリックしてください。
「Excel file be encrypted, password is your current account.」（Excelファイルは保護されます。パスワードは現在ご利用中のアカウントです）というメッセージが表示されます。
Confirmボタンをクリックすると登録者情報が記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。
登録者タイプが従業員、ビジター、ブラックリストのそれぞれの場合以下のExcelファイル名で保存されます。[yyyy]-[mm]-[dd]はこの操作を行なった日付です。
staff_list_[yyyy]-[mm]-[dd].xls
visitor_list_[yyyy]-[mm]-[dd].xls
black_list_[yyyy]-[mm]-[dd].xls
登録レコードをExcelファイルにエクスポートすることができます。写真はエクスポートできません。
ナビゲーションメニューの①「Personnel Management」→②「Registration Record」をクリックしてください。エクスポートしたいレコードを検索で絞り込み、 ③「Export」をクリックしてください。
以下のExcelファイル名で保存されます。[yyyy]-[mm]-[dd]はこの操作を行なった日付です。 registration_record_[yyyy]-[mm]-[dd].xls
概要
部署リストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
department フィールドの説明
エラーレスポンスのフィールド
概要
部署コードから部署情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/search/code
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署 ID から部署情報を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署作成のインターフェースです。
リクエストアドレスの例
https://HOST:PORT/api/v2/department
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署インターフェースを更新します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/update
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
部署を削除します。
リクエストアドレスの例
https://HOST:PORT/api/v2/department/delete
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
Yes
タイムスタンプ
部署長の ID
leader_name
string
部署長の名前
user_num
int
部署内の人数
children
list<department>
下位部署のリスト
部署長の ID
leader_name
string
部署長の名前
user_num
int
部署内の人数
children
list<department>
下位部署のリスト
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
部署長の ID
code
string
部署コード
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
部署長の ID
code
string
部署コード
No
部署長の ID
code
string
No
部署コード。長さ制限は 45。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
部署長の ID
code
string
部署コード
無効なパラメーターです。部署名は空にはできません。
30001
Param Invalid
無効なパラメーターです。部署長が存在しません。
30001
Param Invalid
無効なパラメーターです。部署コードはすでに存在します。
Yes
名前。長さ制限は 50。
leaderId
long
No
部署長の ID
code
string
No
部署コード。長さ制限は 45。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
部署長の ID
code
string
部署コード
無効なパラメーターです。部署 ID は空にはできません。
30001
Param Invalid
無効なパラメーターです。部署名は空にはできません。
30001
Param Invalid
無効なパラメーターです。部署長が存在しません。
30001
Param Invalid
無効なパラメーターです。部署コードはすでに存在します。
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
code
string
Yes
部署コード。長さ制限は 45。
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
id
long
Yes
部署ID
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
コード
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。部署IDが存在しません。
パラメーター名
型
必須
説明
parentId
long
Yes
上位部署 ID
name
string
Yes
名前。長さ制限は 50。空の値で登録しないでください。
leaderId
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
コード
メッセージ
説明
498
Param Invalid
上位の部署を選択ください。
610
Similar record Exist
同じ名前の部署が同じレベルに存在します。
620
Record non-existent Error
上位部署の ID が存在しません。
30001
パラメーター名
型
必須
説明
id
long
Yes
部署ID
parentId
long
Yes
上位部署 ID。上位部署IDが存在しない場合、エラーとなる可能性があります。ご注意ください。
name
パラメーター名
型
説明
id
long
部署ID
name
string
部署名
parent_id
long
上位部署の ID。0 は企業を示します。
leader_id
コード
メッセージ
説明
610
Similar record Exist
同じ名前の部署が同じレベルに存在します。
620
Record non-existent Error
上位部署の ID が無効です(現在のノードの上位部署は指定できません)
30001
Param Invalid
無効なパラメーターです。上位部署の ID は空にはできません。
30001
パラメーター名
型
必須
説明
id
long
Yes
部署ID
app_key
string
Yes
Appキー
sign
コード
メッセージ
説明
610
Similar record Exist
部署にユーザーが存在しているため、部署を削除できません。
610
Similar record Exist
部署に下位部署があります。
620
Record non-existent Error
上位部署の ID が存在しません。
string
long
long
string
long
string
long
long
long
Param Invalid
string
long
Param Invalid
string
{
"code": 200,
"message": "OK",
"data": "id": 0,
"name": " 日本コンピュータビジョン",
"children": [
{
"id": 1,
"name": " 開発部",
"children": [
{
"id": 3,
"name": " クラウドサービス",
"children": [
{ }
],
"parent_id": 1,
"leader_id": 370108,
"leader_name": "test1",
"user_num": 15
},
{
"id": 56,
"name": "test2",
"children": [],
"parent_id": 1,
"leader_id": null,
"leader_name": null,
"user_num": 0
}
],
"parent_id": 0,
"leader_id": 372345,
"leader_name": "leader",
"user_num": 17
}
]
}{
"code": 200,
"message": "OK",
"data": {
"id": 11,
"name": "test",
"code": "003",
"parent_id": 0,
"leader_id": null
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 2,
"name": " 開発部",
"code": “003”,
"parent_id": 0,
"leader_id": 55505
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 2,
"name": " 開発部",
"code": null,
"parent_id": 0,
"leader_id": 55505
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 2,
"name": "開発部",
"code": null,
"parent_id": 0,
"leader_id": 55505
}
}{
"code": 200,
"message": "OK"
}特記事項
サブスクリプションオブジェクト
認証方向
type
int
認証された登録者の登録者タイプ
verifyScore
float
認証スコア
receptionUserId
int
受付担当者のユーザーID
認証された登録者がビジター以外の場合0
receptionUserName
string
受付担当者の氏名
認証された登録者がビジター以外の場合null
groups
list
認証された登録者のグループ
deviceName
string
認証したデバイス名
sn
string
認証したデバイスのLDID
signDate
string
認証日
avatar
string
認証された登録者の登録された認証用顔写真
signAvatar
string
認証時に撮影された顔写真（サムネイル）
signBgAvatar
string
認証時に撮影された顔写真
signTime
timestamp
認証タイムスタンプ
mobile
string
認証された登録者の携帯電話番号
icNumber
string
認証された登録者のICカード番号
idNumber
string
（サポートされない機能です。利用できません。）
jobNumber
string
認証された登録者の従業員番号
remark
string
認証された登録者の特記事項
entryMode
int
認証方法。現在 Face （顔認証）のみサポートされています。
1: 顔認証
2: QRコード認証
3: ICカード認証
4: 顔認証 + ICカード認証
5: ID カード認証
6: 顔認証 + IDカード認証
signTimeZone
string
タイムゾーン
docPhoto
string
（サポートされない機能です。利用できません。）
location
string
認証したデバイスの設置位置
abnormalType
int
異常検知タイプ。一部タイプはサポートされません。
0: 指定なし（異常なし）
10001: 顔とIDの不一致
10002:顔とカードの不一致
10003:顔とQRコードの不一致
20001:ビジターの認証時間外の訪問
20002: 時間外の認証
30001:不正なIDカード
30002:不正なICカード
30003:不正なQRコード
40001: 異常な体温
bodyTemperature
float
体温
mask
int
マスク着用状況
0: 検知モードOFF
1: 未着用
2: 着用
サブスクリプションオブジェクト
アラートの説明
status
int
1 稼働中，2 解除中，3 解除済
traceId
string
アラートID。アラートにはIDが振られます。
deviceId
long
デバイスID
deviceName
string
デバイス名
deviceSn
string
LDID
deviceLocation
string
デバイス位置
alarmTime
string
アラート発生時間
disarmTime
string
アラート解除時間
alarmPhoto
string
アラート時キャプチャ写真
resolveOption
int
アラート解除オプション
0 解除必要なし
1 デバイス側のみで解除
2 リモートのみで解除
3 デバイス側、SenseLink側のどちらからでも解除
0 パスワードクラッキングとNon-Livingアタックはアラートの解除は不要です。
1 デバイス側からのみ解除可能
10003 ドアマグネットのタイムアウト
20001 カメラ汚れ
10006 サーモカメラの接続不良の解除を行います
3 デバイス側、SenseLink側のどちらからでも解除可能です。
イベント。発生したイベントが記録されます。
IP
操作したIPアドレス
Operation Result
操作結果
Operation Time
操作日時
Operation Remark
（サポートされない機能です。利用できません。）
Detail
ToolKitによる複数登録または修正を行なった場合に、登録結果がエクスポートされます。詳細はSenseLink ToolKit ユーザーマニュアル を参照してください。
概要
Company Logo
企業ロゴ。HDMIエクスポート機能を持つSensePass ProまたはSenseThunder Eを外部ディスプレイに接続した際に表示されます。推奨サイズは100*620 px以下です。
Background Logo
バックグラウンドロゴ。SensePass ProまたはSenseThunder Eの認証時の背景に利用されます。SensePass ProまたはSenseThunder Eを外部ディスプレイに接続した際にも表示されます。推奨サイズは1080*720 px.以下です
Company Name
企業名。従業員情報の部署名の最上位層の名前として表示されます。
Welcome Phrase
HDMIエクスポート機能を持つSensePass ProまたはSenseThunder Eを外部ディスプレイに接続した際に表示されます。デバイスが表示オプションをONにした場合のみ表示されます。
Introduction
企業プロフィール
ロール
概要
Super Admin
• 最高権限を持つロール。
• SenseLinkのインストール時に1アカウントのみ発行されるロールであり、追加はできません。
• すべてのメニューの更新権限を持ちます。
• 他のアカウントの登録や更新権限を持ちます。
Sub Admin
• 複数アカウント発行可能
• 他のアカウントの登録や、Super Admin以外のアカウントの更新権限を持ちます。
• Open Platformの参照権限を持ちません。
• オペレーションログの自身のアカウントのログのみ参照権限を持ちます。
• 上記以外はSuper Adminと同等の権限を持ちます。
General Admin
• 複数アカウント発行可能
• 各メニューの参照権限のみ持ち、更新権限を持ちません。
• システム設定、ライセンス管理は参照権限も持ちません。
• 自身のアカウントのみパスワード変更ができます。 • オペレーションログの自身のアカウントのログのみ参照権限を持ちます。
Device Admin
• 複数アカウント発行可能
• デバイス管理メニュー、デバイスアラートのみ更新権限を持ちます。 • ダッシュボードと企業情報のみ参照権限を持ちます。 • 自身のアカウントのみパスワード変更ができます。 • オペレーションログの自身のアカウントのログのみ参照権限を持ちます。
Visitor Admin
• 複数アカウント発行可能
• ビジター管理とブラックリスト管理のみ更新権限を持ちます。 • ダッシュボード、ビジターとブラックリストの認証レコード、企業情報のみ参照権限を持ちます。 • 顔認証デバイスのログインには利用できません。
• 自身のアカウントのみパスワード変更ができます。
項目
概要
Name
アカウント名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~30文字（半角換算）で登録可能です。
Role
ロール
Account
アカウント
SenseLinkやデバイスのログイン時に利用します。
半角英数字、アンダースコアのみ利用可能です。6~30文字で登録可能です。
アカウントは一度登録すると変更できません。
Password Generation Mode
新規アカウント登録時のパスワードの生成方法
Random Password by mail （ランダムパスワードをメールで送信）またはdefault password（デフォルトパスワード、Admin1234@）を選択できます。
Eメールアドレス
パスワード生成方法でRandom Password by mailが選択されている場合、登録されたEメールアドレスにランダムパスワードが送信されます。 11.5.3 Eメールサーバーの設定 の節にあるEメールサーバーの設定が完了している場合のみ選択できます。設定が完了していない状態でRandom Password by mailを選択しても、Eメールは送信されません。
パスワード生成方法でdefault passwordを選択している場合も登録することが可能です。
半角英数字、-._@（半角）の6~45文字で、
[email protected] または [email protected]の形式のみ登録可能です。
Eメールアドレスは一度登録すると変更できません。
パタメーター
型
概要
eventType
string
30000: 顔認証レコード
30100: デバイスアラート
messageId
string
イベントのID
sendTime
string
イベント発生時刻
data
パタメーター
型
概要
id
int
レコードID
userId
int
認証された登録者のユーザーID
name
string
認証された登録者の氏名
direction
パタメーター
型
概要
id
int
グループID
name
int
登録グループ名
type
string
登録グループ名
パタメーター
型
概要
eventType
string
30000: 顔認証レコード
30100: デバイスアラート
messageId
string
イベントのID
sendTime
string
イベント発生時刻
data
パタメーター
型
概要
id
long
アラートレコードID
level
int
アラートレベル
1: アラート
2: Exception
code
int
アラートタイプ
アラートタイプ
アラートの種類。
10001: デバイス盗難アラート
10002: 強制ドアオープン
10003: ドアオープンタイムアラート
10004: パスワードクラッキング
10006: サーモカメラの接続不良
20001: カメラの汚れ
20002: Non-livingアタック
20003: 消防アラート
description
項目
概要
Name
アカウント名
Account
アカウント
Role
ロール
Operation Modular
操作したメニュー。Device、Employee、Visitor、Blacklist、Login、Access、Attendance、Account Permissionのいずれかが記録されます。
Operation Item
操作した項目。DeviceまたはWebpageが記録されます。
Remark
string
int
string
string
Operation Event
明るさやコントラストが適切であること
影のないもの
背景と人物の境目がはっきりしていること
眼鏡のレンズに光が反射していないこと
平常の顔貌と著しく異ならないもの
前髪やヒゲなどにより、目などの顔のパーツや輪郭が隠れていないこと
ヘアバンドなどで頭髪を覆っていないこと
口を開けていないこと
顔部分のサイズは100×100ピクセル以上であること
写真のサイズは100×128ピクセル以上であること
顔部分のピッチ/ヨー/ロールが±20°であること
顔部分の上下左右幅を変更していないこと
写っている人物が一人のみで、他人の顔が写っていないこと
写真データのフォーマットはJPEG、またはPNGであること 写真データのサイズが4,000,000バイト （=約3.8MB、約3,900KB）以下であること
Display portrait
※5
認証時表示用顔写真登録
JPEGまたはPNG形式、4000KB以下。
設定しない場合、Identification Portraitが認証時表示用顔写真として表示されます。SensePass V1.2.1、V1.2.3で当機能はサポートされません。
-
Name※2
氏名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
30
Gender
性別
（選択肢）
-
Employee group
従業員グループ
（選択肢）
-
Telephone
※3
携帯電話番号
半角数字
+ -（半角）
入力フォーマット制限
• 先頭に+（プラス）記号、国別/エリアコード（日本の場合81）、-（マイナス）記号を記載の上、番号の入力を行なってください。
• 日本の携帯電話番号が090-1234-5678の場合、 +81-9012345678 が有効な入力値です。
• +XXX-YYYYYY形式の場合
• Xは1～10桁までの半角数字
• Yは6～17桁までの半角数字
• +、-はそれぞれ1個まで
• X、Y、+、- 合計最大20桁まで
• YYYYYYの重複がチェックされます。 例：+81-123456 と+12-123456 は同一携帯電話番号として判断し、同時に登録できません
6
20
Ext
外線電話番号
半角数字
-
20
Department
所属部署
（選択肢）
-
Position
役職
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
Employee ID
従業員
半角数字
-
20
IC card※4
ICカード番号
半角英数字
Hexiadecima（16進数）またはDecimal（10進数）表記に従って入力
-
20
ID card
IDカード番号
（中国国籍の方が持つ番号です。サポートされない機能のため、入力しないでくだし。）
-
Working place
勤務地
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
Birthday
生年月日
（日付選択）
-
Age
年齢
（Birthdayから自動計算）
-
Entry time
入社日
（日付選択）
-
Custom prompt
顔認証時に表示するカスタムメッセージ
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
Remark
特記事項
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
200
Display portrait※5
認証時表示用顔写真登録
JPEGまたはPNG形式、4000KB以下
設定しない場合、Identification Portraitが認証時表示用顔写真として表示されます。
-
Name※1
氏名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
30
Access Period
※2
来訪期間、アクセス可能期間
（日付選択）
-
Gender
性別
（選択肢）
-
Visitor group
ビジターグループ
（選択肢）
-
Telephone
※3
携帯電話番号
半角数字
+ -（半角）
入力フォーマット制限
• 先頭に+（プラス）記号、国別/エリアコード（日本の場合81）、-（マイナス）記号を記載の上、番号の入力を行なってください。
• 日本の携帯電話番号が090-1234-5678の場合、 +81-9012345678 が有効な入力値です。
• +XXX-YYYYYY形式の場合
• Xは1～10桁までの半角数字
• Yは6～17桁までの半角数字
• +、-はそれぞれ1個まで
• X、Y、+、- 合計最大20桁まで
• YYYYYYの重複がチェックされます。 例：+81-123456 と+12-123456 は同一携帯電話番号として判断し、同時に登録できません
6
20
Company
企業名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
Position
役職
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
40
Visit Purpose
来訪目的
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
50
Reception Staff
受付担当者
（検索および選択肢）
-
Guest Rating
ゲストカテゴリー
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
20
IC card※4
ICカード番号
半角英数字
Hexiadecima（16進数）またはDecimal（10進数）表記に従って入力
-
20
ID card
IDカード番号
（中国国籍の方が持つ番号です。サポートされない機能です。利用できません。）
-
Birthday
生年月日
（日付選択）
-
Age
年齢
（Birthdayから自動計算）
-
Custom prompt
顔認証時に表示するカスタムメッセージ
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
Remark
特記事項
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
200
Display portrait
認証時表示用顔写真登録
JPEGまたはPNG形式、4000KB以下
設定しない場合、Identification Portraitが認証時表示用顔写真として表示されます。
-
Name※1
氏名
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
1
30
Gender
性別
（選択肢）
-
Blacklist group
ブラックリストグループ
（選択肢）
-
Telephone
※2
携帯電話番号
半角数字
+ -（半角）
入力フォーマット制限
• 先頭に+（プラス）記号、国別/エリアコード（日本の場合81）、-（マイナス）記号を記載の上、番号の入力を行なってください。
• 日本の携帯電話番号が090-1234-5678の場合、 +81-9012345678 が有効な入力値です。
• +XXX-YYYYYY形式の場合
• Xは1～10桁までの半角数字
• Yは6～17桁までの半角数字
• +、-はそれぞれ1個まで
• X、Y、+、- 合計最大20桁まで
• YYYYYYの重複がチェックされます。 例：+81-123456 と+12-123456 は同一携帯電話番号として判断し、同時に登録できません
6
20
IC card※3
ICカード番号
半角英数字
Hexiadecima（16進数）またはDecimal（10進数）表記に従って入力
-
20
ID card
IDカード番号
（中国国籍の方が持つ番号です。サポートされない機能です。利用できません。）
-
Birthday
生年月日
（日付選択）
-
Age
年齢
（Birthdayから自動計算）
-
Custom prompt
顔認証時に表示するカスタムメッセージ
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
45
Remark
特記事項
半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号
-
200
登録者タイプ
概要、他の登録者タイプとの違い
Employee
従業員
自社の従業員を登録・管理するためのタイプ。
従業員番号、入社日、所属部署など従業員独自の管理項目ToolKitによる複数登録
勤怠管理機能との連携
Visitor ※
ビジター
来訪者を登録・管理するためのタイプ。
期間限定のアクセス権限管理
企業名、来訪目的、受付担当者、ビジターカテゴリー（VIP/一般など）など、ビジター独自の管理項目
Blacklist ※
ブラックリスト
不審者などブラックリスト上の人物を登録・管理するためのタイプ
ブラックリスト認証時にドアオープンOn/Offの設定
ブラックリスト認証時にデバイス上に独自メッセージ表示
項目
詳細
入力可能文字種、フォーマット、注意事項など
入力文字数制限
（半角換算）
最小
最大
Identification portrait※1
認証用顔写真登録
写真の注意事項は6.2節をご参照ください
-
項目
詳細
入力可能文字種、フォーマット、注意事項など
最小
Identification portrait※1
認証用顔写真登録
写真の注意事項は6.2節をご参照ください
-
項目
詳細
入力可能文字種、フォーマット、注意事項など
入力文字数制限
（半角換算）
最小
最大
Identification portrait※1
認証用顔写真登録
写真の注意事項は6.2節をご参照ください
-
{
messageId: '75835750-6dd9-4eed-a929-ba1b4c062405',
eventType: 30000,
sendTime: 1583726626015,
data: {
id: 120260,
userId: 30707,
name: 'Somu Taro',
type: 1,
avatar: '5e65c020f54fd90001fe4a33',
direction: 0,
verifyScore: 0,
receptionUserId: 0,
receptionUserName: '',
groups: [ { id: 1, name: 'Default group', type: 1 } ],
deviceName: 'SenseTest',
sn: 'SPS-e33b1811dbd9189c5eeedffd557fd779',
signDate: '2020-04-30',
signTime: 1583726625,
signAvatar: '5e65c021f54fd90001fe4a37',
signBgAvatar: '5e65c021f54fd90001fe4a38',
companyId: 1,
mobile: '818012345678',
icNumber: '',
idNumber: '',
jobNumber: '3867452109',
remark: 'welcome',
entryMode: 1,
signTimeZone: '+08:00',
docPhoto: '',
latitude: 0,
longitude: 0,
address: '',
location: 'SZ-40F',
abnormalType: 40001,
userIcNumber: '4751283096',
userIdNumber: '1g2qW2hz5OwbudHe5gekKbZtmUt0Xwfy',
bodyTemperature: 38,
mask: 1
}
}{
messageId: '5ee92a0e-7c6b-416c-8843-54a154a3a409',
eventType: 30100,
sendTime: 1583726801752,
data:
{
id: 35569,
traceId: '1583726800000',
code: 10001,
alarmTime: '2020-04-30 12:06:40',
level: 1,
deviceId: 204,
deviceSn: 'SPS-e33b1811dbd9189c5eeedffd557fd779',
deviceLocation: 'SZ-40F',
deviceName: 'SenseTest',
resloveOption: 3,
alarmPhoto: '5e65c0d1f54fd90001fe4a39',
companyId: 1,
description: 'Device removal',
releaseTime: ''
}
}10002 強制ドアオープン
20003 消防アラート
SenseLinkのサブスクリプションサービスを利用して、外部システムはSenseLinkのイベントをサブスクライブすることができます。SenseLinkはデバイスの認証とアラート（以下「イベント」）をPOSTリクエスト（以下「Push」）することができます。
イベントをサブスクライブする外部システムのサーバーアドレスは、SenseLinkのWeb UIのナビゲーションメニュー[System Management]>[Open Platform] 内の Subscription Services Status欄か、本マニュアル内のAPIで設定および更新することができます。
イベントがされてから 5 秒以内にサードパーティーからの応答が受信されなかった場合、または 200 以外のリターンコードが返ってきた場合、Pushに失敗したと見なされ、SenseLink はPushを再試行します。
Pushに失敗すると、サードパーティーサービスは異常と見なされ、イベントサブスクリプションサービスのステータスは「異常」に設定され、その後のPushはすべて停止します。
最近のイベントのPush結果はSenseLinkのWeb UIのナビゲーションメニュー[System Management]>[Open Platform] 内の Subscription Services Status欄にあるDetailで表示できます。
POST application/json
認証レコード :
デバイスアラート :
認証レコードデータの属性 :
group フィールドの説明
デバイスのアラートレコードのデータ属性 :
レスポンスのフィールド
概要
イベントのサブスクリプションを追加または更新します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/updateSub
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
イベントのサブスクリプションを停止します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/stopSub
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
サブスクリプションの詳細を表示します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/viewSub
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
イベントのPushログを表示します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/viewLog
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
テストイベントをPush送信します。
リクエストアドレスの例
https://HOST:PORT/api/v3/event/sendTest
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
Yes
イベント発生時刻 (デバイス時間)
data
object
Yes
イベントの対象
認証されたユーザーの名前
direction
int
デバイスのアクセス方向
type
int
ユーザーの識別子タイプ
verifyScore
float
認証スコア
receptionUserId
int
認証されたユーザーの応対者の ID
receptionUserName
string
認証されたユーザーの応対者の名前
groups
list<group>
認証されたユーザーのグループ情報
deviceName
string
デバイス名
sn
string
この認証レコードのデバイス LDID 番号をアップロードします
signDate
string
認証レコードの日付
avatar
string
認証用顔写真
signAvatar
string
認証時写真（サムネイル）
signBgAvatar
string
認証時写真（大）
signTime
timestamp
認証時間 (秒)
mobile
string
認証されたユーザーの携帯電話番号
icNumber
string
認証されたユーザーのIC カード番号
idNumber
string
認証されたユーザーの ID 番号（利用できません）
jobNumber
string
認証されたユーザーの従業員ID
remark
string
備考
entryMode
int
認証モード (1 : 顔認証、2 : QR コード、3 : カード、4 : 顔認証とカード、5 : ID カード、6 : 顔認証と ID カード)
signTimeZone
string
認証レコードのタイムゾーン
docPhoto
string
ID 写真
location
string
デバイスの設置場所
abnormalType
int
認証レコードの異常のタイプ。 0 ：なし
10001：IDカード不一致
10002：認証カード不一致
10003：認証コード不一致
20001：ビジターが有効期限外
20002：アクセス期限内ではない
30001：無効な ID カード
30002：無効な IC カード
30003：無効な QR コード
40001：異常な体温
50001：マスク着用なし
bodyTemperature
float
体温
mask
int
マスク着用識別子。0 - 不明、1 - 着用なし、2 - 着用あり
アラートの説明
status
int
アラートのステータス。1 : アラート作動中、2 : 解除中、3 : 解除済み
traceId
string
アラートのシリアル番号。デバイスによって生成されるアラート固有の識別番号です。
deviceId
long
デバイスの ID
deviceName
string
デバイス名
deviceSn
string
デバイスの LDID
deviceLocation
string
デバイスの設置場所
alarmTime
string
アラート時間
releaseTime
string
アラートの解除時間
alarmPhoto
string
アラート写真
resloveOption
int
アラートの解除オプション。 0：解除不要
1：デバイスエンドでの解除のみをサポート
2：リモート解除のみをサポート
3：デバイスエンドまたはリモートでの解除
0：解除不要
10004：パスワードクラッキング
20002：Non-Living アタック（非生体による認証）
30001：デバイスオフラインアラート
1：デバイスエンドでの解除のみをサポート
10003：ドアセンサータイムアウト
20001：カメラの汚れ
10005：（サポートされないアラートです。現在利用できません）
No
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
リターンデータです。イベントサブスクリプションの詳細です。
Pushメッセージ本体
Yes
タイムスタンプ
リターンデータ
パラメーター名
型
必須
説明
eventType
string
Yes
30000 - 認証レコード、30100 - デバイスアラート
messageId
string
Yes
イベントの固有の識別子
sendTime
パラメーター名
型
説明
id
int
レコード ID
companyId
long
企業ID
userId
int
認証されたユーザーの ID
name
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプです。1 : 従業員グループ、2 : ビジターグループ、5 : ブラックリストグループ
パラメーター名
型
説明
id
long
アラートレコードのID
level
int
アラートレベル。1 : アラート、2 : 異常
code
int
アラートのタイプ。 10001：デバイスの盗難アラート
10002：ドア・ゲート強制突破アラート
10003：アセンサータイムアウト
10004：パスワードクラッキング
10005：（サポートされないアラートです。現在利用できません）
10006：サーモグラフィカメラ接続異常
20001：カメラの汚れ
20002：Non-Living アタック（非生体による認証）
20003：消防アラート
30001：デバイスオフラインアラート
40001：特徴量抽出エラー
description
パラメーター名
型
必須
説明
code
int
Yes
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
Yes
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
data
パラメーター名
型
必須
説明
event_type_ids
list<int>
Yes
イベントタイプ ID の配列 (30000 : 認証レコード、30100 : アラートPush)
event_dest
string
Yes
イベントをサブスクライブする外部システムのサーバーアドレスを指定します。restful コールバックを利用し、http および https をサポートしています。スタイルは、http://ip:port/eventRcv または https://ip:port/eventRcv で、 最大 1024 文字です。外部システムのサーバーアドレスは指定された仕様に基づいて申請したパーティーから提供されます。外部システムのインターフェースの認証は必要ありません。
空の値で登録しないでください。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
desc
string
リターンの説明
data
code
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
desc
string
リターンの説明
data
code
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
desc
string
リターンの説明
data
パラメーター名
型
説明
event_type_ids
list<int>
イベントタイプ ID の配列 (30000 : 認証レコード、30100 : アラートPush)
event_dest
string
イベントをサブスクライブする外部システムのサーバーアドレス
sub_status
int
サブスクリプションサービスのステータスです。0 : 構成されていません、1 : 正常、2 : 異常 (最後のPushステータスに基づく)
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
desc
string
リターンの説明
data
パラメーター名
型
説明
push_time
string
Push時間
status
int
リターンステータスです。200 : 成功、404 : サーバー応答不可、500 : 内部例外
event_type_id
int
イベントタイプの ID です。30000 : 認証レコード、30100 : アラートPush
event_message
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード。200 は成功を示し、その他のコードは失敗を示します
message
string
リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します。
desc
string
リターンの説明
data
コード
メッセージ
説明
60001
openapi status error
OpenAPI 機能のステータスが利用可能であることをご確認ください (「利用中」または「変更のレビュー待ち」)
60002
not config event sub
サブスクリプションサービスが構成されていません。
string
string
string
object
string
object
string
object
string
object
string
object
string
string
object
POST: form-dataリクエストパラメーター
パラメーター名
型
必須
説明
name
string
Yes
グループ名。長さ制限は 45。
type
int
Yes
グループタイプ(1 : 従業員グループ、2 : ビジターグループ、5 : ブラックリストグループ)
app_key
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
dataフィールドの説明
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
company_id
エラーレスポンスのフィールド
code
メッセージ
エラーの説明
30001
Param Invalid
無効なパラメーターです。登録者グループ名の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者グループタイプは空にはできません。
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です。
30001
概要
登録者グループのリストを表示します。デフォルトの順序はID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
page
int
No
ページ番号 (デフォルトは 1 です)
size
int
No
1 ページあたりのデータ数 (デフォルトは 20 です)
type
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
dataフィールドの説明
パラメーター名
型
説明
total
string
総計
pageNum
string
ページ数
size
string
サイズ
pageSize
data.dataフィールドの説明
パラメーター名
型
説明
id
int
登録者グループの ID
name
string
登録者グループ名
company_id
int
企業 ID
create_at
エラーレスポンスのフィールド
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です。
30001
Param Invalid
無効なパラメーターです。デバイスが存在しません。
50001
RPC FAILED
RPCに失敗しました。デバイスグループリストの取得に失敗しました。
概要
グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group/user
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
グループID
app_key
string
Yes
Appキー
sign
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
list<long>
登録者ID
エラーレスポンスのフィールド
code
メッセージ
エラーの説明
620
Record non-existent Error
グループID が存在しません
30001
Param Invalid
無効なパラメーターです
概要
登録者グループを更新します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/group/update
リクエスト方法
POST application/json
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
グループID
name
string
No
グループ名
device_ids
認証パラメーター
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
dataフィールドの説明
パラメーター名
型
説明
id
int
グループ ID
name
string
グループ名
type
int
グループタイプ
devices
device フィールドの説明
パラメーター名
型
説明
id
int
デバイスの ID
name
string
デバイス名
type
int
デバイスタイプ
エラーレスポンスのフィールド
code
メッセージ
説明
498
Param Invalid
無効なグループ ID など
600
Sync Failed
リモートリクエストエラー
概要
グループを削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/group/delete/{id}
リクエスト方法
GET
リクエストパラメーター
パラメーター名
型
必須
説明
id
long
Yes
登録者グループの ID
app_key
string
Yes
Appキー
sign
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します。
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
20002
Permission Denied
操作権限がないため、デフォルトのグループを削除できません。
30001
Param Invalid
無効なパラメーターです。グループID が存在しません。
30001
Param Invalid
無効なパラメーターです。変更グループは企業に属しておりません。
50001
概要
登録者を一括でグループに追加します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/add/group
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
groupId
long
Yes
登録者グループの ID
userIds
list<long>
Yes
一括で追加する登録者ID。一回の操作で最大2000 人を追加できます。
app_key
通常のレスポンス
レスポンスフィールドの説明
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2000 を超える数を一度にグループに追加することはできません。
30001
param-invalid
無効なパラメーターです。groupId が空です。
30001
概要
グループから一括で登録者を削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/remove/group
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名
型
必須
説明
groupId
long
Yes
従業員のグループID
userIds
list<long>
Yes
一括で削除する登録者のID。最大2000 まで一括で操作できます。
app_key
通常のレスポンス
レスポンスのフィールド
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します。
message
string
リターンメッセージ
エラーレスポンスのフィールド
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2000 を超える数を一度にグループから削除することはできません。
30001
param-invalid
無効なパラメーターです。groupId が空です。
30001
{
"data": {
"companyId": 1,
"deviceName": "device2",
"deviceSN": "SPS-23da60ccda8f91a865a7472c1c5d9df5",
"direction": 1,
"groupId": 0,
"groupName": "",
"id": 2,
"originAvatar": "",
"receptionUserId": 0,
"receptionUserName": "",
"signAvatar": "5c80cb55bac9be0001d4e93a",
"signBgAvatar": "5c80cb55bac9be0001d4e93b",
"signTime": 1551944533,
"userId": 0,
"userName": "",
"userType": 3,
"verifyScore": 0.0
},
"messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
"eventType": 30100,
"sendTime": 1569575298240
}
{
"data": {
"id": 100,
"level": 0,
"code": 0,
"description": "",
"status": 0,
"traceId": "",
"deviceId": 0,
"deviceName": "",
"deviceSn": "",
"deviceLocation": "",
"alarmTime": "",
"releaseTime": "",
"alarmPhoto": "",
"resloveOption": 0
},
"messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
"eventType": 30100,
"sendTime": 1569575298240
}{
"code": 200,
"message": "success",
"desc": "",
"data": {}
}{
"code": 200,
"message": "success",
"desc": "",
"data": {}
}{
"code": 200,
"message": "success",
"desc": "",
"data": {}
}{
"code": 200,
"message": "success",
"desc": "",
"data": {
"event_type_ids": [
30000,
30100
],
"event_dest": "https://ip:port/eventRcv",
"sub_status": 1
}
}{
"code": 200,
"message": "success",
"desc": "",
"data": {
"pushTime": "2019-10-11 00:00:00",
"status": 200,
"eventTypeId": 30000,
"eventMessage": {}
}
}{
"code": 200,
"message": "success",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"data": {
"id": 616,
"name": "太朗",
"type": 1,
"company_id": 58,
"create_at": "2018-08-07 18:37:32",
"update_at": "2018-08-07 18:37:32"
}
}{
"code": 200,
"message": "OK",
"data": {
"total": 5,
"pageNum": 1,
"size": 5,
"pageSize": 20,
"totalPage": 1,
"data": [
{
"id": 214,
"name": "Default group",
"type": 1,
"user_number": 1327,
"company_id": 58,
"create_at": "2018-05-28 17:31:32.0",
"update_at": "2018-05-28 17:31:32.0"
},
{
"id": 215,
"name": " Default group",
"type": 2,
"user_number": 0,
"company_id": 58,
"create_at": "2018-05-28 17:31:32.0",
"update_at": "2018-05-28 17:31:32.0"
},
{
"id": 226,
"name": "123",
"type": 1,
"user_number": 1543,
"company_id": 58,
"create_at": "2018-05-30 14:50:17.0",
"update_at": "2018-05-30 14:50:17.0"
},
{
"id": 231,
"name": "ccc",
"type": 1,
"user_number": 4,
"company_id": 58,
"create_at": "2018-06-04 21:52:45.0",
"update_at": "2018-06-04 21:52:53.0"
},
{
"id": 517,
"name": "Test",
"type": 1,
"user_number": 2,
"company_id": 58,
"create_at": "2018-07-02 21:14:41.0",
"update_at": "2018-07-02 21:14:41.0"
}
]
}
}{
"code": 200,
"message": "OK",
"data": [
1014,
1241,
2896,
5124,
5125,
5126,
5127
]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 253,
"name": "zml2",
"type": 1,
"devices": [{
"id": 268,
"name": "q",
"type": 0
}],
"is_default": 0
}
}
{
"code": 200,
"message": "OK"
}
{
"code": 200,
"message": "OK"
}{
"code": 200,
"message": "OK"
}
10006：サーモグラフィカメラ接続異常
3：デバイスエンドまたはリモートでの解除 10001：デバイスの盗難アラート
10002：ドア・ゲート強制突破アラート
20003：消防アラート
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
long
企業ID
create_at
string
作成時間
update_at
string
前回の変更時間
Param Invalid
無効なパラメーターです。登録者グループ名はすでに存在します。
50001
RPC FAILED
RPCに失敗しました。グループ作成に失敗しました。
50002
Internal Server Error
内部システムエラーです。グループ作成に失敗しました。
int
No
登録者グループタイプ。1 : 従業員、2 : ビジター、5 : ブラックリスト
deviceId
long
No
デバイスの ID
groupIds
list<long>
No
グループID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
string
ページサイズ
totalPage
string
ページ合計
data
object
データ
string
作成時間
update_at
string
更新時間
type
int
登録者グループタイプ
user_number
int
グループ内の人数を示します
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
list<long>
No
デバイスID リスト
string
Yes
タイムスタンプ
object
データ
list<device>
デバイス
is_default
int
デフォルトのグループかどうか
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
RPC FAILED
RPCに失敗しました。グループの削除に失敗しました。
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
param-invalid
無効なパラメーターです。登録者の userId array が空です。
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません。
50001
RPC FAILED
RPCに失敗しました。一括登録者追加に失敗しました。
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
param-invalid
無効なパラメーターです。登録者の userId array が空です。
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません。
50001
RPC FAILED
RPCに失敗しました。グループからの登録者の一括削除に失敗しました。
概要
タイムテーブルを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
POST application/json
リクエストパラメーター
Time フィールドの説明
Special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
タイムテーブルを更新します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/update
リクエスト方法
POST application/json
リクエストパラメーター
time フィールドの説明
special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルの詳細を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを削除します。一括削除が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
構成されているアクセスルールのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
すべてのデバイスおよびグループの連携関係 (アクセスルール情報を含む) を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/devices/passrules
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
timetableGroup フィールドの説明
エラーレスポンスのフィールド
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
Yes
タイムスタンプ
データ
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
タイムスタンプ
データ
Yes
月曜日のアクセスルール
tuesday_period
list<time>
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
Yes
タイムスタンプ
データ
24 時間のアクセスルール
wednesday
string
24 時間のアクセスルール
thursday
string
24 時間のアクセスルール
friday
string
24 時間のアクセスルール
saturday
string
24 時間のアクセスルール
sunday
string
24 時間のアクセスルール
holiday
string
24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
グループID
timetable_id
long
Yes
タイムテーブルの ID
Yes
タイムスタンプ
データ
グループID
group_name
string
グループ名
group_type
int
グループタイプ
timetable_id
long
タイムテーブルの ID
timetable_name
string
タイムテーブル名
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
アクセスグループ ID
group_name
string
アクセスグループ名
timetable_id
int
タイムテーブルの ID
timetable_name
string
タイムテーブル名
group_type
int
グループタイプ
Yes
タイムスタンプ
データ
タイムテーブルの ID
timetable_name
string
タイムテーブル名
パラメーター名
型
必須
説明
name
string
Yes
タイムテーブルの名前
monday_period
list<time>
Yes
月曜日のアクセスルール
tuesday_period
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
00:00:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
備考
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:00:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します。
remark
string
備考
timetable_id
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
610
Similar record Exist
タイムテーブルはアクセスルールに連携されているため、削除できません。
620
Record non-existent Error
タイムテーブルが存在しません。
パラメーター名
型
必須
説明
id
int
Yes
タイムテーブルの ID
name
string
Yes
タイムテーブルの名前
monday_period
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
0:30:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
備考
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
24 時間を 48 の期間に分割します。string は 0 と 1 で構成され、1 は該当する期間にアクセスが可能であることを示し、0 はアクセスが可能ではないことを示します。例 : 100000000000000000000000000000000000000000000001 は、00: 00-00: 30 を示し、23: 30-24: 00 はアクセス可能であることを示します。
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
0:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します。
remark
string
備考
timetable_id
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブル名
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
integer
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
0:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します。
remark
string
備考
timetable_id
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
list<passRule>
Yes
アクセスルールのパラメーター
device_id
long
Yes
デバイスの ID
group_id
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
long
アクセスルールの ID
device_id
long
デバイスの ID
device_name
string
デバイス名
group_id
コード
メッセージ
説明
600
Sync Failed
RPCに失敗しました
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
ids
list<long>
Yes
アクセスルール ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
620
Record non-existent Error
レコードが存在しません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
アクセスルール ID
device_id
int
デバイスの ID
device_name
string
デバイス名
group_id
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
device_ids
list<long>
Yes
デバイスの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
device_id
int
デバイスの ID
device_name
string
デバイス名
timetable_groups
list<timetableGroup>
連携されているタイムテーブルとアクセスグループ
パラメーター名
型
説明
group_id
int
アクセスグループ ID
group_name
string
アクセスグループ名
group_type
int
グループタイプ
timetable_id
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
60001
Device Not Exist
デバイスが存在しません
list<time>
string
object
string
int
string
object
list<time>
string
object
string
int
string
object
string
object
string
int
long
string
object
long
string
object
string
object
int
string
object
int
{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 16,
"name": "test",
"monday": "100000000000000000000000111111111111111111111111",
"tuesday": "100000000000000000000000111111111111111111111111",
"wednesday": "100000000000000000000000111111111111111111111111",
"thursday": "100000000000000000000000111111111111111111111111",
"friday": "100000000000000000000000111111111111111111111111",
"saturday": "100000000000000000000000111111111111111111111111",
"sunday": "100000000000000000000000111111111111111111111111",
"holiday": "100000000000000000000000111111111111111111111111",
"special_days": [],
"monday_period": [{
"start_time": "0:00:00",
"end_time": "00:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"tuesday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"wednesday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"thursday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"friday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"saturday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"sunday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"holiday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"start_timestamp": 1576046318000,
"end_timestamp": 1576046318000
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"data": {
"id": 28,
"name": "test,
"monday": "010000000000000000000000000000000000000000000000",
"tuesday": "010000000000000000000000000000000000000000000000",
"wednesday": "010000000000000000000000000000000000000000000000",
"thursday": "010000000000000000000000000000000000000000000000",
"friday": "010000000000000000000000000000000000000000000000",
"saturday": "010000000000000000000000000000000000000000000000",
"sunday": "010000000000000000000000000000000000000000000000",
"holiday": "010000000000000000000000000000000000000000000000",
"special_days": [{
"id": 59,
"date": "2019-10-07",
"remark": null,
"timetable_id": 28
}, {
"id": 60,
"date": "0000-10-22",
"remark": null,
"timetable_id": 28
}],
"monday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"tuesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"wednesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"thursday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"friday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"saturday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"sunday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"holiday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"start_timestamp": 1546275661000,
"end_timestamp": 1546275661000
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 10,
"name": "test1"
}]
}{
"code": 200,
"message": "OK",
"data": {
"id": 28,
"name": "liufan1131",
"monday": "010000000000000000000000000000000000000000000000",
"tuesday": "010000000000000000000000000000000000000000000000",
"wednesday": "010000000000000000000000000000000000000000000000",
"thursday": "010000000000000000000000000000000000000000000000",
"friday": "010000000000000000000000000000000000000000000000",
"saturday": "010000000000000000000000000000000000000000000000",
"sunday": "010000000000000000000000000000000000000000000000",
"holiday": "010000000000000000000000000000000000000000000000",
"special_days": [{
"id": 59,
"date": "2019-10-07",
"remark": null,
"timetable_id": 28
}, {
"id": 60,
"date": "0000-10-22",
"remark": null,
"timetable_id": 28
}],
"monday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"tuesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"wednesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"thursday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"friday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"saturday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"sunday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"holiday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"start_timestamp": 1546275661000,
"end_timestamp": 1546275661000
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 141,
"device_id": 314,
"device_name": "v2.1.0-test4444",
"group_id": 2,
"group_name": "Default group",
"timetable_id": 35,
"timetable_name": "test-0713",
"group_type": 2
}]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 141,
"device_id": 314,
"device_name": "v2.1.0-test4444",
"group_id": 2,
"group_name": "Default group",
"timetable_id": 35,
"timetable_name": "test-0713",
"group_type": 2
}]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"device_id": 9,
"device_name": "device6",
"timetable_groups": [{
"group_id": 476,
"group_name": "bbb",
"group_type": 2,
"timetable_id": 0,
"timetable_name": ""
}]
}]
}概要
ゲートウェイデバイスを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
デバイス情報を更新します。(ゲートウェイデバイスはグループに連携できません)
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
概要
デバイス (ゲートウェイまたはカメラデバイス) を削除します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
カメラのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/cameraList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
関連する親デバイスを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/gatewayList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
cameraフィールドの説明
エラーレスポンスのフィールド
概要
デバイスリストを表示します。デフォルトの順序は ID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/device
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
device_type フィールドの説明
device フィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
概要
同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。
現在サポートされているデバイスタイプは、SensePass、SensePassProです。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/update/config/batch
リクエスト方法
POST application/json
リクエストパラメーター
構成項目とパラメーターの説明
リクエスト例
通常のレスポンス
エラーレスポンスのフィールド
概要
オンラインデバイスにドアオープンコマンドを送信します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/open
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/notify
リクエスト方法
POST application/json
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
リクエスト例
概要
デバイスのシリアル番号でデバイスのLDIDを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/ldid
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
レスポンスのフィールド
必須
デバイスの設置場所
ip
string
Yes
ゲートウェイ IP
port
int
Yes
ゲートウェイポート
account
string
Yes
ゲートウェイのログインアカウント
password
string
Yes
ゲートウェイのログインパスワード
Yes
タイムスタンプ
デバイスの説明
direction
int
デバイスのアクセス方向
ldid
string
デバイスの LDID 番号
type_id
int
デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）
type_name
string
デバイスタイプ名
update_at
long
更新時間
create_at
long
作成時間
Yes
ゲートウェイID
protocol
int
Yes
プロトコルタイプ。1 = RTSP、2 = ONVIF、3 = GB28181 を示します。
camera_name
string
Yes
カメラ名
location
string
Yes
カメラの設置場所
snap_mode
int
Yes
スナップモード。1 = 精密、2 = 時間制、3 = リアルタイムを示します。
url
string
条件による
RTSP モードはパスする必要があります
ip
string
条件による
カメラ ip、ONVIF GB28181 モードはパスする必要があります
port
int
条件による
カメラポート、ONVIF GB28181 モードはパスする必要があります
account
string
条件による
カメラのログインアカウント、ONVIF モードはパスする必要があります
password
string
条件による
カメラのログインパスワード、ONVIF モードはパスする必要があります
server_id
string
条件による
SIP サーバーの SIP ID、GB28181 モードはパスする必要があります
camera_id
string
条件による
カメラの SIP ID、GB28181 モードはパスする必要があります
Yes
タイムスタンプ
データ
説明
direction
int
デバイスのアクセス方向
ldid
string
デバイスの LDID 番号
type_id
int
デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）
type_name
string
デバイスタイプ名
update_at
long
更新時間
create_at
long
作成時間
No
設置場所
description
string
No
説明
direction
int
No
デバイスのアクセス方向。1 = In、2 = Out
group_staff
list<long>
No
従業員グループ (id のグループ)
group_visitor
list<long>
No
ビジターグループ (id のグループ)
group_blacklist
list<long>
No
ブラックリストグループ (id のグループ)
Yes
タイムスタンプ
データ
デバイスのステータス
description
string
説明
direction
int
デバイスのアクセス方向。0 - デフォルト（Null）、1 - In、2 - Out
ip
string
IP アドレス
ldid
string
デバイスの sn 番号
type_id
int
デバイスタイプ
type_name
string
デバイスタイプ名
user_group
list<group>
従業員グループ
guest_group
list<group>
ビジターグループ
blacklist_group
list<group>
ブラックリストグループ
update_at
long
デバイスの最新の更新タイムスタンプ
create_at
long
デバイスの最初のオンラインタイムスタンプ
last_offline_time
long
デバイスの最新のオフラインタイムスタンプ
デフォルトのグループかどうかを示します
person_count
int
グループ内の人数を示します
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
設置場所
url
string
Nebula デバイスの IP アドレス
camera_sn
string
カメラの sn 番号
camera_name
string
カメラ名
state
int
1 = オンライン、2 = オフライン
Yes
タイムスタンプ
データ
設置場所
host
string
IP
port
int
ポート番号
state
int
オンライン状態。 1 = オンライン、2 = オフライン
cameras
list<camera>
カメラリスト
カメラの設置場所
url
string
Nebula デバイスの IP アドレス
camera_sn
string
カメラの sn 番号
camera_name
string
カメラ名
No
デバイスID の配列
typeId
int
No
デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）
location
string
No
デバイスの設置場所
name
string
No
デバイス名
description
string
No
デバイスの説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
現在のページ番号
pageSize
int
ページサイズ
totalPage
int
ページ合計
デバイスタイプの説明
create_at
string
作成時間
update_at
string
更新時間
node_type
int
ノードのタイプ。0 = 共通のデバイス、1 = ゲートウェイデバイス
デバイスの向き
location
string
デバイスの設置場所
ip
string
デバイスの IP
status
int
デバイスのオンライン状態
groups
list<group>
デバイスが連携されたグループ
active
int
偽削除フラグ
type_id
long
デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）
description
string
デバイスの説明
software_version
string
ソフトウェアのバージョン番号
info
string
デバイス情報
company_id
long
企業ID
group_count
int
デバイスに連携されているグループの数
create_at
string
作成時間
update_at
string
更新時間
last_offline_time
long
最後のオフラインタイムスタンプ
Yes
Appキー。
sign
string
Yes
シグネチャ。URL に記述されます。
timestamp
string
Yes
タイムスタンプです。URL に記述されます。
認証モード
mode
int
9 : 顔認証
のみ利用可能
✓
✓
音声ブロードキャスト
voice_broadcast
bool
true : オン
false : オフ
×
✓
スマートフィルライト
fill_light
bool
true : オン
false : オフ
×
×
デバイスのメインメッセージ
welcome_tip
string
長さ制限 : 50
✓
✓
認証メッセージverify_success_tip
string
長さ制限 : 50
認証エラーメッセージverify_fault_tip
string
長さ制限 : 50
認証従業員情報show_user_info
string
0 - 表示なし、1 -表示する。表示順は、従業員ID、部署、役職、ID 番号、カスタマイズプロンプトです。例 : 01000 は部署情報のみが表示されることを示します。
認証成功後に写真を表示する
use_show_avatar
bool
true : オン
false : オフ
認証成功後に名前を表示する
show_user_name
bool
true : オン
false : オフ
ブラックリストメッセージblack_list_tip
string
長さ制限 : 50
ブラックリストドアオープンblack_list_open
bool
true : オン
false : オフ
生体認識
liveness
bool
true : オン
false : オフ
✓
✓
生体認識閾値liveness_threshold
float
[0、1] 小数点以下 2 桁です。推奨値は 0.99 です。
顔認証閾値
verify_threshold
float
[0、1] 小数点以下 2 桁です。推奨値は 0.83 です。
IDカード比較閾値certificate_threshold
float
当機能はご利用いただけません。0.5 で仮の値をリクエストしてください。
顔認識距離(メートル)
verification_distance
float
0.5
1
1.5
2
ドアオープンモード
open_door_type
int
0 : ローカルリレー
1 : Wiegand 26 (8+16bit id)
2 : Wiegand 32
3 : Wiegand 34
✓
✓
ネットワークリレー IP アドレス
network_relay_address
string
ドアオープンモードでネットワークリレーを指定した際に必要です。
{IP}:{PORT} 形式 (例 : 192.168.2.1:12345)
✓
✓
ドアオープンタイム (秒)
keep_door_open_duration
int
[1、30]、整数
✓
✓
認証インターバル (秒)
open_interval
int
[3、30]、整数
✓
✓
GPIO A - 出力
gpio_a
int
1 : なし
2 : Doorbell
3 : アラート
✓
✓
GPIO B - 入力
gpio_b
int
1 : なし
2 : ドアセンサー
3 : Exit ボタン
4 : Fire signal
✓
✓
GPIO C - 入力
gpio_c
int
1 : なし
2 : ドアセンサー
3 : Exit ボタン
4 : Fire signal
✓
✓
Wiegand入力
wigan_input
int
1 : なし
2 : Wiegand 26 (8 +16bit id)
3 : Wiegand 26 (24bit id)
4 : Wiegand 32
✓
✓
アラート音スイッチ
buzzer_status
bool
true : オン
false : オフ
✓
✓
システム言語
language_type
int
1 : 中国語
2 : 英語
✓
✓
自動スタンバイ
standby_open
bool
true: オン
false: オフ
✓
✓
スタンバイ時間 (分)
wait_time
int
[3、30]、整数
✓
✓
自動再起動
auto_reboot
bool
true: オン
false: オフ
✓
✓
再起動時間
reboot_time
string
hh:mm:ss (時間、分、秒)
✓
✓
Wiegand入力
card_read_protocol
int
1 : オリジナルの IC カード番号
2 : Wiegand 26 (8 +16bit)
3 : Wiegand 26 (24 bit)
4 : Wiegand 32
5 : Wiegand 34
×
×
無効なパラメーターです。デバイスタイプが存在しません。
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
Yes
通知タイプ。0000 はカスタマイズ通知を示します。メッセージは payload.content を通してカスタマイズします。
payload.content
object
No
メッセージの内容は、透過的にデバイスに送信されます。
trace_id
string
Yes
リクエストされるイベントのシリアル番号です。記号列は UUID と類似しています。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
デバイスが存在しません。
30001
the Device is out line
デバイスがオンラインではありません。
Yes
Appキー
sign
string
Yes
シグネチャ。計算ルールについては、ドキュメントをご参照ください
timestamp
string
Yes
タイムスタンプ
パラメーター名
型
必須
説明
identifier
string
Yes
SNB など、デバイスタイプの識別子
name
string
Yes
デバイス名
location
パラメーター名
型
Yes
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
id
long
デバイスの ID
name
string
名前
location
string
設置場所
description
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
Yes
説明
channel
int
Yes
チャンネル
identifier
string
Yes
CAM など、デバイスタイプの識別子
gateway_id
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
long
デバイスのID
name
string
名前
location
string
設置場所
description
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
デバイスのID
name
string
No
名前
location
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
デバイスの ID
name
string
デバイス名
location
string
デバイスの設置場所
state
パラメーター名
型
説明
id
long
グループ ID
name
string
グループ名
type
int
グループタイプ
is_default
コード
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
デバイスのID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
600
Sync Failed
RPC が失敗しました
パラメーター名
型
必須
説明
gateway_id
long
Yes
ゲートウェイデバイスのID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
long
カメラデバイスのID
sn
string
Nebula デバイスの sn 番号
channel
string
チャンネル番号
position
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
デバイスのID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
long
Nebula デバイスのID
sn
string
Nebula デバイスの sn 番号
name
string
名前
location
パラメーター名
型
説明
id
long
カメラデバイスのID
sn
string
Nebula デバイスの sn 番号
channel
string
チャンネル番号
position
code
メッセージ
説明
498
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
page
int
No
ページ番号 (デフォルトは 1 です)
size
int
No
1 ページあたりのデータ数 (デフォルトは 20 です)
ids
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
total
int
総計
size
int
サイズ
data
object
pageNum
パラメーター名
型
説明
device_type
object
デバイスタイプ
device
object
デバイス情報
パラメーター名
型
説明
id
long
デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）
name
string
デバイスタイプ名
identifier
string
デバイスタイプの識別子 (略称)
description
パラメーター名
型
説明
id
long
デバイスのID
sn
string
デバイスの sn 番号
name
string
デバイス名
direction
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
30001
Param Invalid
無効なデバイスの sn 番号
30001
Param Invalid
無効なデバイスのステータス
50001
RPC FAILED
リモートでデバイスリストを取得できませんでした
パラメーター名
型
必須
説明
device_ids
list<long>
Yes
ID リスト。デバイスID のタイプは同じである必要があります。
key
json
Yes
ターゲットのデバイスタイプ。小文字の sps、spsp から 1 つ選択します。それぞれ SensePass、SensePassProの略称です。
app_key
構成項目
型
値の範囲 / オプション
Pass
(sps)
PassPro
(spsp)
実行ステータス
device_run_type
int
1 : 実行
2 : 停止
✓
✓
利用モード
use_mode
int
✓ (1 : ゲートモード、2 :ドアモード)
code
メッセージ
エラーの説明
50001
RPC FAILED
RPCに失敗しました
30001
Param Invalid
無効なパラメーターです
498
Param Invalid
無効なパラメーターです。デバイスID リストが空です。
498
パラメーター名
型
必須
説明
id
long
Yes
デバイスの ID
remark
string
No
ドアオープンの備考。長さ制限は 255。
app_key
code
メッセージ
エラーの説明
498
Param Invalid
無効なパラメーターです。デバイスが存在しません。
603
Device Offline
デバイスがオンラインではありません。
30001
Param Invalid
無効なパラメーターです。デバイスID は空にはできません。
パラメーター名
型
必須
説明
payload
object[]
Yes
通知メッセージの対象。複数の送信が可能です。
payload.ldid
string
Yes
メッセージを受信するデバイスの LDID
payload.type
code
メッセージ
エラーの説明
10003
Request Expired
タイムスタンプが期限切れになりました。
10005
Signature Failed
無効な署名です。
60001
grpc fail
通知の送信に失敗しました。
60001
パラメーター
説明
例
type：“0000”
サードパーティーがカスタマイズした内容です
{
"trace_id":"75d836b4-4a71-4b32-bb16-d215d208195a",
"payload":[
{
"type": "0000",
"ldid":"SPS-8366d77b20689ca0cd0dbfadbea85a2e",
"content": "instruction1" //これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます。 },
{
"type": "0000",
"ldid":"SPSP-8366d77b20689ca0cd0dbfadbea85a2e",
"content": "instruction2" // これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます。 }
]
}
パラメータ名
型
必須
説明
duid
string
Yes
デバイスシリア番号
Identifier
string
Yes
デバイス識別子、詳細について、次のデバイス型番識別子をご参照ください
app_key
デバイス名称
デバイス型番識別子
SensePass
SPS
SensePass Pro
SPSP
SenseThunder-E
SPSPE
SenseThunder-E Mini
SPSE
パラメータ
型
説明
code
int
コード
message
string
メッセージ
data
string
デバイスLDID
string
string
string
string
string
object
string
string
string
object
string
int
string
object
string
object
string
string
object
string
string
list<long>
int
string
string
string
✓ (3 : 1 人モード、4 : 複数人モード)
Param Invalid
string
string
Device Not Exist
string
{
"code": 200,
"message": "OK",
"data": {
"id": 1561,
"name": "SNB",
"location": "306",
"direction": 0,
"description":"",
"ldid": "SNB-2ee63f9c699a7316a3e2a44646d0c844",
"type_id": 10,
"type_name": "SNB",
"update_at": 1574854584,
"create_at": 1574670842
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 1562,
"name": "40F",
"location": "40F",
"description": "",
"direction": 0,
"ldid": "CAM-b054ac85cb84137b75abaa2bd7fc4a38",
"type_id": 11,
"type_name": "CAM",
"update_at": 1574851340,
"create_at": 1574851340
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 2,
"name": "勤務グループ ",
"location": "日本東京都千代田区",
"state": 0,
"description": "",
"direction": 1,
"ip": "",
"ldid": "SHL-3931ff3bd1fd7157866c4d22858c533c",
"type_id": 1,
"type_name": "SenseHello",
"user_group": [{
"id": 1,
"name": "Default group",
"type": 1,
"devices": [],
"is_default": 1,
"person_count": 19988
}],
"guest_group": [ {
"id": 105,
"name": "test",
"type": 2,
"devices": [],
"is_default": 0,
"person_count": 5
}],
"blacklist_group": [ {
"id": 148,
"name": "User_1560842344639",
"type": 5,
"devices": [],
"is_default": 0,
"person_count": 23
}],
"update_at": 0,
"create_at": 0,
"last_offline_time":0
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id":1562
"sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
"channel": 2,
"position": "",
"url": "172.20.4.110",
"state": 1,
"camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
"camera_name": "2"
}, {
"id":1563
"sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
"channel": 1,
"position": "",
"url": "172.20.4.110",
"state": 1,
"camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
"camera_name": "1"
}]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id":1561,
"sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
"name": "306",
"location": "306",
"host": "172.20.4.110",
"port": 80,
"cameras": [{
"id":1562,
"sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
"channel": 1,
"position": "",
"url": "172.20.4.110",
"camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
"camera_name": "1"
}, {
"id":1563,
"sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
"channel": 2,
"position": "",
"url": "172.20.4.110",
"camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
"camera_name": "2"
}]
}
}{
"code": 200,
"message": "OK",
"data": {
"total": 406,
"pageNum": 1,
"size": 20,
"pageSize": 20,
"totalPage": 21,
"data": [{
"device_type": {
"id": 2,
"name": "SenseID",
"identifier": "SID",
"description": "SenseID",
"create_at": "2018-08-15 10:08:12.0",
"update_at": "2018-08-15 10:08:15.0"
},
"device": {
"id": 31,
"sn": "SID-5f51f769de2cdc8681e85ad590456516",
"name": "306 試験機",
"direction": 0,
"location": "306",
"ip": null,
"status": 2,
"groups": [{
"id": 2,
"name": "Default group",
"type": 2
}],
"active": 1,
"type_id": 2,
"description": null,
"software_version": null,
"info": null,
"company_id": 1,
"group_count": 1,
"create_at": "2019-03-20 09:50:08.0",
"update_at": "2019-08-28 08:56:05.0"
}
}]
}
}
{
"device_ids": [
3
],
"sps": {
"device_run_type": 1,
"use_mode": 1,
"mode": 1,
"welcome_tip": "welcomeTip22222222",
"verify_success_tip": "verifySuccessTip",
"verify_fault_tip": "verifyFaultTip",
"show_user_info": "00100",
"liveness": true,
"liveness_threshold": 0.95,
"verify_threshold": 0.9,
"face_width": 300,
"open_door_type": 1,
"keep_door_open_duration": 10,
"gpio_a": 1,
"gpio_b": 1,
"gpio_c": 1,
"buzzer_status": true,
"language_type": 1,
"auto_reboot": false,
"reboot_time": "09:52:50",
"standby_open": false,
"wait_time": 10,
"recognition_distance": 1.5,
"wigan_input": 1,
"network_relay_address": "",
"open_interval": 5,
"use_show_avatar": true
}
}{
"code": 200,
"message": "OK"
}{
"code": 200,
"message": "OK",
"desc": ""
}{
"code": 200,
"message": "OK",
"desc": ""
}{
"code": 200,
"message": "OK",
" data": " SPS-c725f19ddf7d5d9fabee189c29f10b11"
}4 : ネットワークリレー + リレー ip
5 : Wiegand 26 (24bit id)
5 : Wiegand 34
概要
従業員を追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/user
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
類似登録者が存在する場合のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
従業員情報を変更します。
バージョン v1 から、従業員ID、IC カード番号、および空の ID 番号の処理ロジックが改善されました。パラメーターが渡されなかった場合や、パラメーターが null の場合、変更は行われません。空の string (””） が渡された場合は、空として設定されます。バージョン v1 のインターフェースは、引き続きご利用いただくことができます。
リクエストアドレスの例
https://HOST:PORT/api/v2/user/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
group フィールドの説明
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
従業員を削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
ビジターを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
ビジター情報を変更します。
（すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。）
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/update/{id}
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
ビジターを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v1/guest/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
ブラックリストを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
概要
既存の従業員またはビジターを選択してブラックリストに移動（登録者タイプを変更）します。
ブラックリストに移動した後、登録者タイプがブラックリスト (type = 5) に変更されます。元の登録者グループと部署情報はクリアされますが、他の情報は保持されます。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/in
リクエスト方法
POST application/json
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
ブラックリストを削除します。 ブラックリストから外されると、登録者タイプは元の識別子に戻ります (タイプ 1 または 2)。他の情報は保持されます。 ブラックリストの登録者自体を削除するには、「ブラックリストの削除」の章を参照してください。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/move/out
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
ブラックリストの情報を変更します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/update
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールド
エラーレスポンスのフィールド
概要
ブラックリストを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v2/black/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
エラーレスポンスのフィールド
概要
従業員、ビジター、およびブラックリストのすべての登録者の情報を取得します。特定のフィールドのフィルター検索が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v1/user/list
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
group フィールドの説明
エラーレスポンスのフィールド
No
従業員グループのリスト。デフォルト値はタイプで定義します。
icNumber
string
No
IC カード番号。空の string も指定可能。長さ制限は 45。
jobNumber
string
No
従業員番号。空の string も指定可能。長さ制限は 45。
mobile
string
No
携帯電話番号。空の string も指定可能。長さ制限は 20。
name
string
Yes
従業員名
remark
string
No
特記事項。空の string も指定可能。長さ制限は 255。
departmentId
long
No
部署ID
areaCode
string
No
電話番号の国別コードおよび市外局番
birthday
string
No
誕生日 (日付形式 : 2019-06-15)
entryTime
string
No
入社日 (日付形式 : 2019-06-15)
string
No
メールアドレス。長さ制限は 45。
position
string
No
役職。長さ制限は 45。
location
string
No
勤務地。長さ制限は 45。
idNumber
string
No
ID 番号。長さ制限は 45。（利用できません）
gender
int
No
性別。1 : 女性、2 : 男性
prompt
string
No
顔認証時に表示するカスタムメッセージ
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
携帯電話番号
remark
string
備考
type
int
タイプ。1 : 従業員、2 : ビジター
birthday
string
誕生日
string
メールアドレス
position
string
役職
location
string
勤務地
groupList
list<group>
従業員グループ情報
gender
string
性別
ic_number
string
IC カード番号
id_number
string
IDカード番号（利用できません）
job_number
string
従業員番号
company_id
long
企業ID
create_at
string
登録時間
update_at
string
更新時間
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
無効なパラメーターです。登録者IC 番号の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者番号が空です。
30001
Param Invalid
無効なパラメーターです。登録者番号の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者の携帯電話番号が空です。
30001
Param Invalid
無効なパラメーターです。登録者の携帯電話番号の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者のメモが空です。
30001
Param Invalid
無効なパラメーターです。備考の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者の認証用顔写真の形式が無効です。
30001
Param Invalid
無効なパラメーターです。登録者グループのID が存在しません。
30001
Param Invalid
無効なパラメーターです。登録者のIC 番号がすでに存在します。
30001
Param Invalid
無効なパラメーターです。登録者番号がすでに存在します。
30001
Param Invalid
無効なパラメーターです。登録者の携帯電話番号がすでに存在します。
30001
Param Invalid
無効なパラメーターです。登録者のID がすでに存在します。
30001
Param Invalid
無効なパラメーターです。部署IDが存在しません。
30001
Param Invalid
無効なパラメーターです。従業員の認証用顔写真のファイルが大きすぎます。
30002
Similar User Exist
類似する従業員がすでに存在します。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました。
No
タグの強制追加
groups
list<group>
No
従業員グループリスト。空のリストが渡される場合、従業員はどのグループにも属さないことを示します。情報が渡されない場合、変更は行われません。従業員はリスト内の有効なグループ (グループID が存在し、企業に属しており、かつグループタイプが従業員) にのみ追加されます。
icNumber
string
No
IC カード番号。長さ制限は 45。
idNumber
string
No
ID 番号。長さ制限は 45。（利用できません）
jobNumber
string
No
従業員番号。長さ制限は 45。
mobile
string
No
携帯電話番号。空の string を指定できます。
name
string
No
名前。空の string は指定できません。
remark
string
No
備考。空の string も指定可能。長さ制限は 255。
gender
int
No
性別。1 : 女性、2 : 男性
departmentId
int
No
部署ID
areaCode
string
No
国別コードおよび市外局番
birthday
string
No
誕生日
entryTime
string
No
入社日
string
No
メールアドレス。長さ制限は 45。
position
string
No
役職。長さ制限は 45。
location
string
No
勤務地。長さ制限は 45。
prompt
string
No
カスタマイズされたウェルカムプロンプト
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
携帯電話番号
remark
string
備考
type
int
タイプ。1 : 従業員、2 : ビジター
birthday
string
誕生日
string
メールアドレス
position
string
役職
location
string
勤務地
groupList
list<group>
従業員グループ情報
gender
string
性別
prompt
string
顔認証時に表示するカスタムメッセージ
ic_number
string
IC カード番号
id_number
string
IDカード番号（利用できません）
job_number
string
従業員ID
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
内部エラーです。従業員をグループに連携できませんでした。
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
Yes
携帯電話番号。長さ制限は 20。空の値で登録しないでください。
remark
string
Yes
備考。空の string も指定可能。長さ制限は 255。
groups
list<long>
Yes
ビジターグループのリスト。デフォルト値はタイプで定義します。
force
int
No
デフォルトで追加するかどうか。0 : 強制ではない (デフォルト)、1 : 強制
idNumber
string
No
ID 番号。長さ制限は 45。（利用できません）
receptionUserId
long
Yes
受付担当者 ID
dateTimeFrom
datetime
Yes
来訪時間（開始）。例 : 2018-07-20 12:30:45
dateTimeTo
datetime
Yes
来訪時間（開始）。例 : 2019-07-20 12:30:45
gender
int
No
性別。1 : 女性、2 : 男性
guestCompany
string
No
ビジターの企業。長さ制限は 45。
position
string
No
役職。長さ制限は 45。
guestPurpose
string
No
ビジターの来訪目的。長さ制限は 45。
string
No
メールアドレス。長さ制限は 45。
icNumber
string
No
IC カード番号。長さ制限は 45。
birthday
string
No
誕生日
level
string
No
ビジターのレベル。長さ制限は 20。
prompt
string
No
カスタマイズプロンプト。長さ制限は 45。
areaCode
string
No
携帯電話番号の国別コードおよび市外局番。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
電話番号
remark
string
備考
groups
list<group>
従業員グループ情報
ic_number
string
IC カード番号
id_number
string
IDカード番号（利用できません）
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
reception_user_id
long
受付担当者ID
reception_user_name
string
受付担当者名
date_time_from
string
来訪時間（開始）
date_time_to
string
来訪時間（終了）
areaCode
string
電場番号の国別コードおよび市外局番。例 : 86
guestCompany
string
ビジターの企業名
position
string
役職
guestPurpose
string
ビジターの来訪目的
level
string
ビジターのレベル
string
ビジターのメールアドレス
birthday
string
ビジターの誕生日。例 : 2019-06-17
prompt
string
カスタマイズプロンプト
gender
int
ビジターの性別。1 : 女性、2 : 男性
無効なパラメーターです。ビジターの携帯電話番号は空にはできません。
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号の長さが空です。
30001
Param Invalid
無効なパラメーターです。ビジターのコメントは空にはできません。
30001
Param Invalid
無効なパラメーターです。ビジターのコメントの長さが無効です。
30001
Param Invalid
無効なパラメーターです。ビジターの応対者は空にはできません。
30001
Param Invalid
無効なパラメーターです。来訪時間（開始）の形式が無効です。
30001
Param Invalid
無効なパラメーターです。来訪時間（開始）の形式が無効です。
30001
Param Invalid
無効なパラメーターです。終了時間の形式が無効です。
30001
Param Invalid
無効なパラメーターです。ビジターのの認証用顔写真の形式が無効です。
30001
Param Invalid
無効なパラメーターです。ビジターのグループID が存在しません。
30001
Param Invalid
無効なパラメーターです。ビジターのの認証用顔写真ファイルが大きすぎます。
30002
Similar User Exist
類似するビジターが存在します。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました。
No
ビジターの認証用顔写真
mobile
string
Yes
携帯電話番号。長さ制限は 20。
remark
string
No
備考。空の string も指定可能。長さ制限は 255。
groups
list<long>
Yes
ビジターグループのリスト。デフォルト値はタイプで定義します。
force
int
No
タグの強制追加
idNumber
string
No
ID 番号。長さ制限は 45。（利用できません）
receptionUserId
long
Yes
受付担当者ID
dateTimeFrom
datetime
Yes
来訪時間（開始）。例 : 2018-07-20 12:30:45
dateTimeTo
datetime
Yes
来訪時間（開始）。例 : 2019-07-20 12:30:45
areaCode
string
No
携帯電話番号の国別コードおよび市外局番。
guestCompany
string
No
ビジターの企業名。長さ制限は 45。
position
string
No
役職。長さ制限は 45。
guestPurpose
string
No
ビジターの来訪目的。長さ制限は 45。
level
string
No
ビジターのレベル。長さ制限は 20。
string
No
ビジターのメールアドレス。長さ制限は 45。
birthday
string
No
ビジターの誕生日。例 : 2019-06-17
prompt
string
No
個別化されたプロンプト。長さ制限は 45。
gender
int
No
ビジターの性別。1 : 女性、2 : 男性
icNumber
string
No
IC カード番号。長さ制限は 45。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
電話番号
remark
string
備考
groups
list<group>
ビジターグループ情報
position
string
役職
level
string
ビジターのレベル
string
メールアドレス
birthday
string
誕生日
prompt
string
カスタマイズプロンプト
gender
int
ビジターの性別。1 : 女性、2 : 男性
ic_number
string
IC カード番号
id_number
string
IDカード番号（利用できません）
company_id
long
企業ID
create_at
string
作成時間
update_at
string
更新時間
reception_user_id
long
受付担当者ID
reception_user_name
string
受付担当者名
group_count
int
ビジターグループ数
date_time_from
string
来訪時間（開始）
date_time_to
string
来訪時間（終了）
date_time
string
来訪時間。
area_code
string
携帯電話番号の国別コードおよび市外局番です。例 : 86
guest_company
string
ビジターの企業
guest_purpose
string
ビジターの来訪目的
無効なパラメーターです。ビジター名が空です。
30001
Param Invalid
無効なパラメーターです。ビジターのID 番号の長さが無効です。
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号は空にはできません。
30001
Param Invalid
無効なパラメーターです。ビジターの携帯電話番号の長さが空です。
30001
Param Invalid
無効なパラメーターです。ビジターのコメントは空にはできません。
30001
Param Invalid
無効なパラメーターです。ビジターのコメントの長さが無効です。
30001
Param Invalid
無効なパラメーターです。ビジターの応対者は空にはできません。
30001
Param Invalid
無効なパラメーターです。来訪時間（開始）の形式が無効です。
30001
Param Invalid
無効なパラメーターです。来訪時間（開始）の形式が無効です。
30001
Param Invalid
無効なパラメーターです。終了時間の形式が無効です。
30001
Param Invalid
無効なパラメーターです。ビジターのの認証用顔写真の形式が無効です。
30001
Param Invalid
無効なパラメーターです。ビジターのグループID が存在しません。
30001
Param Invalid
無効なパラメーターです。ビジターのの認証用顔写真ファイルが大きすぎます。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔が検知されていません。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。複数の顔が検知されました。
50001
RPC FAILED
リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました。
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
No
ブラックリストグループのID リストです。渡さない場合、または空は、どのグループにも追加しないことを示します。
areaCode
string
No
国別コードおよび市外局番。長さ制限は 8。
mobile
string
No
携帯電話番号。長さ制限は 20。
gender
int
No
性別。1 : 女性、2 : 男性
birthday
string
No
誕生日 (日付形式 : 2019-06-15)
string
No
メールアドレス。長さ制限は 45。
icNumber
string
No
IC カード番号。長さ制限は 45。
idNumber
string
No
ID 番号。長さ制限は 45。（利用できません）
prompt
string
No
カスタマイズプロンプト。長さ制限は 255。
remark
string
No
備考。長さ制限は 255。
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
携帯電話番号
string
メールアドレス
birthday
string
誕生日
remark
string
追加情報
groups
list<group>
グループ情報
prompt
string
カスタマイズプロンプト
gender
int
性別。0 : 不明、1 : 女性、2 : 男性
avatar_show
string
表示用写真
ic_number
string
IC カード番号
id_number
string
ID カード番号
area_code
string
国別コードおよび市外局番です。数字のみを指定できます。何も入力されなかった場合のデフォルトは 86 です。
last_type
int
型
create_at
string
作成時間
従業員IDはシステム内に存在しています。
498
Param Invalid
グループID は企業に属していません。
600
Sync Failed
認証用顔写真内で顔を検出できません。
600
Sync Failed
認証用顔写真内で複数の顔が検出されました。
600
Sync Failed
顔の数が最大数の制限を超えています。
600
Sync Failed
認証用顔写真が小さすぎます。
600
Sync Failed
検知スコアが低すぎます。
600
Sync Failed
顔フレームのピクセルが少なすぎます。
600
Sync Failed
ピッチ角が大きすぎます。
600
Sync Failed
転向角が大きすぎます。
600
Sync Failed
ロール角が大きすぎます。
600
Sync Failed
対面距離が基準を満たしていません。
600
Sync Failed
顔サイズ比が低すぎます (顔の長方形部分/画像領域)
600
Sync Failed
顔が遮られすぎています。
600
Sync Failed
明るさが基準を満たしていません。
600
Sync Failed
あいまいさが基準を満たしていません。
600
Sync Failed
口が開き過ぎています。
600
Sync Failed
欠けた顔が多すぎます。
600
Sync Failed
RPCに失敗しました
700
Multi Request Error
一括処理に失敗しました。
700
Multi Request Error
ブラックリストとグループの連携に失敗しました。
30001
Param Invalid
ブラックリスト名は空にはできません。
30001
Param Invalid
ブラックリスト名が長すぎます。
30001
Param Invalid
ブラックリストの電話番号が無効です。
30001
Param Invalid
ブラックリストのメールアドレスが長すぎます。
30001
Param Invalid
ブラックリストのメールアドレスが無効です。
30001
Param Invalid
ブラックリストの誕生日の形式が無効です。
30001
Param Invalid
ブラックリストの電話番号が長すぎます。
30001
Param Invalid
ブラックリストのカスタマイズメッセージが長すぎます。
30001
Param Invalid
ブラックリストの備考が長すぎます。
30001
Param Invalid
ブラックリストのIC カード番号が長すぎます。
30001
Param Invalid
ブラックリストのID カード番号の長さが無効です。
30001
Param Invalid
ブラックリストの領域の長さが無効です。
30001
Param Invalid
ブラックリストの領域の形式が無効です。
30001
Param Invalid
ブラックリストの認証用顔写真ファイルが無効です。
30001
Param Invalid
ブラックリストの認証用顔写真ファイルが大きすぎます。
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
ブラックリストとグループの連携解除に失敗しました。
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
No
認証用顔写真
birthday
string
No
誕生日 (日付形式 : 2019-06-15)
gender
int
No
性別。1 : 女性、2 : 男性
groups
list
No
ブラックリストグループのID リスト。渡さない場合、または空は、どのグループにも追加しないことを示します。
icNumber
string
No
IC カード番号
idNumber
string
No
ID カード番号（利用できません）
string
No
メールアドレス
mobile
string
No
携帯電話番号
name
string
Yes
名前
prompt
string
No
カスタマイズプロンプト
remark
string
No
備考
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
携帯電話番号
string
メールアドレス
birthday
string
誕生日
remark
string
追加情報
groups
list<group>
グループ情報
prompt
string
カスタマイズプロンプト
gender
int
性別。0 : 不明、1 : 女性、2 : 男性
avatar_show
string
表示用写真
ic_number
string
IC カード番号
id_number
string
ID カード番号
area_code
string
国別コードおよび市外局番。数字のみを指定できます。何も入力されなかった場合のデフォルトは 86。
last_type
int
タイプ
create_at
string
作成時間
create_by
string
作成者
IC カード番号はシステム内に存在しています。
498
Param Invalid
従業員IDはシステム内に存在しています。
498
Param Invalid
グループID は企業に属していません。
600
Sync Failed
認証用顔写真内で顔を検出できません
600
Sync Failed
認証用顔写真内で複数の顔が検出されました。
600
Sync Failed
顔の数が最大数の制限を超えています。
600
Sync Failed
認証用顔写真が小さすぎます。
600
Sync Failed
検知スコアが低すぎます。
600
Sync Failed
顔フレームのピクセルが少なすぎます。
600
Sync Failed
ピッチ角が大きすぎます。
600
Sync Failed
転向角が大きすぎます。
600
Sync Failed
ロール角が大きすぎます。
600
Sync Failed
対面距離が基準を満たしていません。
600
Sync Failed
顔サイズ比が低すぎます (顔の長方形の領域 / 画像領域)
600
Sync Failed
顔が遮られすぎています。
600
Sync Failed
明るさが基準を満たしていません。
600
Sync Failed
あいまいさが基準を満たしていません。
600
Sync Failed
口が開き過ぎています。
600
Sync Failed
欠けた顔が多すぎます。
600
Sync Failed
RPCに失敗しました
700
Multi Request Error
一括処理に失敗しました。
700
Multi Request Error
ブラックリストとグループの連携に失敗しました。
30001
Param Invalid
ブラックリスト名は空にはできません。
30001
Param Invalid
ブラックリスト名が長すぎます。
30001
Param Invalid
ブラックリストの電話番号が無効です。
30001
Param Invalid
ブラックリストのメールアドレスが長すぎます。
30001
Param Invalid
ブラックリストのメールアドレスが無効です。
30001
Param Invalid
ブラックリストの誕生日の形式が無効です。
30001
Param Invalid
ブラックリストの電話番号が長すぎます。
30001
Param Invalid
ブラックリストのカスタマイズメッセージが長すぎます。
30001
Param Invalid
ブラックリストの備考が長すぎます。
30001
Param Invalid
ブラックリストのIC カード番号が長すぎます。
30001
Param Invalid
ブラックリストのID カード番号の長さが無効です。
30001
Param Invalid
ブラックリストの領域の長さが無効です。
30001
Param Invalid
ブラックリスト領域の形式が無効です。
30001
Param Invalid
ブラックリストの認証用顔写真ファイルが無効です。
30001
Param Invalid
ブラックリストの認証用顔写真ファイルが大きすぎます。
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
削除に失敗しました。
No
従業員ID
mobile
string
No
携帯電話番号
string
No
メールアドレス
icNumber
string
No
IC カード番号
idNumber
string
No
ID カード番号（利用できません）
id
long
No
ブラックリストID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。
timestamp
string
Yes
タイムスタンプ
グループ情報。インターフェースから返された登録者数が 1 人のみの場合、グループ情報が含まれます。複数の登録者が返された場合、グループ情報は含まれません。
name
string
登録者名
avatar
string
登録者の認証用顔写真
mobile
string
携帯電話番号
ic_number
string
IC カード番号
id_number
string
IDカード番号（利用できません）
job_number
string
従業員ID
birthday
string
誕生日
string
メールアドレス
gender
string
性別。1 : 女性、2 : 男性
prompt
string
顔認証時に表示するカスタムメッセージ。
remark
string
備考
position
string
役職
location
string
場所
company_id
long
企業ID
department_id
long
部署ID
area_code
string
携帯電話番号の国別コードおよび市外局番
entry_time
string
入社日
receptionUserId
long
ビジター応対者の登録者ID
dateTimeFrom
datetime
来訪開始時間（秒単位）例 : 2018-07-20 12:30:45
dateTimeTo
datetime
来訪終了時間（秒単位）。例 : 2018-07-20 12:30:45
guest_company
string
ビジターの企業
guest_purpose
string
ビジターの来訪目的
guest_level
string
ビジターのレベル
create_at
string
作成時間
update_at
string
更新時間
パラメーター名
型
必須
説明
avatarFile
file
No
認証用顔写真。4MB以下の写真を利用してください。
force
int
No
強制追加するかどうか。デフォルトで0 : 強制ではない、1 : 強制
groups
パラメーター名
型
説明
id
long
従業員ID
name
string
従業員名
avatar
string
認証用顔写真
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。登録者名の長さが無効です。
30001
Param Invalid
無効なパラメーターです。登録者名が空です。
30001
Param Invalid
無効なパラメーターです。登録者IC 番号が空です。
30001
パラメーター名
型
必須
説明
id
int
Yes
変更する従業員ID の情報。タイプは path で、URL に記述されます。
avatarFile
file
No
従業員の認証用顔写真
force
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
パラメーター名
型
説明
id
long
従業員ID
name
string
従業員名
avatar
string
従業員の認証用顔写真
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。
30002
Similar User Exist
類似する従業員がすでに存在します。
50001
RPC FAILED
RPCに失敗しました (顔の検知に失敗したなど)
50002
パラメーター名
型
必須
説明
id
long
Yes
従業員のID。タイプは path で、URL に記述されます。
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
name
string
Yes
ビジター名。長さ制限は 45。
avatarFile
file
Yes
認証用顔写真
mobile
パラメーター名
型
説明
id
long
従業員ID
name
string
従業員名
avatar
string
従業員の認証用顔写真
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。ビジター名の長さが無効です。
30001
Param Invalid
無効なパラメーターです。ビジター名が空です。
30001
Param Invalid
無効なパラメーターです。ビジターのID 番号の長さが無効です。
30001
パラメーター名
型
必須
説明
id
long
Yes
ビジターID
name
string
Yes
ビジター名。長さ制限は 45。
avatarFile
パラメーター名
型
説明
id
long
ビジターID
name
string
ビジター名
avatar
string
ビジターの認証用顔写真
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
long
グループタイプ
code
メッセージ
説明
30001
Param Invalid
ビジターが存在しません。
30001
Param Invalid
ビジターが企業に属していません。
30001
Param Invalid
無効なパラメーターです。ビジター名の長さが無効です。
30001
パラメーター名
型
必須
説明
id
long
Yes
ビジターID。タイプは path で、URL に記述されます。
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
code
メッセージ
説明
30001
Param Invalid
ビジターが存在しません。
30001
Param Invalid
ビジターが企業に属していません。
50001
RPC FAILED
ビジターを削除するためのRPCに失敗しました。
パラメーター名
型
必須
説明
avatarFile
file
No
認証用顔写真
name
string
Yes
名前。長さ制限は 45。
groups
パラメーター名
型
説明
id
int
ブラックリスト ID
name
string
ブラックリスト名
avatar
string
認証用顔写真 ID
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
498
Param Invalid
電話番号はシステム内に存在しています。
498
Param Invalid
ID カード番号はシステム内に存在しています。
498
Param Invalid
IC カード番号はシステム内に存在しています。
498
パラメーター名
型
必須
説明
userId
long
Yes
従業員またはビジターのID
groupIds
list<long>
Yes
ブラックリストのグループID リスト。空の場合はブラックリストグループには追加されません。
app_key
code
メッセージ
エラーの説明
498
Param Invalid
ブラックリストが存在しません。
498
Param Invalid
無効な登録者タイプです (ブラックリストに移動中で、従業員でもビジターでもありません)
700
Multi Request Error
ブラックリストとグループの連携に失敗しました。
700
パラメーター名
型
必須
説明
id
long
Yes
ブラックリストのID
app_key
string
Yes
Appキー
sign
code
メッセージ
エラーの説明
498
Param Invalid
登録者タイプが正しくありません。ブラックリストの元の識別子が従業員またはビジターではないため、ブラックリストから外すことができません。
498
Param Invalid
登録者タイプが正しくありません。ブラックリストには元の識別子が無いため、ブラックリストから外すことができません。
パラメーター名
型
必須
説明
id
long
Yes
ブラックリストユのID
areaCode
string
No
国別コードおよび市外局番
avatarFile
パラメーター名
型
説明
id
int
ブラックリスト ID
name
string
従業員名
avatar
string
認証用顔写真 ID
mobile
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
498
Param Invalid
ブラックリストID が存在しません。
498
Param Invalid
電話番号はシステム内に存在しています。
498
Param Invalid
ID カード番号はシステム内に存在しています。
498
パラメーター名
型
必須
説明
id
long
Yes
ブラックリストのID
app_key
string
Yes
Appキー
sign
code
メッセージ
エラーの説明
498
Param Invalid
ブラックリストID が存在しません。
600
Sync Failed
リモート削除に失敗しました。
700
Multi Request Error
ブラックリストとグループの連携解除に失敗しました。
50001
パラメーター名
型
必須
説明
type
int
No
登録者の識別子タイプ。1 : 従業員、2 : ビジター、5 : ブラックリストです。情報が渡されなかった場合、すべてのリストが返されます。
name
string
No
登録者名
jobNumber
パラメーター名
型
説明
id
long
登録者ID
type
int
識別子タイプ。1 : 従業員、2 : ビジター、3 : 不明、4 : 非生体、5 : ブラックリスト
last_type
int
元の識別子。ブラックリストの登録者にのみ適用されます。1 : 従業員、2 : ビジター
groupList
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
code
メッセージ
エラーの説明
30001
Param Invalid
無効なパラメーターです
list<long>
string
Param Invalid
int
string
Internal Server Error
string
string
string
Param Invalid
file
string
Param Invalid
string
list<long>
string
Param Invalid
string
Multi Request Error
string
file
string
Param Invalid
string
RPC FAILED
string
list<group>
{
"code": 200,
"message": "OK",
"data": {
"id": 65838,
"name": "1312313123123122",
"avatar": "5cbe78b135060d0001750ef5",
"mobile": "",
"remark": "",
"type": 1,
"birthday": "",
"mail": null,
"position": null,
"location": null,
"groupList": [
{
"id": 1,
"name": "Default group",
"type": 1
}
],
"gender": 1,
"prompt": "",
"ic_number": "",
"id_number": "te9+d6aXoDe5zTCUywgn9+zmx4HElB4W",
"job_number": "",
"company_id": 1,
"create_at": "2019-04-23 10:30:08",
"update_at": "2019-04-23 10:30:08",
"department_id": 0,
"area_code": null,
"entry_time": "2018-9-10"
}
}{
"code": 30002,
"message": "Similar User Exist",
"data": {
"similar_user_id": 65833,
"similar_user_name": "11111111",
"similar_user_avatar": "5cbe7dec35060d0001750f15",
"can_force": 0
},
"desc": "ex.similar-user"
}{
"code": 200,
"message": "OK",
"data": {
"id": 79653,
"name": "1312313123123122",
"avatar": "",
"mobile": "123",
"remark": "",
"type": 1,
"birthday": null,
"mail": null,
"position": null,
"location": null,
"groupList": [{
"id": 1,
"name": "Default group",
"type": 1
}],
"gender": null,
"prompt": null,
"ic_number": "1234000",
"id_number": null,
"job_number": "120003",
"company_id": 1,
"create_at": null,
"update_at": "2019-08-22 11:03:18",
"department_id": null,
"area_code": null,
"entry_time": null,
}
}{
"code": 200,
"message": "OK"
}{
"code": 200,
"message": "OK",
"data": {
"id": 79661,
"name": "zml",
"avatar": "5d5e36e4f684640001b34027",
"mobile": "123",
"remark": "",
"groups": [],
"position": null,
"level": null,
"mail": null,
"birthday": null,
"prompt": null,
"gender": null,
"ic_number": "",
"id_number": "kBDHQ/IUQtY=",
"company_id": 1,
"reception_user_id": 4567,
"reception_user_name": "太朗",
"group_count": 0,
"date_time": "2018-07-20 12:30:45.0",
"date_time_from": "2018-07-20 12:30:45.0",
"date_time_to": "2020-07-20 12:30:45.0",
"create_at": "2019-08-22 14:32:04.0",
"update_at": "2019-08-22 6:32:04.0",
"area_code": null,
"guest_company": null,
"guest_purpose": null
}
}{
"code": 200,
"message": "OK",
"data": {
"id": 124379,
"name": "zml",
"avatar": "5dad624c199e160001c45e8f",
"mobile": "123",
"remark": "",
"groups": [{
"id": 14,
"name": "Default group",
"type": 2
}],
"position": "",
"level": "",
"mail": "",
"birthday": null,
"prompt": "",
"gender": 2,
"ic_number": "",
"id_number": "kBDHQ/IUQtY=",
"company_id": 12,
"reception_user_id": 124794,
"reception_user_name": "太朗",
"group_count": 1,
"date_time": "2018-07-20 12:30:45",
"date_time_from": "2018-07-20 12:30:45",
"date_time_to": "2020-07-20 12:30:45",
"create_at": "2019-10-21 15:51:28",
"update_at": "2019-10-30 20:45:05",
"area_code": "86",
"guest_company": "",
"guest_purpose": ""
}
}{
"code": 200,
"message": "OK"
}{
"code": 200,
"message": "OK",
"data": {
"id": 66865,
"name": "張三",
"avatar": "5d084f23b2814100015ad03c",
"mobile": "13655588555",
"mail": "[email protected]",
"birthday": "2019-06-11",
"remark": "demo",
"groups": [
{
"id": 126,
"name": "デフォルトブラックリスト",
"type": 3
},
{
"id": 127,
"name": "2",
"type": 3
}
],
"prompt": "ようこそ",
"gender": 0,
"createBy": "OPEN API",
"avatar_show": "",
"ic_number": "",
"id_number": "1545557788555",
"area_code": "86",
"last_type": 0,
"create_at": "2019-06-18 02:40:35.0"
}
} {
"code": 200,
"message": "OK",
}{
"code": 200,
"message": "OK",
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 124759,
"name": "668089",
"avatar": "5dba86ff7bf01300010b02c9",
"mobile": "",
"mail": "",
"birthday": "",
"remark": "",
"groups": [{
"id": 15,
"name": "Blacklist default group",
"type": 5
}],
"prompt": "",
"gender": 2,
"avatar_show": "",
"ic_number": "",
"id_number": "3O8bqu0sRiKA7+LVRzE3eQ==",
"area_code": "86",
"last_type": 0,
"create_by": "admin1234",
"create_at": "2019-10-23 17:28:19"
}
}{
"code": 200,
"message": "OK",
}{
"code": 200,
"message": "OK",
"data": [
{
"id": 67015,
"name": "太朗",
"avatar": "5d0afdde1870ac00019ffffd",
"mobile": "1882960772",
"remark": "",
"type": 1,
"birthday": null,
"mail": "",
"position": "",
"location": "",
"groupList": [
{
"id": 1,
"name": "Default group",
"type": 1
}
],
"gender": 1,
"prompt": "",
"ic_number": "",
"id_number": "",
"job_number": "",
"company_id": 1,
"create_at": "2019-06-20 03:30:37.0",
"update_at": "2019-06-20 03:30:38.0",
"department_id": 0,
"area_code": "86",
"entry_time": null,
"country_code": null,
"place_code": null,
"staff_type": 0,
"reception_user_id": 0,
"date_time_from": "2017-01-01 00:00:00.0",
"date_time_to": "2017-01-01 00:00:00.0",
"avatar_show": null,
"phone_suffix": "",
"guest_company": null,
"guest_purpose": null,
"guest_level": null,
"add_time": "2019-06-20 03:30:38.0",
"guest_auth_status": 1,
"last_type": 0
}
]
}