このページのみ全てのページ
GitBook提供
1 / 43

SenseLink Cloud 日本語版

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...

ユーザーマニュアル

SenseLink Cloudの利用方法について記載されています。

本マニュアルでは、言語設定が日本語の前提で用語や図が記載されています。その他の言語を設定してご利用になる場合は、用語や図の内容が異なる場合があります。その際は適宜読み替えてご利用ください。

イントロダクション

ビルディングアクセスソリューションおよびAI温度検知ソリューションは、管理者のアクセス管理の負担を軽減し、よりセキュアで快適なアクセスを可能にする日本コンピュータビジョン株式会社(以下、JCV)の顔認証ソリューションです。本ソリューションは顔認証サービスを通じて、受付、入退室管理、勤怠管理など、様々の利用シーンにおいてセキュリティ強化と利便性の向上に貢献します。また、豊富な管理者向け機能を持っており、既存のアクセス管理システムと柔軟に連携できます。

SenseLinkはビルディングアクセスソリューションおよびAI温度検知の管理プラットフォームで、SenseLink Cloud、SenseLink GE Enterprise 、SenseLink GE Enterprise Pro の3つのモデルを提供しています。 

ここでは、各モデルでご利用いただくマニュアルを提供しています。本マニュアルは「SenseLink Cloud」のマニュアルです。モデルの切り替えは画面左上の「SenseLink Cloud 日本語」をクリックし、対象のモデルとバージョンを選択してください。

マニュアルは改訂される場合があります。詳細は各マニュアルの改訂履歴ページを参照してください。

既知の不具合

最新バージョンV2.6.10の対応状況について説明します。

<本バージョンでの既知の不具合内容>

  • iPhoneで撮影した表示写真はデバイスで顔認証する際に、横方向で表示することがあります。

  • SenseLink上でSenseThunder-Eのデバイス設定をデフォルトに戻した場合、設定欄が空白になることがあります。

  • SenseLink上でSenseThunder-Eのデバイス設定名を正しく表示できないことがあります。

  • TIF写真をモバイル端末からアップロードする際に不具合が生じることがあります。

  • 表示写真をアップロードした後に正常に表示できないことがあります。

  • 複数登録により、GIF/BMP/TIF写真をアップロードできないことがあります。

  • 顔写真品質チェックレベル、プロジェクト選択のプルダウンメニューに表示不具合があります。

  • /api /v3 /recognition/qualityにより返される説明メッセージは実際の写真と異なることがあります。

モバイルページユーザーマニュアル

モバイル端末から、SenseLink Cloudの利用方法について記載されています。

​本マニュアルでは、言語設定が日本語の前提で用語や図が記載されています。その他の言語を設定してご利用になる場合は、用語や図の内容が異なる場合があります。その際は適宜読み替えてご利用ください。

改修履歴

日付

改訂内容

2021/04/08

  • 初版

2022/09/28

  • 4 顔写真のセルフ登録 を追加

1 概要

モバイル端末からSenseLink Cloudへアクセスの概要について記載されています。

SenseLink Cloudは、以下のモバイルOSとブラウザで接続してご利用いただけます。ここに記載されていないモバイルOSとブラウザはサポートしていません。モバイルOSやブラウザによって、一部利用できる機能やSenseLinkと共有するデータが異なります。

この情報は本マニュアル発行時点のものであり、将来的に追加・変更が発生する可能性があります。

SenseLink Cloud V2.6.10

  • サポートモバイルOS

    • iOS - 最新バージョン

    • アンドロイド - 最新バージョン

  • サポートモバイルブラウザ

    • Safari - 最新バージョン

    • Chrome - 最新バージョン

  • サポート機能

    • 従業員管理

2 APIリファレンス

各APIの利用方法の詳細について記載されています。

2.1 システムのAPI2.2 デバイスの API2.3 デバイスアラートの API2.4 登録者のAPI2.5 登録者グループの API2.6 アクセスルールAPI2.7 レコードの API2.8 認証用顔写真の API2.9 部署の API2.10 イベントサブスクリプション API2.11 認証レコード+API

​

APIマニュアル

APIの利用方法について記載されています。

本マニュアルはIT部門に所属するお客様、HTTP/HTTPSベース、JSON形式のWeb APIを利用したアプリケーションの開発・運用経験があるお客様を対象にしています。

リリースノート

SenseLink Cloudのリリースノートをご確認いただけます。

アップデート実施スケジュールはステータスダッシュボードにてお知らせしています。

日付

バージョン番号

リリースノート

2020/07/01

V2.3.2 (36)

β版限定・先行リリース

2020/07/19

V2.3.3 (41)

  • ToolKitの廃止 従業員複数登録、複数修正をWebUIから実施に変更

  • 従業員の複数削除機能の追加

  • 新しいアカウントロールの追加

    • Device Login Admin

    • Personnel Admin

    • Recognition Records Admin

  • 認証レコードの個別削除機能の追加

  • サポートデバイスを追加

    • SensePass GE V1.2.3

2020/08/20

V2.3.4(105)

  • 契約プランごとの機能制限を開始

    • レコード保持期間の上限

    • 認証登録者数の上限

  • 契約プランおよび各種上限を確認する [契約プラン] メニューの追加

  • OTA機能の追加

    • アプリ・ファームウェアのアップデート方法や対象デバイスの設定機能

    • アップデートタスクの進捗と履歴管理機能

2020/10/15

V2.3.6(180)

  • ログインページでのパスワードリセット機能の追加

  • 認証レコードの個別削除機能の追加

  • ビジネスプラン管理の中でテナントごとの機能権限の追加

  • 異常なイベントをフィルタリングする設定機能をオープンプラットホームのイベントサブスクリプションに追加

    • 異常認証レコード

    • デバイスアラーム

  • OTA差分更新機能の追加

  • SenseLinkユーザーシステムでAPK / ROMの有効化/無効化設定機能の追加

  • SenseThunder-E / SenseThunder-Mini温度検出用の日本語音声ファイルの追加

  • 一部デリケートな用語を置き換え

    • ブラックリスト→拒否リスト

    • ホワイトリスト→許可リスト

  • Open APIの改善

    • ユーザーリストを取得するAPIにグループIDと部門IDのリクエストパラメータを追加

    • 認証レコードを取得するAPIの性能改善

  • エクスポート機能の改善

    • 既存のエクスポートタスクがある間にファイルをエクスポートできないように

    • 出力フォーマットを.xlsxに変更

  • パスワード強度の要件の強化

  • 顔写真のセキュリティの向上

  • プラス("+")文字を含む有効なメールアドレスを受け入れるように変更

2020/12/3

V2.3.7(238)

  • OTA機能(ファームウェア管理)の刷新

  • レコード削除方式の変更(温度ダッシュボードの統計データに影響しない仕様に)

  • パスワードリセット画面の最短間隔30秒を追加

  • デバイス設定項目名称の修正

  • ビジネスプラン変更機能を追加

  • ダッシュボード設定項目の記憶機能を追加

2020/12/24

V2.3.8(276)

  • OTA機能(アプリケーション管理)の刷新

  • レコード削除方式の変更(デフォルトダッシュボードの統計データに影響しない仕様に)

  • アカウント別のMFA有効/無効化機能を追加

  • へのリンク追加

  • 温度表示を小数点以下1桁の変更

2021/01/28

V2.3.9(321)

  • デバイスリスト機能の改善

    • UI画面の改善

    • エクスポート機能、アクセス設定(一括)機能、勤怠設定(一括)機能を追加

2021/04/08

V2.4.0(382)

  • SenseLinkアクセスコントロール機能を追加

    • 「アカウント」を「ユーザー」に変更

    • デバイス権限を管理する「プロダクト」機能と画面を追加

    • 登録者権限を管理する「グループ」権限をユーザー画面に追加

  • モバイル端末からアクセス時の解説ページを追加

  • 温度ダッシュボードでの音声メッセージタイプ選択機能を追加

  • イベントサブスクリプション機能に複数エンドポイント設定できるように変更

2021/05/12

V2.5.0(414)

  • サーバー側での顔認証(Server FR)機能と1対Nの顔検索APIを一部のお客様向け先行リリース

  • 認証用顔写真品質の検出の新規APIを追加

  • SenseNebulaのサポートを開始

2021/06/02

V2.5.1(450)

  • 認証用顔写真品質レベル「厳格」を追加

  • アカウント有効期限の事前通知期間を更新

  • 認証用顔写真品質の検出APIを更新

2021/06/30

V2.6.1(493)

  • デイバイス情報の表示項目を追加

  • 登録者(従業員、ビジター)の新規登録項目を追加

  • システムの設定項目を追加

  • 契約プランの表示項目を追加

2021/11/15

V2.6.4(628)

  • IPアドレス制限機能を追加

  • デバイス側顔認証とサーバー側顔認証の切り替え機能を追加

  • 写真取得APIを追加

  • 似ている人の登録API新バージョンを公開

  • アカウントの命名ルールを改善

2022/1/26

V2.6.5(741)

  • ログイン画面のデザインを変更

  • UI/UXバグを修正

2022/2/25

V2.6.6(742)

  • 基盤の安定性向上 (新機能・機能変更はありません)

2022/3/23

V2.6.7(786)

  • Thunder Attendanceに対応

  • SensePass/SenseThunderからの顔属性情報への対応

  • 登録者認証レコード画面の追加

  • Personnel Record Admin 管理者ロールの追加

  • デバイス設定の日本語表記を一部修正

2022/5/18

V2.6.8(820)

  • 従業員認証用顔写真の複数修正機能のバグ修正

  • 従業員、ビジター、拒否リストの各設定に日本語文字列を入力する際、英数字と同じ文字数が入力できるように変更

2022/6/15

V2.6.8(821)

  • オペレーションログの負荷緩和

2022/8/17

V2.6.9(851)

  • デバイスログのリモート送信機能のサポート

  • デバイスの設定取得・変更APIの追加

2022/9/28

V2.6.10(883)

  • 従業員の顔写真セルフ登録機能の追加

2022/11/29

V2.7.0(901)

  • 認証レコードを記録するAPIとそのレコードを表示するUI(認証レコード+)を実装

  • 限定したAPIのみを実行するAppキー作成機能を追加

  • デバイスリストの表示APIの新バージョンを追加

  • API の呼び出し書式を厳密に確認するように動作を変更(後述)

2022/12/8

V2.7.0(902)

  • API の呼び出し書式の厳密チェックを削除(後述)

SenseLink Cloud V2.7.0 (901) 更新のタイミングで、APIの呼び出し書式の厳密な確認が入った影響により、過去バージョンで許容されていた ダブルスラッシュが入った書式が動作しなくなりました(https:// 部分を除く)。

例 "https://link.japancv.co.jp//api/v3/server/version?app_key={{app_key}}&timestamp={{current_timestamp}}&sign={{sign}}"

本チェック機構はSenseLink Cloud V2.7.0(902) 更新により、削除いたしました。

7 部署

従業員を階層別にまとめて管理する、部署管理機能について記載しています。

Super Adminのみが部署の新規追加・修正・削除することができます。

7.1 部署の新規追加

部署情報を登録すると、で、所属の従業員を一括で従業員グループへ登録することができます。

新しい部署を追加するには、ナビゲーションメニューの[登録者タイプ]→[従業員管理]をクリックし、従業員一覧を表示してください。画面左側に表示している会社名の右にある「+」アイコンをクリックすると、部署登録画面が表示されます。

このボックスで部署名の情報を入力してください。部署責任者欄では、登録者の氏名を入力して登録者の検索を行うことができます。検索結果から登録したい部署責任者のチェックボックスを選択してください。なお、この欄は任意の入力項目となっており、設定しなくても認証機能や従業員管理機能に支障が発生しません。

部署責任者に設定しても、その登録者が自動的に該当部署へ登録することはできません。の手順に従い、部署を登録してください。

注意事項: 1つの部署につき、部署責任者は1名しか設定できません。 1名の従業員につき、所属部署は1つしか設定できません。

必要な情報を入力した後、保存ボタンをクリックして登録を完了してください。登録済の部署の下位に、部署を登録することができます。そうすることで、組織内の階層化情報を登録できます。

7.2 部署情報の修正

既存の部署情報を修正することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]をクリックし、従業員一覧を表示してください。修正する部署の右側にあるペンアイコンをクリックすると、部署更新画面が表示されます。

上位部署をクリックすると、既存の部署階層が表示されます。更新後の上位部署を選択してください。

修正内容を入力し、保存をクリックしてください。

7.3 部署の削除

登録されているが従業員が登録されていない部署を削除することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]をクリックし、従業員一覧を表示してください。削除する部署の右側にある「-」のアイコンをクリックしてください。

従業員が登録されている部署を削除しようとすると、「従業員が登録されている部署は削除できません」のエラーメッセージが表示され、削除できません。

従業員が登録されていない部署を削除する場合、「この操作は取り消しできません。削除しますか?」というメッセージが表示されます。確定ボタンをクリックして、削除を完了させてください。

15 エラーメッセージ

エラーメッセージについて記載されています。

付録B FAQ

Q1:SenseLink Cloudを利用するPCに必要なハードウェアスペックを教えてほしい。 A1:推奨するWebブラウザが利用できるのであれば、PCのハードウェアスペックについては、特に制約はありません。推奨Webブラウザについては、を参照してください。

Q2:SenseThunderで発生したアラートを、SenseLink Cloudやスマホで受信・確認することは可能か。 A2:アラートを確認する方法はSenseLinkのダッシュボード画面だけです。メール等へ通知する機能はありません。

Q3:iPadからSenseLink Cloud にログインし、操作することは可能か。 A3:iPadからの利用も可能です。利用時には推奨Webブラウザをお使いください。

Q4:SenseLinkのダッシュボードに表示されている各種情報の配置(画面レイアウト)は変更可能か。 A4:各種情報の画面レイアウトの変更はできません。

Q5:SenseLink Cloudにおける顔認証登録数は制限なしか、それとも上限数はあるのか。 A5:クライアント側での認証登録者数は「Basic Basic Annual Subscription」では最大5人、「Professional Basic Annual Subscription」では最大50,000人となっています。追加オプションの「Cloud ID Pack Annual Subscription」利用時は、サーバー側の顔認証機能の利用で最大100万人の認証が可能です(1テナントあたりの人数)。

Q6:SenseLink Cloud内に保存される、顔写真付きの温度検知結果画像のサイズはどれくらいの大きさなのか。 A6:1画像あたり720✕1,280ピクセルです。

Q7:ある従業員に対して、複数の異なる勤務ルールを割り当てることはできるのか。 A7:1人1勤怠ルールとなっており、複数の異なる勤務体系を1人に割り当てることはできません。

Q8:SenseLinkのログイン状態を維持し続けることは可能か。 A8:ログイン後、1時間経過すると自動的にセッションタイムアウトとなります。 ただし、ダッシュボードを表示している間、セッションは維持されます。

Q9:ログイン時の2段階認証を解除することは可能か。 A9:解除可能です。Super Admin ユーザーの解除をご希望される場合は、JCVサポート窓口までご連絡ください。Super Admin 以外のユーザーについては、をご参照ください。

Q10:SenseLinkのダッシュボード画面に、複数台のSenseThunderの情報を表示することはできるか。 A10:情報を表示できるのは、接続されている1台だけです。

Q11:誤ったIP制限の設定を行い、Super Adminがログインできなくなった A11:JCVサポート窓口までご連絡ください。

その他のFAQについては、「」をご参照ください。

付録A ユーザーの権限明細

ユーザーの権限について記載されています。

権限明細一覧

権限一覧表はからダウンロードしてください。

エラーメッセージ

原因・説明

データ読み込みに失敗しました。更新して、もう一度お試しください。

WebブラウザがSenseLinkからデータをロードすることに失敗しました。Webブラウザを更新して再度データをロードしてください

この操作を続けることができません。

誤った操作が行われたため、操作を続けることができません。不正なデータや操作を停止してから、改めて操作してください

写真アップロードエラー

認証用写真や表示写真などのアップロードでエラーが発生しました。正しい規格の画像ファイルをアップロードしてください

StatusPage
こちら
こちら
JCVお問合せ窓口/SenseLink FAQ
こちら
8.5節 グループへの登録
6.6章 登録者情報の修正:個別修正
部署の登録
部署登録画面
部署の修正
部署更新画面
上位部署設定
部署の削除

3 ログインとログアウト

SenseLinkへのログインとログアウトについて記載しています。

全ての初期パスワードを変更することを推奨します。

3.1 ログインページへのアクセス

ご利用中のPCをインターネットに接続、Webブラウザを起動し、https://link.japancv.co.jp/loginへアクセスしてください。ログインページが表示されます。 推奨ブラウザはGoogle Chrome、Mozilla Firefox 、Safari(MacOS)、Microsoft Edgeです(それ以外のブラウザ、およびモバイル端末では動作保証しておりません)。

SenseLink Cloudトップページ

ログインページで、アカウントとパスワードを入力してください。

  • Super Adminアカウントのユーザー

    • ユーザー登録申請書にて運用担当者として申請いただいた方 初期アカウント/パスワードは、[email protected]から発信されるアカウント発行通知メールで連絡しています。

    • アカウントアクティベーションにてアカウント発行した方 初期アカウント/パスワードは、アクティベーションページからご自身で設定しています。

  • その他のユーザー その他のユーザーは貴社Super AdminおよびSub Adminのユーザーが、ユーザー管理機能を利用して発行できます。[email protected]から発信されるユーザー発行通知メールに記載されたアカウントとパスワード、またはユーザーを発行したご担当者様から連絡されたアカウントとパスワードを利用してください。

[email protected]からのメールを受信できるよう、また迷惑メールフォルダに振り分けられないよう、ご利用のメールサービスの設定をご確認ください。

パスワードを忘れてしまった場合 「パスワードをお忘れですか?」をクリックしてください。表示された画面でアカウントを入力して「再開」ボタンを押すと、ユーザーと紐づけているメールアドレスにパスワードをリセットするためのリンクが記載されたメールが送信されます。 リンクをクリックすると表示される画面で新しいパスワードを登録してください。 なお、リンクは24時間で期限切れになります。また、一度開いた場合にも期限切れになります。

メールで認証コードを取得する

アカウントとパスワードを入力してログインボタンをクリックすると、認証コード入力画面が表示されます。メールで認証コードを取得する場合、「認証コード取得」ボタンをクリックしてください。登録されたメールアドレスに認証コードが送信されます。

認証コード入力画面に受信した認証コードを入力し、適用ボタンをクリックしてください。SenseLinkにログインすることができます。 

SMSで認証コードを取得する

メールアドレス以外に、登録した携帯電話番号にSMSで認証コードを送信することができます。認証コード入力画面で「SMSで認証コードを受信」をクリックしてください。

SMSによる認証コード送信画面へ切り替わります。メールと同様に認証コード取得ボタンをクリックし、登録した携帯電話番号に送信される認証コードを確認してください。

認証コードを入力画面で入力し、適用をクリックしてください。これにより、SenseLinkにログインできます。

SMSやメールで認証コードが受信できない場合、メールまたはSMSに切り替えて認証コードが受信できるかを確認してください。SMS、メールどちらでも認証コードが受信できない場合、登録情報の修正が必要です。 ご利用中のユーザーがSuper Adminの場合は、「Super Admin」であることを添えてJCVサポート窓口へご連絡ください。 それ以外のユーザーをご利用中の場合は、Super AdminまたはSub Adminユーザーを持つ貴社のシステム管理者にご連絡ください。

ログインするPCのタイムゾーンに日本時間(JST)以外が設定されていたり設定時刻が大幅にずれている場合、ログイン直後に「セッションエラー」のメッセージが表示され、ログイン画面に遷移する場合があります。その場合は、ご利用のPCの時刻およびタイムゾーン設定をご確認ください。

3.3 初期パスワードの変更

Super Admin以外のユーザーでログインした場合、初回ログイン時のパスワードの変更を求められます。必ず変更を行なってください。

パスワードは8文字から20文字の間で設定してください。 大文字英字(A〜Z)、小文字英字(a〜z)、数字(0〜9)、記号(~!@#$^*0_+)から、各1文字ずつの設定が必要です。

3.4 初回ログイン時のシステム設定

Super AdminユーザーまたはSub Adminユーザーは初回ログイン時、システム管理メニューのシステム設定よりレコードの設定を行ってください。詳細な利用方法と手順は、12.2節 システムの設定をご参照ください。

3.5 ログアウト

セキュリティ向上のためにSenseLinkの利用後は、必ず以下のログアウトの手順を実施してSenseLinkからログアウトしてください。

SenseLinkの画面右上部に表示されるユーザー名をクリックしてください。

ユーザー名のクリック

プルダウンメニューの項目に「ログアウト」が表示されます。ログアウトをクリックして、ログアウトしてください。

1 製品概要

当製品の概要について記載されています。

1.1 サポート顔認証デバイス

SenseLink Cloudは、以下の顔認証デバイスとバージョンと接続してご利用いただけます。ここに記載されていない顔認証デバイスはご利用いただけません。デバイスやバージョンによって、一部利用できる機能やSenseLinkと共有するデータが異なります。

この情報は本マニュアル発行時点のものであり、将来的に追加・変更が発生する可能性があります。

  • SenseThunder-E

    • SenseThunder-E GE V1.1.3

    • SenseThunder-E GE V1.1.5

    • SenseThunder-E GE V1.1.7

    • SenseThunder-E GE V2.3.1

    • SenseThunder-E GE V2.3.4

    • SenseThunder-E GE V2.3.5

    • SenseThunder-E GE V2.4.1

    • SenseThunder-E GE V2.5.1

  • SenseThunder-Mini

    • SenseThunder-Mini GE V1.0.3

    • SenseThunder-Mini GE V1.0.7

    • SenseThunder-Mini GE V1.0.9

    • SenseThunder-Mini GE V1.1.1

    • SenseThunder-Mini GE V1.1.3

    • SenseThunder-Mini GE V1.1.7

    • SenseThunder-Mini GE V2.3.1

    • SenseThunder-Mini GE V2.3.4

    • SenseThunder-Mini GE V2.3.5

    • SenseThunder-Mini GE V2.4.1

    • SenseThunder-Mini GE V2.5.1

  • SenseThunder-Air

    • SenseThunder-Air GE V2.2.1

    • SenseThunder-Air GE V2.3.4

    • SenseThunder-Air GE V2.3.5

    • SenseThunder-Air GE V2.4.1

    • SenseThunder-Air GE V2.5.1

  • SensePass

    • SensePass GE V1.2.3

      一部機能(ビジター管理および認証、拒否リスト管理および認証、ルール管理、勤怠管理、デバイスアラート管理)に対応していません。

    • SensePass GE V1.2.5

    • SensePass GE V2.3.1

    • SensePass GE V2.3.4

    • SensePass GE V2.3.5

    • SensePass GE V2.4.1

    • SensePass GE V2.5.1

  • JCV Pass CS

    • JCV Pass CS V3.3.5

  • SenseNebula

    • SenseNebula-AIE Basic V2.1.2

1.2 セキュリティ関連情報

安全にご利用いただくために

  • 通常のSenseLinkの運用・管理にはSuperAdminアカウントは利用せず、適切な権限レベルのアカウントを使用してください。

  • 管理者用アカウントは、SenseLinkの運用や各種設定、ユーザー登録など、重要情報へのアクセス時に利用されます。そのため管理者アカウントのパスワードは、第三者に推測されにくいものを使用してください。

  • パスワードの生成方法は、ランダム生成とデフォルトパスワード生成の2つの方法を提供しておりますが、より安全にご利用いただくために、ランダム生成の利用を強く推奨します。

  • 管理者アカウントは厳重に管理し、アカウントの悪用などを防ぐといった対応をお願いします。

1.3 外国企業が提供するサービスについて

日本コンピュータビジョン株式会社が提供するCloudサービスにおいては、サイバー攻撃からの保護および不正アクセス防止を目的として、Cloudflare社(米国)、およびTwilio社(米国)、Google社(米国)が提供するサービスを利用しております。

Cloudflare社(米国) Webサイト保護のためのセキュリティサービス Twilio社(米国)   ログイン認証強化のためのメール送信およびSMS送信サービス Google社(米国)  不正アクセス防止のためのreCAPTCHAサービス

これらの企業のプライバシーポリシー、コンプライアンスについては、以下リンク先にてご確認いただけます。 弊社は、これらのサービスを利用するに伴い外国においてお客様の情報(弊社Cloudサービスへアクセスする際のIPアドレス情報、ログイン認証を行う際のメール送信先アドレスおよびSMS送信先番号など)を取り扱いますが、お客様が弊社Cloudサービス上に保存および取り扱う情報(顔認証情報などの個人データ、アプリケーションで取り扱う画像情報など)を外国で取り扱うことはありません。

また、弊社はその外国における個人情報保護に関する制度を把握した上で安全管理措置を実施します。この外国に関する情報提供を希望されるお客様は、JCVお問合せ窓口までお問い合わせください。

(Cloudflare社)プライバシーポリシー https://www.cloudflare.com/ja-jp/privacypolicy/ (Cloudflare社)コンプライアンスリソース https://www.cloudflare.com/ja-jp/trust-hub/compliance-resources/ (Twilio社)プライバシーポリシー   https://www.twilio.com/ja/legal/privacy (Twilio社)Twilioの信頼性   https://www.twilio.com/ja/trust (Google社)Google プライバシーポリシー   https://policies.google.com/privacy (Google社)コンプライアンス リソースセンター   https://cloud.google.com/security/compliance

8 登録者グループ

登録者を勤務地別、階層別など任意のグループにまとめて管理する登録者グループ管理について記載されています。

登録者グループ画面では、現在のユーザーが登録されている登録者グループのデータのみが表示されます。

2020年10月より、ブラックリスト機能を拒否リスト機能に改名しています。 SenseLink一部モデルや一部機能、および一部デバイスではブラックリスト(blacklist)という名称が残っている場合がございますが、当マニュアルでは拒否リストとして説明しています。適宜読み替えてご利用ください。

8.1 登録者グループとは

登録者を勤務地別階層別など任意のグループに分けて管理することができます。グループは顔認証デバイスと紐付けることで、ドアやゲート別のアクセス権限をグループ単位で管理できます。

1人の登録者は複数のグループに登録することが可能ですが、異なる登録者タイプのグループには登録できません。本章では従業員を例に、操作手順を記載します。ビジターや拒否リストの場合、それぞれのグループ名に読み替えて同様の手順を実施してください。

SensePass GE V1.2.3では、ビジターおよび拒否リストの顔認証をサポートしていません。ビジターおよび拒否リストグループのアクセスデバイスにSensePass GE V1.2.3を連携しても、顔認証は行えません。

8.2 グループの新規追加

新しいグループを追加できます。

ユーザーがグループを新規追加する場合、そのユーザーとSuper Adminのみが、グループへの閲覧・編集・削除・登録者追加を実行できます。他のユーザーに権限を付与するためには、Super Adminがユーザー管理画面で追加する必要があります。詳細は4.5.3節 ユーザーの修正と削除をご参照ください。

ナビゲーションメニューの[登録者タイプ]→[従業員グループ管理]をクリックし、従業員グループ一覧を表示してください。登録ボタンをクリックすると、グループ登録画面が表示されます。

グループ新規登録画面への遷移

グループ名とそのグループがアクセス可能なデバイスを入力し、保存をクリックして登録してください。グループに登録されたら、登録されたデバイスのみに顔認証データが連携されて顔認証を行うことができます。登録されないデバイスで顔認証を行なった場合、未登録者として認証されます。

グループ名は半角換算で30文字まで登録することができます。文字種の種類はありません。

8.3 グループ情報の修正

既存のグループ情報を修正することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員グループ管理]をクリックし、従業員グループ一覧を表示してください。修正するグループの右側にあるペンアイコンをクリックすると、グループ修正画面が表示されます。

グループ修正画面への遷移

修正内容を入力し、保存をクリックしてください。

8.4 グループ情報の削除

既存のグループを削除することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員グループ管理]をクリックし、従業員グループ一覧を表示してください。削除するグループの右側にある[削除]アイコンをクリックしてください。

グループの削除

「グループの登録のみ削除し、登録者情報は削除されません。グループにN人登録中です。削除しますか?」というメッセージが表示されます。確定ボタンをクリックして、削除を完了させてください(Nはグループの登録人数によって異なります)。

グループ情報を削除しても登録者は当該のグループへの登録が解除されるだけで、登録した各種情報は削除されません。

8.5 グループへの登録

グループに登録者を登録することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員グループ管理]をクリックし、従業員グループ一覧を表示してください。登録したいグループを選択して登録者一覧を表示し、グループへ登録ボタンをクリックしてください。

登録者のグループ登録画面への遷移

登録者のグループ登録画面が表示されます。

登録者のグループ登録画面

画面の左側にある選択欄で、登録者の氏名または部署を入力して登録者の検索を行うことができます。検索結果から登録したい登録者のチェックボックスを選択して、登録ボタンをクリックしてください。登録者が画面の右側にある選択済欄に表示されます。 同様の手順で登録したい登録者を選択済にして、確認ボタンをクリックしてください。グループに登録者が登録されます。

登録者のグループへの登録

8.6 グループからの削除

登録者が登録されているグループから、その登録者を削除することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員グループ管理]をクリックし、従業員グループ一覧を表示してください。削除したいグループを選択し、そのグループの登録者一覧を表示してください。削除したい登録者のチェックボックスを選択し、複数削除ボタンをクリックするとグループから登録者が削除されます。

登録者は当該のグループから登録が解除され、登録情報自体は削除されません。

9 アクセス

登録者グループやデバイスごとに、認証の期間や時間帯の設定を行うルール管理について記載されています。

アクセス画面では、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。

9.1 アクセスとは

登録者グループやデバイスごとに設定可能な認証の期間や時間帯を「アクセスルール」といいます。

例えば「年末年始に特定のグループに特定のドアに設置されるデバイスのみで認証やアクセスを許可したい」など、様々なアクセスルールを設定することができます。。

SensePass GE V1.2.3では、ルール管理機能勤怠管理はサポートされません。

アクセスルールを利用する場合は、バージョン 2.3.5 以降がインストールされたSensePass/SenseThunderシリーズ(Mini/Air/E)をご利用ください。

バージョン 1.1.7 以前での動作はサポートされません。

9.2 アクセスタイムテーブルの登録

アクセスを許可するタイムテーブルを管理することができます。

ナビゲーションメニューの[アクセス]→[アクセスタイムテーブル]をクリックし、アクセスタイムテーブルの一覧を表示してください。登録ボタンをクリックし、アクセスタイムテーブル登録画面を表示してください。

アクセスタイムテーブル登録画面までの遷移
タイムテーブル登録画面

タイムテーブル欄にタイムテーブル名を入力してください。入力可能な文字は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号です。1~30文字(半角換算)で入力してください。

有効日付欄の開始日と終了日をそれぞれクリックし、このアクセスタイムテーブルを有効にする期間を指定してください。

月曜日〜祝日の各欄では、各曜日および祝日のアクセスを許可する時間帯の設定を行います。

各曜日の右側にあるペン型の編集ボタンをクリックすると、期間登録登録画面が表示されます。 +(プラス)ボタンをクリックすると時間帯を設定できます。区切られた複数の時間帯を登録する場合は、+(プラス)ボタンをさらにクリックし、複数の時間帯を設定してください。 時間帯を削除する場合は−(マイナス)ボタンをクリックしてください。 設定が完了したら、保存をクリックしてください。

期間登録画面

アクセスタイムテーブル登録画面に戻ると、期間登録画面で登録した時間帯が青色で表示されます。

登録した時間帯の表示

タイムテーブルに祝日を登録したい場合、ページ下部にある祝日登録ボタンをクリックしてください。

祝日登録ボタン

祝日登録画面が表示されますので、日付と特記事項を入力してください。特記事項は祝日の名前を入力することを推奨します。祝日が毎年変わらない日付の場合、毎年の欄にチェックを入れるとすべての年でその日付を祝日とみなします。春分の日や秋分の日など毎年日付が変わる祝日は、年ごとに日付を登録する必要があります。

内容を入力後、保存ボタンをクリックしてください。 アクセスタイムテーブル登録画面に戻ると、祝日が一覧に追加されています。

祝日登録画面

タイムテーブルのすべての設定が完了したら、ページ最下部にある保存ボタンをクリックして保存してください。 アクセスタイムテーブルの一覧画面に保存したタイムテーブルが登録されていることを確認してください。大文字と小文字区別はありません。すでに存在しているタイムテーブル名の場合は保存できません。

登録後のアクセスタイムテーブル一覧

9.3 アクセスタイムテーブルの修正

登録されたアクセスタイムテーブル修正します。

ナビゲーションメニューの[アクセス]→[アクセスタイムテーブル]をクリックし、アクセスタイムテーブルの一覧を表示してください。修正したいアクセスタイムテーブルの詳細をクリックしてください。

アクセスタイムテーブルの修正

アクセスタイムテーブル詳細が表示されます。ページ最下部にある更新ボタンをクリックすると、編集モードになります。

編集後保存ボタンをクリックし、修正内容を反映してください。

9.4 アクセスタイムテーブルの削除

登録されたアクセスタイムテーブルを削除します。

ナビゲーションメニューの[アクセス]→[アクセスタイムテーブル]をクリックし、アクセスタイムテーブルの一覧を表示してください。修正したいアクセスタイムテーブルの削除をクリックしてください。

アクセスタイムテーブルの削除

「この操作は取り消しできません。削除しますか?」というメッセージが表示されます。削除してもよい場合、確定をクリックしてください。アクセスタイムテーブルが削除されます。

9.5 アクセスルールの登録

アクセスルールでは登録されたアクセスタイムテーブルに対し、デバイスや登録者グループを連携します。

ナビゲーションメニューの[アクセス]→[アクセスルール]をクリックし、アクセスルールの一覧を表示してください。Newをクリックすると、アクセスルール登録画面が表示されます。

アクセスルール登録画面への遷移

アクセスルール登録画面のデバイス欄をクリックし、アクセスルールに連携するデバイスを選択してください。デバイスは複数選択できます。一度選択したデバイスを取り消すには、デバイス名の右にある×をクリックしてください。

デバイスを登録すると、デバイスに登録されたグループの一覧がデバイス-グループ選択欄に表示されます。アクセスタイムルールに連携するグループのチェックボックスを選択してください。

アクセスタイムテーブル欄に、アクセスルールに連携するアクセスタイムテーブルを選択してください。1つのアクセスルールに対して、アクセスタイムテーブルは1件のみ連携可能です。全ての内容を入力後、保存ボタンをクリックしてください。

アクセスルール登録画面

アクセスルール一覧画面に戻ります。 アクセスルールの一覧画面で、登録したアクセスルールがデバイスごとに表示されていることを確認してください。

登録されたアクセスルール一覧

アクセスルールは一度登録すると修正できません。デバイスのアクセスルールを修正したい場合は次章の手順に従い、一度ルールを削除してから、再度設定してください。

9.6 アクセスルールの削除

アクセスルールを削除します。

ナビゲーションメニューの[アクセス]→[アクセスルール]をクリックし、アクセスルールの一覧を表示してください。削除したいアクセスルールのチェックボックスを選択し、複数削除ボタンをクリックしてください(削除するアクセスルールが1件の場合も、複数削除ボタンをクリックしてください)。 「この操作は取り消しできません。削除しますか?」というメッセージが表示されます。確定ボタンクリックすると、アクセスルールが削除されます。

アクセスルールの削除

2 ログインとログアウト

モバイル端末からSenseLinkへのログインとログアウトについて記載しています

2.1 ログインページへのアクセス

ご利用中のモバイル端末をインターネットに接続してWebブラウザを起動し、https://link.japancv.co.jp/へアクセスしてください。自動的にリダイレクトされ、モバイル端末専用SenseLinkのログインページが表示されます。

モバイル端末側の推奨OSは、iOSおよびAndroidです。推奨ブラウザはGoogle Chrome、Safariです。それ以外のOSやブラウザでは、動作保証しておりません。

モバイル端末専用SenseLinkのログインページ

2.2 ログイン

ログインページでアカウントとパスワードを入力し、「ログイン」ボタンをクリックしてください。

モバイルページにログインできるロールは、Super AdminとSub Adminのみです。

ログイン
  • Super Adminアカウントのユーザー

    • ユーザー登録申請書にて運用担当者として申請いただいた方 初期アカウント/パスワードは、[email protected]から発信されるアカウント発行通知メールで連絡しています。

    • アカウントアクティベーションにてアカウント発行した方 初期アカウント/パスワードは、アクティベーションページからご自身で設定しています。

  • その他のアカウントのユーザー その他のアカウントは貴社Super AdminおよびSub AdminのユーザーがSenseLinkのユーザーの新規登録機能を利用して発行できます。[email protected]から発信されるアカウント発行通知メールに記載されたアカウントとパスワード、またはアカウントを発行したご担当者様から連絡されたアカウントとパスワードを利用してください。

[email protected]からのメールを受信できるよう、また迷惑メールフォルダに振り分けられないよう、ご利用のメールサービスの設定をご確認ください。

画面の上部に「言語の選択」をクリックすると、SenseLinkの表示言語設定をできます。日本語、英語(English)、簡体中国語(簡体中文)、繁体中国語(繁體中文)、韓国語(한국어)から選択できます。

言語の選択

2.3 認証

現時点では、多要素認証が有効なユーザーはiOSデバイスからのログインができません。

ログインボタンをクリックすると、認証画面が表示されます。

2.3.1 SMSでの認証

SMSで認証コードをする場合、「認証コード取得」ボタンをクリックしてください。

SMS認証コード取得

登録された携帯電話番号に、SMSで認証コードが送信されます。

SenseLinkの認証画面に受信した認証コードを入力し、「適用」ボタンをクリックしてください。SenseLinkにログインできます。

2.3.2 メールでの認証

SMS以外に、登録したメールアドレスへ認証コードを送信することができます。認証画面で「Email」をクリックしてください。メールによる認証コード送信画面へ切り替わります。

SMSと同様に「認証コード取得」ボタンをクリックし、登録したメールアドレスに送信される認証コードを確認してください。

SenseLinkの認証画面に受信した認証コードを入力し、「適用」ボタンをクリックしてください。SenseLinkにログインできます。

ログインが成功すると、以下のような画面が表示されます。

ログイン後画面

2.4 ログアウト

SenseLinkの画面左上部にある アイコンをクリックしてください。ナビゲーションメニューが表示されます。

画面下側に表示される「ログアウト」をクリックしてログアウトしてください。

ログアウト

2 アカウントアクティベーション

SenseLinkへ新規サービス利用開始時の手続きについて記載しています。

本章はJCVからご連絡があったお客様のみ参照ください。

2.1 アクティベーション専用Webページ

SenseLinkを利用するためには、アカウントを登録してアクティベーション(アカウントの有効化)する必要があります。

アクティベーションは専用のWebページで、アクティベーションコードを入力して手続きを行います。アクティベーションを行わない限り、SenseLinkをご利用いただけませんのでご注意ください。

2.2 アクティベーションの手続きの流れ

2.2.1 アクティベーションメール確認

アクティベーションコードは、以下のどちらかの方法でご提供します。

  • 当社からのメールに記載されたURLから入手する「ライセンス利用のご案内」(PDFの2ページ目)

  • 同梱の「登録のご案内」に記載されたQRコード

「ライセンス利用のご案内」には、アクティベーションコードのほか、お申込み頂いたお客様の社名や契約プランなど記載されていますので、内容が正しいか、予めご確認をお願いします。

「ご案内」には重要な内容が記載されていますので、必ず保管してください。

2.2.2 登録サイトへアクセス

ご案内に記載されたURLまたはQRコードから、Webブラウザで登録サイトにアクセスしてください。

正常にアクセスできると、以下のような画面が表示されます。アクティベーションコード欄にコードが記載されていることを確認し、「次へ」をクリックしてください。

アクティベーションコードが表示されない場合は、以下のWebサイトにアクセスし、直接アクティベーションコードをご入力ください

2.2.3 契約サービス、プランのご確認

正しいコードが入力されると、情報を登録する画面に移動します。ここでは契約サービスや契約プランなどが表示されます。表示されている内容が送られてきたメールの内容と比べて正しいか、ご確認ください。

申し込んだ内容とプランなどが異なる場合は、JCV担当者まで連絡してください。

2.2.4 会社名とログインアカウント名を入力

ログイン情報として会社名を入力し、次にSenseLinkのログインに利用する管理者権限を持つアカウント名を入力します。ログインアカウント名を入力して「次へ」ボタンを押してください。

ログインアカウントで利用可能な文字数と種類には制限があります。 文字数:6~25文字 文字種:半角英数字、アンダースコア(_)

既に使われているログインアカウント名は使用できません。

不適切な内容を入力した場合は入力欄が赤くなり、下図のように「ルールに従って記入してください」と警告メッセージが表示されます。

2.2.5 ログイン情報を入力

入力されたアカウントのフォーマットが正しければ、画面の下側にパスワードやメールアドレスを入力する欄が表示されます。なお、電話番号の入力は必須ではありません。

電話番号欄に「SMSに対応していない電話番号」を記載した場合、2段階認証の利用は不可となります。ご注意ください。

入力内容に問題がなければ、「確認」ボタンを押してください。すると、「入力した内容を再確認してください」とメッセージが表示されます。

内容を確認してOKならば「登録」を、内容を修正したい場合は「やり直す」を選んでクリックしてください。

提出ボタンを押すと、下図のような画面に表示されます。登録したメールアドレスに認証コードを自動に送信されます。認証コードが届かない場合は、「認証コード取得」ボタンを押してください。

2.2.6 認証コードの確認と入力

設定されているメールアドレス宛に、下図のような認証メールが送られます。

メール本文に書かれている認証コードを入力し、「適用」ボタンを押してください。正しい認証コードならば、下図のような画面が表示されます。

2.2.7 SenseLinkへのログイン

メッセージの下側にある「SenseLinkにログイン」のボタンをクリックすると、SenseLink Cloudへ接続されてログイン画面が表示されます。ログインに関しては、をご参照ください。

14 レポート

14.1 登録者認証レコード

登録者認証レコードは、Super AdminまたはPersonel Record Adminのみが利用できます。

  • 登録者認証レコードでは、現在ログイン中のユーザーが持つ登録者グループの権限に応じて、従業員、ビジター、拒否リストの認証レコードが表示されます。

  • 日時、登録者グループ、名前を指定した検索をサポートしています(表示範囲は最大1ヶ月)。

  • 認証レコードのエクスポートをサポートしています。

    • 現在のバージョンでは、マスク検知と温度のエクスポートは制限があります。

項目
概要

14.2 登録者認証レコードの使い方

顔認証レコードの表示UIには、認証レコードと登録者認証レコードの2つがあります。

認証レコードと登録者認証レコードの違いは以下です。

項目
認証レコード
登録者認証レコード

Personnel Record Admin がアクセスできる登録者グループ(従業員グループ、ビジターグループ、拒否リストグループ)を限定させる場合は、ユーザーの設定で指定する必要があります。

スナップショット

認証時にデバイスが撮影した写真。一覧では顔部分のサムネイルのみ表示されますが、ホバーすると全体が表示されます。

認証時写真

登録者情報で認証用顔写真として登録された写真

氏名

氏名

登録者タイプ

従業員、ビジター、または拒否リストのいずれかが表示されます。登録者認証レコードでは未登録者は表示されません。

グループ

所属する従業員グループ、ビジターグループ、または拒否リストグループ

時間

認証時間

マスク検知

未着用の場合、「未着用」と表示されます。着用していた場合は何も表示されません。

温度

体温。デバイスの設定によらず、摂氏で表示されます。

場所

プロジェクト

- イベント

 - 認証コード

共通

- レポート

- 登録者認証レコード

利用可能なユーザー

  • Super Admin

  • Sub Admin

  • General Admin

  • Visitor Admin (ビジターと拒否リストのみ)

  • Recognition Records Admin

  • Super Admin

  • Personnel Record Admin

レコードの表示範囲

各プロジェクトに所属するデバイスの認証レコード

  • そのユーザーが管理権限を持っていない登録者グループ(従業員グループ、ビジターグループ、拒否リストグループ)レコードも表示されます

そのユーザーが管理権限を持つ登録者グループ(従業員グループ、ビジターグループ、拒否リストグループ)の認証レコード

  • 未登録者は表示されません

  • 全てのプロジェクトに所属するデバイスの認証レコードが表示されます

用途

  • 全ての認証レコードを確認したい場合

  • デバイス単位で認証レコードへのアクセスを分離したい場合

  • 特定の登録者グループ(従業員グループ、ビジターグループ、拒否リストグループ)、および その認証レコードだけを管理したい場合。Personnel Record Adminと組み合わせてご利用ください。

3章 ログインとログアウト
会社名とログインアカウント名
ログイン情報入力画面
再確認画面
認証メールの例
登録成功画面

改訂履歴

日付

改訂内容

2020/06/12

初版

2020/06/26

2.11節 イベントサブスクリプションAPI に補足や注意点を追記

2020/07/04

2.2.8項 ThunderMiniの設定項目を追加、デバイス側の設定項目に合わせてThunder及びThunderMiniの設定項目を追加

2.4.13項 pageとsizeフィールドを追加

2.11.10項 補足を追加

2020/07/13

2.2.8項 設定項目の名称とコメントを訂正

2020/07/29

  • SenseLink SaaSの製品名をSenseLink Cloudに変更

  • SenseLink GE Enterprise、SenseLink GE Enterprise ProでのAppキーの管理方法を修正

2020/08/20

2.7.6項 passRuleフィールドの説明を修正

2020/10/08

2.4.13項 登録者の参照のパラメータを追加 2.8.1項 認証レコードの表示の新規バージョンを追加

2.11.7項 サブスクリプション更新の新規バージョンを追加

2.11.9項サブスクリプション詳細表示の新規バージョンを追加

一部デリケートな文言を修正

  • ブラックリスト→拒否リスト

  • ホワイトリスト→許可リスト

2020/10/12

2.4.1項 登録者の追加のパラメータの記載を修正

2.4.13項 モデル別の登録者の参照のパラメータの記載を修正

2020/10/16

2.9 節 認証用顔写真の記載を修正

2.4.9項 バージョン号の修正

2020/11/18

2.4.1項 登録者のエラーレスポンスの記載を修正

2020/11/25

2.3節 デバイスアラートの記載を修正

2020/12/03

2.3.1項 デバイスアラートの取得のステータス説明項目を修正

2.4.9項 拒否リストへの移動のエラーレスポンスの記載を修正

2.10.5項 部署更新のエラーレスポンスの記載を修正

2020/12/14

2.11.4項 イベントの再Pushの記載を修正

2020/12/24

2.2.7項 デバイスリストのレスポンスコードを修正

2.4節 各人員タイプ追加・更新時の ・ICとID番号の説明を修正 ・類似する登録者が存在する場合のレスポンスコードを修正

・強制追加フラグを追加

・グループの説明を修正

2.8.1項 認証レコードの表示の新規バージョンを追加

2021/01/20

SenseLink GE Enterprise V2.3.2 API マニュアルとの分割

2021/01/28

2.5.4項 登録者グループの更新の説明を追加

2021/02/02

1.2節 ドメイン管理の説明を修正

2021/02/03

2.11.6項 イベントPUSHのパラメーター型を一部訂正

2021/02/15

2章 サポートデバイスを追加

2021/04/08

2章 不要なAPIを複数削除

2021/05/12

2.8.2項 認証用顔写真品質の検出の新規バージョンを追加

2.8.4項 顔検索を追加

2021/06/02

2.8.2項 認証用顔写真品質の検出の新規バージョンを追加

2021/06/21

2.8.5項 SenseLink Cloud ID Pack Annual Subscriptionプランの提供開始により、顔検索の記載を修正

2021/06/22

2.2.5項 リモート構成(一括複数アップデート)のしきい値の記述を修正

2021/08/02

3章 Senselink Cloud非対応のため削除

2021/09/17

2.10.3項、2.10.5項のイベントサブスクリプション詳細画面を現行バージョンの画面に差し替え

2021/11/15

2.4節 似ている人に対応する新バージョンの登録者登録・更新APIを追加

2.7.1項 レコードAPIの戻り値説明を追加

2.8節 写真取得APIを追加

2022/3/21

2.7.1項 認証レコードの表示API v6を追加

2.10.6項 イベント出力内容を更新

2.10.10項 出力結果を修正

2022/8/17

2.2.9項 デバイスの設定情報の取得 を追加 2.2.10項 デバイスの設定変更 を追加

2022/11/29

2.2.4項 デバイスリストの表示を追加 2.11節 認証レコード+API を追加

3 従業員管理

従業員の登録や削除、管理について記載されています。

ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

従業員管理画面では、現在のユーザーに登録された従業員グループのデータのみが表示されます。

3.1 従業員の検索

従業員画面で、従業員の検索と従業員グループのフィルタリングすることができます。

従業員情報で検索する場合、画面右上の虫眼鏡マークをクリックし、検索入力欄が表示されます。検索できる項目には、従業員名と従業員番号があります。検索キーワードを入力し、「検索」ボタンをクリックしてください。検索結果が表示されます。「×」マークをクリックすると検索結果が解除され、デフォルトの一覧画面が表示されます。

従業員をグループごとにフィルタリングする場合、漏斗マークがついている「すべての従業員グループ」ボタンをクリックしてください。

グループ選択画面が表示されます。フィルタリングしたいグループを選定し、画面右上の確定ボタンをクリックしてください。

従業員画面に戻り、選定されたグループに所属する従業員のみが表示されます。

3.2 従業員の新規登録

モバイル端末から、従業員を個別登録(従業員を1人ずつ登録)することができます。

登録するには、従業員画面の右下の「+」ボタンをクリックしてください。

従業員登録画面が表示されます。

3.2.1 従業員写真

従業員写真を追加するには、モバイル端末のカメラで撮影するか、モバイル端末から画像をアップロードします。

従業員登録画面の「写真アップロード」ボタンをクリックしてください。

画像選択画面が表示されます。

カメラで撮影した写真をアップロードする場合、「カメラ」ボタンをクリックしてください。このとき、ブラウザの撮影許可画面が表示される場合があります。その場合は「許可」を選択し、撮影に進んでください。

モバイル端末から画像をアップロードする場合、「閲覧」ボタンをクリックし、写真ライブラリから写真を選択してください。

写真のアップロードが成功した、従業員登録画面に戻ります。

3.2.2 従業員情報

従業員登録画面で、従業員の個人情報を入力してください。

表:登録項目詳細

必要な情報を入力した後、画面の右上にある「確定」ボタンをクリックして登録を完了してください。登録完了まで数秒かかる場合があります。

3.3 従業員の修正

従業員の情報を修正することができます。

従業員画面で、修正したい従業員をクリックしてください。

従業員情報詳細が表示されます。画面の右上にある「更新」ボタンをクリックすると、修正モードになります。

情報を修正した後、画面の右上にある「確定」ボタンをクリックすると、修正内容が反映されます。

3.4 従業員の削除

従業員の情報を削除することができます。

従業員画面で、削除したい従業員をクリックしてください。

従業員情報詳細が表示されます。画面の右上にある「更新」ボタンをクリックすると、修正モードになります。

画面の下にある「削除」ボタンをクリックしてください。「この操作は取り消しできません。削除しますか?」のメッセージが表示されますので、「確定」をクリックして削除してください。

項目

詳細、文字種制限、フォーマット、注意事項など

最小文字数

最大文字数

氏名

必須項目

1

30

従業員グループ

(選択肢)

必須項目

-

-

携帯電話番号①

国コード、国別コードを選択してください 日本の携帯電話を利用している場合[+81]を選択してください

-

-

携帯電話番号②

  • すべての登録者タイプの中で一意である必要があります

  • 携帯電話番号①の国コードが異なる場合、同一の携帯電話番号を登録することはできません +81-08012345678 と+12-08012345678は、同一携帯電話番号として判断されます

  • 氏名が重複する従業員が存在する場合、複数更新を行うために必ず当項目を登録してください

  • ハイフンは利用できません。半角数字のみ利用してください

6

20

従業員番号

半角英数字

一意である必要があります

-

20

特記事項

(自由入力)

-

200

従業員情報での検索
従業員グループ選択
グループ選択画面
グループ選定後
従業員登録
従業員登録画面
写真アップロード
カメラ使用許可(機種によって表示が異なります)
登録確定
従業員修正
従業員修正モード
修正内容の保存
従業員削除
従業員修正モード
削除確認

4 顔写真のセルフ登録

4.1 顔写真のセルフ登録方法

従業員の皆様ご自身で顔写真の登録を行う手段として、顔写真の登録ページをご利用できます。登録ページはテナントで1つのURLが割り当てられ、2種類のアクセス方法を提供します。

登録方法
説明

SMS/メールアドレスを用いた本人認証

事前に従業員の設定で、携帯電話番号または メールアドレスを入力する必要があります

Register Admin ロールアカウントでログイン後、従業員番号を入力して更新する従業員を指定

事前に従業員の設定で、従業員番号を入力する必要があります。 Professional または Professional+IDPack のプランでのみサポートれます。

顔写真の登録ページへのアクセス先のURLは、システム - システム設定 - 顔写真の登録 からご確認できます。また、後述の承認機能の有効/無効も設定することができます。

4.2 事前準備

  • 6 登録者タイプ を参照し、従業員を事前に作成してください。その際、携帯電話番号、メールアドレス、または 従業員番号を設定してください。

  • 従業員番号を用いた本人指定による登録の場合は、Register Admin のロールを持つユーザーアカウントを作成してください。

  • セルフサービス登録ページへのアクセスのためのQRコード、または URL情報 を従業員に配布してください

4.3 SMS/メールでの本人認証による登録

従業員の皆様に次の作業を実施いただきます。

  1. スマートフォン、または タブレットデバイスからWebブラウザを用いて、セルフサービス登録ページにアクセスします。

  2. SMSまたはメールを選択し、携帯電話番号またはメールアドレスを入力します。その後、認証コードの取得をクリックします。  

  3. Google reCAPTCHA の画面が表示されます。「私はロボットではありません」にチェックを入れ、再度「認証コード取得」をクリックしてください。

  4. SMSまたはメールアドレスに送信された認証コードを「認証コードを入力」欄に入力し、「サインイン」をクリックしてください。

5. 顔写真の登録ページに移動します。

6. 中央の「写真アップロード」、または 表示されている顔写真をクリックしてください。表示された選択肢の中から1つ選び、顔写真をアップロードしてください。

7. その後、右上の「確定」をクリックしてください

8. 「承認機能」が無効な場合は、この時点で従業員の顔写真が更新されます。

「承認機能」が有効な場合は、この後に管理者による承認が必要となります。承認手順については、4.5 顔写真登録申請の承認 をご参照ください。

4.4 従業員番号を用いた本人指定による登録

本機能は、ご利用できる SMS または メールアドレスを持たない従業員の方々の顔写真を登録するためのものです。承認機能と合わせてご利用することを推奨します。

SenseLink の管理者など、Register Admin の権限を持つユーザーにより次の作業を実施ください。

  1. スマートフォン、または タブレットデバイスからウェブブラウザを用いて、セルフサービス登録ページにアクセスします。SenseLink アカウントでログイン をクリックします。

  2. ログイン画面が表示されます。Register Admin のアカウント名とパスワードを入力し、「ログイン」をクリックします。

  3. Register Admin の多要素認証の設定を有効にしている場合は、認証コードを入力し、「適用」をクリックします。

  4. 「従業員番号の入力」画面が表示されます。

続いて、顔写真の登録を行う従業員が同じ端末を用いて次の作業を実施します。

  1. 従業員ご自身の従業員番号を入力し、「適用」をクリックします。 (この時、入力された従業員番号を持つ従業員が SenseLink に事前に登録されている必要があります。)

  2. 顔写真の登録ページに移動します。

  3. 中央の「写真アップロード」または 表示されている顔写真をクリックしてください。表示された選択肢の中から1つ選び、顔写真をアップロードしてください。

  4. その後、右上の「確定」をクリックしてください

  5. 「承認機能」が無効な場合は、この時点で従業員の顔写真が更新されます。 「承認機能」が有効な場合は、この後に管理者による承認が必要となります。承認手順については、4.5 顔写真登録申請の承認 をご参照ください。

  6. 「戻る」をクリックすると、「従業員番号の入力」画面へ戻ります。引き続き、別の従業員の顔写真を登録する場合は、その従業員の従業員番号を入力し、顔写真の登録を実施ください。

4.5 顔写真登録申請の承認

承認機能が有効な場合は、顔写真の登録申請を管理者が承認する必要があります。

登録申請の承認には次の2つの方法があります。

  • モバイルページに Approval Admin のユーザーロールを持つアカウントでログインし、承認する

  • 管理Webページの 登録者タイプ - 登録レコード から、承認する

登録レコードから承認する方法については、6.13 登録レコード を参照ください。

本節では Approval Admin によるモバイルページからの承認を説明します。

  1. スマートフォン、または タブレットデバイスからウェブブラウザを用いて、セルフサービス登録ページにアクセスします。「SenseLink アカウントでログイン」 をクリックします。

  2. ログイン画面が表示されます。Approval Admin のアカウント名とパスワードを入力し、「ログイン」をクリックします。

  3. Register Admin の多要素認証の設定を有効にしている場合は、認証コードを入力し、「適用」をクリックします。

  4. 登録レコード 画面が表示されます。承認する場合は、黒いチェックボタンをクリックしてください。却下する場合は、赤いバツボタンをクリックしてください。

  5. 確認メッセージが表示されます。「確定」をクリックしてください。

  6. 顔写真の登録が完了します。

4.6 顔写真のセルフ登録の留意事項

  • 顔写真の品質チェックレベルは、従業員の作成時に指定されたものを使用します。

  • “従業員” に登録されていない携帯電話番号やメールアドレスを入力した場合、認証コードは送信されません。

  • 顔写真登録依頼への承認は Approval Adminの他、Super Admin、Sub Admin、General Admin、Personnel Admin のロールを持つ管理者ユーザーで実施できます。

  • Register Admin による 顔写真の登録申請や Approval Admin による承認処理は、それぞれのアカウントが管理できる従業員グループの従業員に対してのみ実行可能です。

  • Register Admin ロールの管理者アカウントのパスワードは、ランダムパスワードのみとなります。特定のパスワードを設定できません。

JCV アクティベーションサービス | JCV - 日本コンピュータビジョン株式会社activate.japancv.co.jp

11 勤怠

従業員の出退勤時間や勤務地のルールの設定、認証レコードを元に出退レコードや遅刻、早退などの勤怠管理について記載されています。

勤怠画面では、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。ただし、一部のデータが部署ベースで管理しているため、権限外のデータも表示されることがあります。

SensePass GE V1.2.3では、勤怠機能はサポートされません。

11.1 勤怠ルールの管理

ナビゲーションメニューの[勤怠]→[勤怠ルール]をクリックしてください。勤怠ルールの一覧が表示されます。

勤怠ルール画面

初期設定時では「デフォルト勤怠ルール」というルールが登録されています。登録されたすべての従業員はデフォルトで「デフォルト勤怠ルール」が適用されています。「デフォルト勤怠ルール」の設定は、修正することができます。

登録ボタンをクリックすると、勤怠ルール登録画面が表示されます。

勤怠ルール登録

登録項目とデフォルト勤怠ルールの設定値は以下です。

項目

概要

デフォルト勤怠ルールの設定値

勤怠ルール

勤怠ルール名

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~30文字(半角換算)で登録可能

デフォルト勤怠ルール(変更不可)

従業員

勤怠ルールを適用する従業員または所属部署グループの選択

すべての従業員(変更不可)

頻度

認証頻度の選択

「月曜日-金曜日 1日2回」は、月曜日〜金曜日に1日2回の顔認証を行う場合に選択。1日3回以上顔認証を行なった場合、最後の顔認証時刻が退勤時間として記録されます

勤怠ルールによる勤怠管理を行わない場合は「勤務なし」を選択してください

月曜日-金曜日 1日2回

日付変更時間

勤怠管理上の日付変更時間の設定

(例:日付変更時間が04:00:00に設定されている場合、5月1日の03:59:00に顔認証を実施すると4月30日の勤怠記録として記録されます。5月1日の04:01:00に顔認証を実施すると5月1日の勤怠記録として記録されます)

05:00:00

規定始業時間

勤怠規定の始業時間

09:00:00

規定終業時間

勤怠規定の終業時間

18:00:00

分以内の誤差を許容

始業時間または就業時間に対する認証時間の許容時間の設定

(例:始業時間が09:00:00、許容時間が10分に設定されていた場合、従業員が09:10:59に顔認証を行なっても(出勤しても)遅刻とみなしません。09:11:00から遅刻とみなします)

10

時間外労働-総労働時間

総労働時間が何時間以上となった場合に残業時間とみなすかを設定します。次項目とAND条件です

勤務日12.0、休日8.0

時間外労働-かつ終業時間

何時以降に退勤した場合に残業時間とみなすかを設定します。全項目とAND条件です

勤務日 21:00:00、

休日: 18:00:00

特別出勤日

土日で出勤を行い勤怠ルールを適用する場合に設定します

日付と特記事項に出勤日名を設定します。出勤日名は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~45文字(半角換算)で登録可能です

なし

祝日

勤怠ルールを適用しない祝日を設定します

日付と特記事項に祝日名を設定します。祝日名は半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~45文字(半角換算)で登録可能です

なし

すべての項目を入力したら保存をクリックしてください。勤怠ルール一覧画面に戻り、登録した勤怠ルールが一覧に表示されます。

11.2 勤務エリアの管理

勤務エリアの管理を行います。勤務エリアはデバイスと連携することができ、従業員が顔認証を行なった際に、そのデバイスに登録された勤務エリアが勤怠レコードに記録されます。勤務エリアが登録されないデバイスで顔認証を行なった場合、デバイスの設定項目の「設置場所」が勤務エリアとして記録されます。

勤務エリアの活用例

複数のビルに拠点を持つ企業が各ビル内の複数のゲートに顔認証デバイスを設置する場合に活用できます。同一ビル内のすべてのデバイスを共通の勤務エリア(例:半蔵門オフィス、汐留オフィス)として登録すれば、従業員がどのゲートで顔認証を行なったかに関わらず、出勤した勤務エリア(例:半蔵門オフィス、汐留オフィス)を記録することができます。

ナビゲーションメニューの[勤怠]→[勤務エリア]をクリックしてください。勤怠エリア一覧が表示されます。

勤務エリア画面

登録ボタンをクリックして勤務エリア登録画面を表示します。

勤務エリア登録画面

勤務エリア欄に勤務エリア名を入力してください。半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号の1~50文字(半角換算)で登録可能です。

Google Mapの検索機能や位置情報を利用することができます。位置情報欄に位置情報の検索ワードを入力し、登録したい住所やビル名、任意の位置情報名を登録してください。

半径(m)はサポートされない機能です。利用できませんので、値を変更しないでください。

登録デバイス欄で連携するデバイスを選択してください。設定が完了したら保存ボタンをクリックしてください。 勤務エリア一覧に登録した勤務エリアが表示されます。

11.3 勤怠レコードの管理

従業員の勤怠レコードを管理します。出退勤時間や登録された勤怠ルールに基づく勤怠ステータスが管理されます。

Basicプランは30日間、Professionalプランは365日間勤怠レコードが保存されます。 ご契約のプランについては、サービス開始時に契約担当者様に送付されるメール「サービス開始のご連絡」にてご確認ください。

ナビゲーションメニューの[勤怠]→[勤怠レコード]をクリックしてください。当日の勤怠レコードの一覧が表示されます。

勤怠レコード画面

勤怠ステータスは以下の種類があります。

ステータス

概要

通常

勤怠ルール通りの場合

遅刻

始業時間が勤怠ルールより遅れた場合

早退

終業時間が勤怠ルールより早い場合

遅刻および早退

遅刻、早退の両方に該当する場合

残業(勤務日)

勤務日に残業した場合

残業(祝日)

祝日に残業した場合

欠勤

認証が行われなかった場合

打刻忘れ

1日に1度のみ認証が行われ、始業と終業の時間が記録できない場合

外勤

登録された勤務エリア以外で顔認証を行なった場合

11.4 従業員別 勤怠レコードの管理

従業員別の勤怠レコードを管理します。

ナビゲーションメニューの[勤怠]→[従業員別 勤怠レコード]をクリックしてください。デフォルトで、前月から当日までの従業員別の勤怠一覧が表示されます。 日付を変更すると、勤怠一覧の数値を再計算して表示されます。

従業員 別勤怠レコード画面

設定欄の勤怠レコードをクリックすると、勤怠レコードに遷移して選択した従業員の指定期間内の勤怠レコードが表示されます。

11.5 勤怠レコードのエクスポート

勤怠レコードを最大100,000件までExcelファイルにエクスポートすることができます。

ナビゲーションメニューの[勤怠]→[勤怠レコード]をクリックしてください。勤怠レコードの一覧が表示されます。上部にあるエクスポートボタンをクリックしてください。

勤怠レコードのエクスポート

「エクスポートされたExcelファイルのパスワードは現在のアカウントです」というメッセージが表示されます。確定ボタンをクリックすると、勤怠レコードが記載されたExcelファイルがご利用中のPCに保存されます。

以下のExcelファイル名で保存されます。[YYYY]-[MM]-[DD]は勤怠レコード一覧検索で設定された開始日時と終了日時が指定されます。 勤怠レコード_[YYYY]-[MM]-[DD]_[YYYY]-[MM]-[DD].xlsx です。

ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログインしていたのアカウントです。

11.6 従業員別勤怠レコードのエクスポート

従業員別勤怠レコードを最大100,000件までExcelファイルにエクスポートすることができます。

ナビゲーションメニューの[勤怠]→[従業員別 勤怠レコード]をクリックしてください。従業員別勤怠レコード一覧が表示されます。 エクスポートボタンをクリックしてください。

「エクスポートされたExcelファイルのパスワードは現在のアカウントです」というメッセージが表示されます。確定ボタンをクリックすると勤怠レコードが記載されたExcelファイルがご利用中のPCに保存されます。

以下のExcelファイル名で保存されます。[YYYY]-[MM]-[DD]は従業員別勤怠レコード一覧検索で設定された開始日時と終了日時が指定されます。 従業員別勤怠レコード_[YYYY]-[MM]-[DD]_[YYYY]-[MM]-[DD].xlsx

ファイルを開く際にパスワードを求められます。パスワードはファイルエクスポート時にログインしているアカウントです。

1 製品概要と利用方法

当製品の概要と利用方法について記載されています。

1.1 製品概要

本ドキュメントは、主に開発者の方々に利用いただくSenseLink CloudのAPIマニュアルです 。

SenseLink Cloudオープンプラットフォームは、SenseLink に基づくオープンサービスプラットフォームです。APIを利用することでサードパーティのシステムはSenseLinkからデバイス、登録者、レコードなどの情報を取得し、SenseLinkが持つ管理機能を統合することができるようになります。

1.2 Appキーの作成

SenseLinkにログインし、ヘッダーメニューの[ユーザー名]→[オープンプラットフォーム]を選択してください。Appキーを管理するオープンプラットフォーム画面が表示されます。

オープンプラットフォーム画面の、[App Keyを作る]ボタンをクリックしてください。

Appキーには、作成するキーごとに、APIの実行制限を設定することができます。

「制限する」にチェックを入れると、制限対象となるAPI名を選択できるプルダウンメニューが表示されます。制限したいAPIにチェックを入れてください。

「制限なし」にチェックを入れた場合は、APIの実行制限はありません。

以下のように、チェックボックスで指定することで、制限するAPIを指定できます。

選択後、確認のためにパスワードを入力する必要があります。表示される入力画面に現在ログイン中のアカウントのパスワードを入力して、確認ボタンをクリックしてください。

「AppキーとAppシークレットを作成しました。ダウンロードされたCSV内にAppキーとAppシークレットの情報が含まれます。安全に管理してください。」というメッセージが表示され、ご利用中のPCにAppキーとAppシークレットが記載されたCSVファイルがダウンロードされます。ダウンロードされたCSVファイルを開くと、AppキーとAppシークレットを確認することができます。

なお、入力したパスワードが誤っている場合、AppキーとAppシークレットは作成されず、CSVファイルもダウンロードされません。

1.2.1 Appキーの確認

Web画面上の一覧から、作成したAppキーとAppシークレットを確認することができます。Appシークレットはデフォルトで非表示になっています。表示ボタンをクリックすると、パスワード入力を求められます。

現在ログイン中のアカウントのパスワードを入力すると、Appシークレットが表示されます。

Appキーは「制限の変更」「無効」ができます。

1.2.2 特記事項” 列の追加

Appキーの一覧表示欄にある「特記事項」には、App Keyの用途などを記載できます。

特記事項欄には、最大30文字まで記入することができます。

1.2.3 Appキーの管理

Appキーは5つまで作成および利用可能で、無効化および削除することもできます。Appキーを一覧の設定ボタンを利用して適宜管理してください。無効化中はAppキーとAppシークレットが利用できませんが、有効化すると再度同じAppキーとAppシークレットを利用することができます。一度削除するとAppキーとAppシークレットを復元することはできませんので、ご注意ください。

Appキーは「制限の変更」「無効」ができます。

「制限」をクリックすると、制限のステータスを変更する画面が表示されます。

ドメイン管理機能は現在使用できません。使用しないでください。

1.3 呼び出し方法

1.3.1 シグネチャ(sign)の計算

計算方法は、

により計算されます。タイムスタンプおよびAppシークレットを利用してください。

例 :

timestamp:Unix 時間 (ミリ秒を含む13桁)

1.3.2 GET メソッドのインターフェース

sign、timestamp、および Appキー(app_key)の 3 つのパラメーターを、オプションパラメーターと共に次のようにリクエストしてください。

https://link.japancv.co.jp/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

TypeId および size はオプションパラメーターです。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。

1.3.3 POST メソッドのインターフェース

sign、timestamp、およびAppキー(app_key) の 3 つのパラメーターを、次のようにリクエストしてください。

https://link.japancv.co.jp/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

オプションパラメーターはリクエスト本体に配置され、form-dataまたはインターフェースドキュメントで指定された application/json に従って呼び出され、リクエストがサーバーへ送信されます。サーバーは現在の timestamp をクライアント側からのリクエスト内の timestamp と比較し、その差が30 分以上の場合はエラーを返します。

一部のインターフェースでは id をリクエストに配置する必要があります。詳細については、APIの利用方法をご参照ください。

1.4 API エラーコード

改訂履歴

日付

改訂内容

2020/06/12

  • 初版

2020/06/26

  • 1章 モデルの種類と各モデルのサポートデバイスを更新

  • 5章 デバイス管理 の表の崩れ、軽微な誤記を修正

  • 11章 サブスクリプションサービスを修正

2020/06/29

  • 11.5節 Infoセクションに記載の対象モデルを変更

  • 11.5.5 項を追加

2020/07/01

  • 3章 時刻とタイムゾーン設定によるログイン時のエラーについて説明を追加

2020/07/17

  • 6.9-6.12節 SenseLink SaaSによる複数従業員登録/修正/顔写真修正方法、および全モデルでの従業員複数削除 の方法について追加

  • 6.13節 登録レコードに記録される登録方法について修正

  • 新たなアカウントロールについて追加

    • Personnel Admin

    • Recognition Records Admin

    • Device Login Admin

  • デバイス製品の表記を修正

    • (修正前)SenseThunder → (修正後)SenseThunder-E

    • (修正前)SenseThunder Mini → (修正後)SenseThunder-Mini

  • SenseLink SaaSがサポートするデバイスにSenseThunder-E、SensePass、およびSenseThunder-Miniの新バージョンを追加

  • その他注意事項の追加

2020/07/29

  • SenseLink SaaSの製品名をSenseLink Cloudに変更

  • アカウント発行やパスワードリセット通知のメール受信に関する注意事項を追加

  • オペレーションログに関する補足を追加

  • SenseLink CloudがサポートするデバイスからSenseThunder Mini GE V1.0.1を削除

2020/08/05

  • 従業員の複数削除時に利用するExcelファイル形式の注意点を追加

2020/08/12

  • 12章 アップデート管理を追加

2020/08/13

  • SenseLink Cloud利用時の認証レコード、デバイスアラート、勤怠レコードの保存期間について情報を追加

2020/09/24

  • SenseLink GE Enterprise V2.3.2の情報を追加

2020/09/30

  • 10.1節 従業員の概要を訂正

2020/10/05

  • 付録 A アカウントの権限明細を追加

2020/10/08

  • SenseLink Cloud V2.3.6の情報を追加

  • マニュアル中の表現を一部修正

    • ブラックリスト→拒否リスト

    • ホワイトリスト→許可リスト

  • 一部UI画面キャプチャの修正

2020/10/15

  • サポートするデバイスにSenseThunder-EとSensePassの新バージョンを追加

2020/10/27

  • 4.4節 音声ガイダンスの説明を追加

  • 推奨ブラウザのSafariについての説明を追加

  • 5.4節 機能設定の項目を追加

2020/11/11

  • 6.3節 従業員番号の定義を更新

2020/11/27

  • サポートするデバイスにSenseThunder-Eの新バージョンを追加

2020/12/03

  • 12章 アップデート管理の説明を一部修正

2020/12/18

  • サポートするデバイスにSenseThunder-Eの新バージョンを追加

2020/12/24

  • ダッシュボードについての説明を更新

    • 4.4節 エリアC:ダッシュボード

    • 9.1節 認証レコードの管理

    • 11.5.5節 レコードの設定

  • 11.2.2節 MFA設定の記載を追加

  • 12.2節 アプリケーション管理を追加

2021/01/20

  • SenseLink GE Enterprise V2.3.2 ユーザーマニュアルとの分割

  • 3章 推奨ブラウザにMicrosoft Edgeを追加

  • 7章 部署管理の追加

2021/01/28

  • 5章 デバイスリストの説明を一部修正

2021/02/09

  • サポートするデバイスにSenseThunder-MiniとSenseThunder-Airの新バージョンを追加

2021/03/26

  • サポートするデバイスにSenseThunder-Miniの新バージョンを追加

2021/04/01

  • 2章 新規ユーザー登録の追加

2021/04/08

  • 4章 ダッシュボードにSenseLinkアクセスコントロール内容を追加

  • 4.6節 プロジェクトを追加

  • 12.2節 アカウント管理、12.3節 API管理、12.4節 サブスクリプションサービスの管理を4章に移動

  • 付録A ユーザー権限を更新

2021/05/12

  • サポートするデバイスにSenseNebulaを追加

2021/06/02

  • 6章 認証用写真の品質チェックレベル「厳格」に関する内容を追加

  • 10.1節 認証レコードの管理にSenseNebluaに関する内容を追加

  • 12章 システム画面での認証用写真の品質チェックに関する内容を削除

2021/06/17

  • 10章 デバイスアラートタイプの説明を追加

2021/06/21

  • 4章 ユーザーの新規登録の「一意である必要があり」を「一意であること」に修正

  • 6章 従業員の新規登録欄にある「外線番号」を「内線番号」修正

  • 10章 誤認証タイプの内容を最新版で表示される項目に修正

  • 10章 デバイスアラートの内容を最新版で表示される項目に修正

  • 10章 認証レコードのエクスポート欄の「マスク検知」を「マスク」に修正

2021/06/30

  • 5章 デバイス情報の表示項目を追加

  • 6.3節 従業員の新規登録項目、6.4節 ビジターの新規登録項目を追加

  • 12.2節 システムの設定に関する内容を追加、12.4節 契約プランの画像を更新

2021/07/02

  • 5章 デバイスのネットワーク通信仕様に関する参考内容を追加

2021/09/14

  • 付録にFAQを追加

2021/11/15

  • 5.5節 顔認証モードの切替を追加

2022/2/3

  • 9章にアクセスタイムテーブル使用時の注意事項を追加

2022/3/23

  • 「14章 レポート」を追加

  • 10.1節 認証レコードの項目に「拡張情報」を追加

  • 付録A 権限一覧表を更新

  • 1.3節 外国企業が提供するサービスについてを追加

2022/4/15

  • 1.3節 外国企業が提供するサービスについてを追加

2022/5/31

  • 1章 製品概要へSenseThunder V.2.4.1対応を記載

2022/8/17

  • 5.10節 デバイスログのアップロード を追加

2022/9/28

  • 4.5.1節 ユーザーの種類(ロール)に Register Admin と Approval Admin の情報を追加

  • 6.13節 登録レコード の内容を更新

  • 12.2.4節 顔写真の登録 を追加

2022/11/29

  • 認証レコードを記録するAPIを実装

  • 認証レコード+の説明を記載

  • Appキーの作成手順や特記事項の説明を追記

  • イベントサブスクリプションに認証レコード+の設定方法を追記

sign=md5 (timestamp#app_secret)
app_secret=2323dsfadfewrasa3434
timestamp=1477881215000
sign=md5 (1477881215000#2323dsfadfewrasa3434) =e5ef72ef839bdf5397b4906b199b9fbf

コード

メッセージ

原因

10001

App Key Not Exist

キーがありません

10002

App Expired

キーが期限切れです

10003

Request Expired

リクエストが期限切れです

10004

IP Invalid

IPアドレスが許可リストにありません

10005

Signature Failed

無効なシグネチャ(sign)です

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

不正なリクエストメソッドです

60005

Request_rate_too_high

リクエスト頻度が高すぎます

60006

Daily_quota_exceeded

1 日あたりのリクエスト上限に達しました

99999

Unknown Error

不明なエラーです

620

Record non-existent Error

不正なパラメーターです。対応するレコードが見つかりません

610

Similar record Exist

類似するレコードが存在します(同じ名前の部署が同じレベルに存在するなど)

650

Cannot delete unless include nothing

部署または従業員が配下にあるため削除できません

オープンプラットフォーム画面への移動
Appシークレットを表示
Appシークレット表示ボタン
Logo

13 アップデート

デバイスとアプリケーションのバージョンとアップデート情報について記載されています。

アップデート画面では、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。

アップデート管理では、デバイスのファームウェアとアプリケーションの最新バージョンを確認し、アップデートしたい特定のデバイスを指定して実行することができます。デバイスのアップデートを実施する前に、ファームウェアおよびアプリケーションの新しい機能と改善点について、必ずご確認ください。

13.1 ファームウェア管理

ファームウェア管理では、SenseLinkに連携している顔認証デバイスとそれらのファームウェアの情報を表示できます。

ナビゲーションメニューの[アップデート]→[ファームウェア管理]をクリックしてください。デバイスとファームウェアの一覧が表示されます。

ファームウェア管理画面

「ステータス」フィールドは、デバイスのリアルタイムアップデートステータスを表します。アップデートステータスの詳細は次のとおりです。

ステータス

詳細

更新可能なファームウェアがあります

アップデート可能な新しいファームウェアがあります。

デバイスがオンラインになるまで待機中

デバイスがオフラインのため、アップデートを開始できません。アップデートするには、デバイスをオンラインにしてください。

ダウンロード待機中

デバイスはオンラインですが、管理者はデバイスのアップデートを確認していません。手動アップデートモードと設定時間アップデートモードで表示されます。

ダウンロード中...10%

デバイスへファームウェアをダウンロードしています。数値はダウンロードの進捗値です。

インストール待機中

デバイスはダウンロードを完了し、スケジュールされた時間までインストールを待機しています。設定時間アップデートモードで表示されます。

インストール中

ファームウェアをデバイスへインストールしています。

最新のファームウェアがインストール済です

デバイスは最新のファームウェアにアップデートされました。

アップデートに失敗しました:ネットワーク異常

ネットワークエラーが発生しました。ネットワークをチェックして安定していることを確認してから、アップデートを再試行してください。

アップデートに失敗しました:ダウンロードスペースが足りません

デバイスに十分な空き容量がないため、ファームウェアのダウンロードに失敗しました。不要なデータを消去してから、アップデートを再試行してください。

アップデートに失敗しました:ファイルのダウンロードに失敗しました

なんらかの理由でファームウェアのダウンロードに失敗しました。ネットワークをチェックして安定していることを確認してから、アップデートを再試行してください。

アップデートに失敗しました:APKファイルがありません

ダウンロードしたファイルにアプリケーションファイルが見つかりません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:最新バージョンではありません

ダウンロードしたファームウェアは、最新バージョンではありません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:パッケージ名エラー

ファームウェアパッケージ名が間違っており、このデバイスタイプに適したファームウェアタイプではないため、インストールできません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:インストールタイムアウト

インストールに時間がかかりすぎました。デバイスの状態を確認してから、アップデートを再試行してください。

アップデートに失敗しました:ダウンロードが中断されました

予期しないエラーが発生しました。JCV製品窓口にお問い合わせください。

SensePass V1.2.5以下のバージョン、SenseThunder-E V1.1.5以下のバージョン、およびSenseThunder-Mini V1.0.9より前のバージョンの場合、ステータスの「ダウンロード中」、「インストール待ち」、「インストール中」の進捗数値、「アップデートが失敗しました」の表示はサポートされていません。

デバイスが「ダウンロード中」の場合、ステータスにマウスを合わせると経過時間を確認できます。ダウンロードに時間がかかりすぎる場合は、アップデートをキャンセルするか、デバイスの状態を確認してください。

13.1.1 ファームウェアのアップデート配信

デバイスをアップデートする際に、さまざまなオプションが用意されています。

「更新可能なファームウェアがあります」または「アップデートが失敗しました」のステータスのデバイスには、一括してアップデートを適用できます。すべてのデバイスをアップデートするには、[適用]ボタンの下と、[デバイス名]ラベルの左側にあるチェックボックスを選択します。アップデート範囲を指定するには、アップデートするデバイスのチェックボックスのみを選択します。

アップデート範囲指定

アップデートには、「即時アップデート」、「設定時間アップデート」、「マニュアルアップデート」の3つのモードがあります。

「即時アップデート」

選択したデバイスのステータスがオンラインである限り、適用した直後に新しいファームウェアのダウンロードとインストールを開始します。

「設定時間アップデート」

選択したデバイスは新しいファームウェアのダウンロードを開始し、設定された時間にインストールします。アップデート時間を設定するには歯車アイコンをクリックして、「アップデート時間」の右側にある日付フィールドをクリックすると、 カレンダーが表示されます。アップデート日時はこのカレンダーから選択するか、日付フィールドに入力することで実行日時を指定します。入力のあと、[確定]ボタンをクリックすることで、アップデート日時の設定が完了します。

設定時間アップデート

「マニュアルアップデート」

選択したデバイスは、デバイスから手動でアップデートを確認するまで、新しいファームウェアのダウンロードを開始しません。

アップデート範囲とアップデートモードを選択した後、[適用]ボタンをクリックすると、アップデート確認画面が表示されます。

アップデート適用

アップデートするデバイスのシリアルナンバーとタイプを確認し、[配信]ボタンをクリックしてください。アップデートステータスが更新され、デバイスとファームウェア情報のリストでアップデートプロセスを確認できます。

アップデート確認

13.1.2 ファームウェアのアップデートをキャンセル

配信されたファームウェアのアップデートはキャンセルすることができます。

デバイスのステータスが「デバイスがオンラインになるまで待機中」「ダウンロード中」「インストール待機中」の場合、アップデートをキャンセルできます。

アップデートをキャンセルしたいデバイスのチェックボックスを選択し、[アップデートのキャンセルする]ボタンを選択して、[適用]ボタンをクリックします。

ファームウェアアップデートをキャンセルする

アップデートをキャンセルすると、ステータスが「デバイスがオンラインになるまで待機中」のデバイスは、バージョン更新通知を受信しなくなります。「ダウンロード中」または「インストール待機中」のデバイスのアップデートも、「すぐにキャンセルされます。」というメッセージが表示されます。この後、[確定]ボタンをクリックすると、アップデートがキャンセルされます。キャンセル後、デバイスはアップデートを停止し、ダウンロードしたすべての情報が削除されます。

13.1.3 ファームウェアのエクスポート

ファームウェア情報の一覧をCSVファイルへエクスポートすることができます。

ナビゲーションメニューの[アップデート]→[ファームウェア管理]をクリックしてください。デバイスとファームウェアの一覧が表示されます。一覧上部にあるエクスポートをクリックしてください。

ファームウエアのエクスポート

「リスト内のすべてのデバイス情報をエクスポートします。 総数は{N}台です。」というメッセージが表示されます。確定ボタンをクリックすると、ファームウェア情報が記載されたCSVファイルが利用中のPCに保存されます。

以下のCSVファイル名で保存されます。[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS]はエクスポート日時です。ファームウェアのアップグレード_[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS].csv

13.2 アプリケーション管理

アプリケーション管理では、SenseLinkに連携している顔認証デバイスとそれらのアプリケーションの情報を表示できます。

ナビゲーションメニューの[アップデート]→[アプリケーション管理]をクリックしてください。デバイスとアプリケーションの一覧が表示されます。

アプリケーション管理画面

「ステータス」フィールドは、デバイスのリアルタイムアップデートステータスを表します。アップデートステータスの詳細は次のとおりです。

ステータス

詳細

更新可能なアプリケーションがあります

アップデート可能な新しいアプリケーションがあります。

デバイスがオンラインになるまで待機中

デバイスがオフラインのため、アップデートを開始できません。アップデートするには、デバイスをオンラインにしてください。

ダウンロードを待っています

デバイスはオンラインですが、管理者はデバイスのアップデートを確認していません。手動アップデートモードで表示されます。

ダウンロード中...10%

デバイスへアプリケーションをダウンロードしています。数値はダウンロードの進捗値です。

インストール待機中

デバイスはダウンロードを完了し、スケジュールされた時間までインストールを待機しています。設定時間アップデートモードで表示されます。

インストール中

アプリケーションをデバイスへインストールしています。

最新のアプリケーションがインストール済です

デバイスは最新のアプリケーションにアップデートされました。

アップデートに失敗しました:ネットワーク異常

ネットワークエラーが発生しました。ネットワークをチェックして安定していることを確認してから、アップデートを再試行してください。

アップデートに失敗しました:ダウンロードスペースが足りません

デバイスに十分な空き容量がないため、アプリケーションのダウンロードに失敗しました。不要なデータを消去してから、アップデートを再試行してください。

アップデートに失敗しました:ファイルのダウンロードに失敗しました

なんらかの理由でアプリケーションのダウンロードに失敗しました。ネットワークをチェックして安定していることを確認してから、アップデートを再試行してください。

アップデートに失敗しました:APKファイルがありません

ダウンロードしたファイルにアプリケーションファイルが見つかりません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:最新バージョンではありません

ダウンロードしたアプリケーションは、最新バージョンではありません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:パッケージ名エラー

アプリケーションパッケージ名が間違っており、このデバイスタイプに適したアプリケーションタイプではないため、インストールできません。JCV製品窓口にお問い合わせください。

アップデートに失敗しました:インストールタイムアウト

インストールに時間がかかりすぎました。デバイスの状態を確認してから、アップデートを再試行してください。

アップデートに失敗しました:ダウンロードが中断されました

予期しないエラーが発生しました。JCV製品窓口にお問い合わせください。

SensePass V1.2.5以下のバージョン、SenseThunder-E V1.1.5以下のバージョン、およびSenseThunder-Mini V1.0.9より前のバージョンの場合、ステータスの「ダウンロード中」、「インストール待ち」、「インストール中」の進捗数値、 「アップデートが失敗しました」の表示はサポートされていません。

デバイスが「ダウンロード中」の場合、ステータスにマウスを合わせると経過時間を確認できます。ダウンロードに時間がかかりすぎる場合は、アップデートをキャンセルするか、デバイスの状態を確認してください。

13.2.1 アプリケーションのアップデート配信

デバイスをアップデートする際に、さまざまなオプションが用意されています。

「更新可能なアプリケーションがあります」または「アップデートが失敗しました」のステータスとなっているデバイスには、一括してアップデートを適用できます。すべてのデバイスをアップデートするには、[適用]ボタンの下と、[デバイス名]ラベルの左側にあるチェックボックスを選択します。 アップデート範囲を指定するには、アップデートするデバイスのチェックボックスのみを選択します。

アップデート範囲指定

アップデートには、「即時アップデート」、「設定時間アップデート」、「マニュアルアップデート」の3つのモードがあります。

「即時アップデート」

選択したデバイスのステータスがオンラインである限り、適用した直後に新しいアプリケーションのダウンロードとインストールを開始します。

「設定時間アップデート」

選択したデバイスは新しいアプリケーションのダウンロードを開始し、設定された時間にインストールします。アップデート時間を設定するには歯車アイコンをクリックして、「アップデート時間」の右側にある日付フィールドをクリックすると、 カレンダーが表示されます。 アップデート日時はこのカレンダーから選択するか、日付フィールドに入力することで実行日時を指定します。入力のあと、[確定]ボタンをクリックすることで、アップデート日時の設定が完了します。

設定時間アップデート

「マニュアルアップデート」

選択したデバイスは、デバイスから手動でアップデートを確認するまで、新しいアプリケーションのダウンロードを開始しません。

アップデート範囲とアップデートモードを選択した後、[適用]ボタンをクリックすると、アップデート確認画面が表示されます。

アップデート適用

アップデートするデバイスのシリアルナンバーとタイプを確認し、[配信]ボタンをクリックしてください。アップデートステータスが更新され、デバイスとアプリケーション情報のリストでアップデートプロセスを確認できます。

アップデート確認

13.2.2 アプリケーションのアップデートをキャンセル

配信されたアプリケーションのアップデートはキャンセルすることができます。デバイスのステータスが「デバイスがオンラインになるまで待機中」「ダウンロード中」「インストール待機中」の場合、アップデートをキャンセルできます。

アップデートをキャンセルしたいデバイスのチェックボックスを選択し、[アップデートのキャンセルする]ボタンを選択して、[適用]ボタンをクリックします。

アプリケーションアップデートをキャンセルする

アップデートをキャンセルすると、ステータスが「デバイスがオンラインになるまで待機中」のデバイスは、バージョン更新通知を受信しなくなります。「ダウンロード中」または「インストール待機中」のデバイスのアップデートも、「すぐにキャンセルされます。」というメッセージが表示されます。この後、[確定]ボタンをクリックすると、アップデートがキャンセルされます。キャンセル後、デバイスはアップデートを停止し、ダウンロードしたすべてのデータが削除されます。

13.2.3 アプリケーションのエクスポート

アプリケーション情報の一覧をCSVファイルへエクスポートすることができます。

ナビゲーションメニューの[アップデート]→[アプリケーション管理]をクリックしてください。デバイスとアプリケーションの一覧が表示されます。一覧上部にあるエクスポートをクリックしてください。

アプリケーションのエクスポート

「リスト内のすべてのデバイス情報をエクスポートします。 総数は{N}台です。」というメッセージが表示されます。確定ボタンをクリックすると、アプリケーション情報が記載されたCSVファイルが利用中のPCに保存されます。

以下のCSVファイル名で保存されます。[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS]はエクスポート日時です。 アプリケーションのアップグレード_[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS].csv

12 システム

企業情報管理やSenseLinkを運用するシステムの設定など、主にシステム管理者の方が利用するシステム管理について記載されています。

12.1 企業情報の管理

企業名や企業ロゴ、プロフィールなどの企業情報を管理できます。

ナビゲーションメニューの[システム]→[企業情報]をクリックしてください。

企業情報画面

以下の項目を登録できます。

項目

概要

企業ロゴ

HDMIエクスポート機能を持つSensePass Pro、またはSenseThunder-E を外部ディスプレイに接続した際に表示されます。推奨サイズは100×620ピクセル以下です

背景

SensePass ProまたはSenseThunder-Eの認証時の背景に利用されます。SensePass ProまたはSenseThunder-E を外部ディスプレイに接続した際にも表示されます。推奨サイズは1,080×720ピクセル以下です

企業名

必須項目です

従業員情報の部署名の最上位層の名前として表示されます。1~30文字(半角換算)で指定できます

Welcome メッセージ

HDMIエクスポート機能を持つSensePass Pro、またはSenseThunder-Eを外部ディスプレイに接続した際に表示されます。デバイスの設定で表示オプションをONにした場合のみ表示されます。0~255文字(半角換算)で指定できます

プロフィール

0~255文字(半角換算)で指定できます

12.2 システムの設定

SenseLinkのシステム設定を行うことができます。

ナビゲーションメニューの[システム]→[システム設定]をクリックしてください。 システム設定項目が表示されます。

システム設定画面

この画面では以下の項目を設定できます。

項目

概要

レコードの設定

保存

デフォルトでOFFになっています。OFFにすると、デバイスの設定によらず、レコードはSenseLinkに保存されません。

削除

クリックすると、SenseLinkに保存されたレコードが削除されます。この操作はデバイスに保存されたレコードに影響しません。

通知設定

デフォルトでONになっています。OFFにすると、ダッシュボードでは「アカウントの有効期限が近づいています」というシステム通知が非表示になります。

IP制限

デフォルトで OFFになっています。本機能をONにし、信頼できるIPアドレスやIPアドレスの範囲を設定すると、設定されたIPアドレスを持つコンピュータだけが Webブラウザから SenseLink Cloud にログインできるようになります。

顔写真の登録

承認機能

顔写真のセルフ登録時の承認の有無を設定します。

QRコード

顔写真のセルフ登録ページのURLが表示されます。

URL

顔写真のセルフ登録ページのURLです。

12.2.1 レコードの設定

レコードを削除しても、ダッシュボードで表示している当日分の集計値は変わりません。

認証デバイスのレコードをSenseLinkに保存しないようにしたり、すでに保存されたレコードを削除することができます。このメニューの対象となるレコードは、以下のものです。なお、オペレーションログは削除されません。

  • 認証レコード

  • 登録者別 認証レコード

  • 勤怠レコード

  • 従業員別 勤怠レコード

  • デバイスアラート

レコードの設定

12.2.2 通知設定

デフォルトでONになっています。OFFにすると、ダッシュボードでは「アカウントの有効期限が近づいています」というシステム通知が非表示になります。

12.2.3 IP制限

SenseLink Cloud にログインできるIPアドレスやIPアドレス範囲を制限する機能です。デフォルトで OFFになっています。ユーザーがWebブラウザを使ってSenseLink Cloudにログインした場合、指定されたIPアドレスだけがログイン可能となり、指定外のIPアドレスからのログインはできなくなります。

Super Admin ユーザーのみ、IP制限機能の設定変更が可能です。

IP制限は Super Admin ユーザーにも適用されます。Super Admin ユーザーがログインできない状態にならないようにご注意ください。

Super Admin ユーザーがログインできない状態となった場合は、JCVサポート窓口までご連絡ください。

IP制限の有効化・無効化

IPアドレスやIPアドレス範囲の登録を行うには、IP制限欄の登録ボタンをクリックしてください。信頼できるIPアドレスやIPアドレスの範囲、その説明(自由記述)を登録できます。

設定後、保存ボタンをクリックして完了します。IPアドレス範囲を登録する場合、CIDRが入力必須となります。

IPアドレス/IPアドレス範囲は、最大100個まで登録できます。

[登録]ボタン上の説明文にご利用中のIPアドレスを自動に表示しております。説明文最後のマークをクリックすると、コピーできます。

更新ボタンや削除ボタンをクリックすると、信頼されるIPアドレスの設定を更新、削除できます。

12.2.4 顔写真の登録

従業員自身で顔写真の登録や更新を行うためのセルフサービスページへのアクセスURLが表示されます。

従業員による顔写真のセルフ登録については、4 顔写真のセルフ登録 を参照ください。

12.3 オペレーションログ

Super Adminユーザーはすべてのアカウントのオペレーションログ、Sub Adminユーザーは自身以下のユーザーのオペレーションログ、その他のロールのユーザーは自身のアカウントのオペレーションログを確認することができます。

ナビゲーションメニューの[システム]→[オペレーションログ]をクリックしてください。オペレーションログが表示されます。

オペレーションログ画面

オペレーションログには、以下の項目が記録されています。

項目

概要

アカウント名

操作したアカウントのアカウント名

アカウント

操作したアカウント

ロール

操作したアカウントのロール

メニュー

操作したメニュー。以下いずれかが記録されます

  • デバイス

  • 従業員

  • ビジター

  • 拒否リスト

  • ログイン

  • アクセス

  • 勤怠

  • アカウント管理

項目

操作した項目。デバイスまたはWebが記録されます

イベント

発生したイベントが記録されます。

IP

操作したクライアントIPアドレス

結果

操作結果

時間

操作日時

特記事項

(サポートされない機能です。利用できません。)

詳細

複数登録または修正を行なった場合に、登録結果がエクスポートされます。

オペレーションログはExcelファイルにエクスポートすることができます。オペレーションログ画面上のエクスポートボタンをクリックしてください。

「エクスポートされたExcelファイルのパスワードは現在のアカウントです」というメッセージが表示されます。Confirmボタンをクリックすると、オペレーションログが記載されたExcelファイルがご利用中のPCに保存されます。

以下のExcelファイル名で保存されます。[YYYY]-[MM]-[DD]はオペレーションログの絞り込み検索で設定された開始日時と終了日時が指定されます。 オペレーションログ_[YYYY]-[MM]-[DD]_[YYYY]-[MM]-[DD].xlsx

ファイルを開く際にパスワードを求められます。パスワードは、ファイルエクスポート時にログインしていたアカウントのパスワードです。 

12.4 契約プラン

利用中のビジネスプランと機能権限を確認することができます。

ナビゲーションメニューの[システム]→[契約プラン]をクリックしてください。契約プランが表示されます。

契約プラン画面

ここで表示されるプランは実在はしません。プラン内容の詳細はJCVライセンスガイドに参照ください。

2.1 システムのAPI

2.1.1 バージョン番号の取得 (/api/v3/server/version)

概要

現在のシステムのバージョン番号を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/server/version

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

2.1.2 企業情報の取得 (/api/v1/company)

概要

企業情報を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/company

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください

timestamp

string

必須

タイムスタンプ

{
    "code": 200,
    "message": "OK",
    "data": {
        "date": "20201229",
        "edition": "2.3.8-build287"
    },
    "desc": ""
}

パラメーター名

型

説明

edition

string

バージョン番号

date

string

バージョンのリリース日

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 58,
        "name": "日本コンピュータビジョン",
        "logo": "5b238d7ec6681b0001466d5e",
        "background": "5b238d7ec6681b0001466d5f",
        "welcome": "日本コンピュータビジョンへようこそ ",
        "introduction": "独創性をもち、AIと人類の進歩を牽引する企業",
        "contact": "太郎",
        "createAt": "2020-05-28 17:31:32.0",
        "updateAt": "2020-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": ""
    }
}

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

パラメーター名

型

説明

id

int

企業ID

name

string

企業名

logo

string

ロゴ ID

background

string

背景 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

ライセンス有効終了時間

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

2.11 認証レコード+API

認証レコード+APIを利用するには、「SenseLink Cloud ID Pack Annual Subscription(以下、ID Pack)の契約が必要です。

認証レコード+には、過去3ヶ月の認証レコードが保持できます。

2.11.1 顔認証&認証レコード+の生成 (api/v1/plus/record)

概要

顔写真データを SenseLink Cloud に送信し、サーバー顔認証を実施、認証レコードを"認証レコード+"に保存します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/record

リクエスト方法

POOST

リクエストパラメーター

名前

形式

必須

説明

sn

String

Y

デバイスのシリアルナンバー

timestamp

int

Y

画像記録時間 (Unixのタイムスタンプ形式:1658136457)

timezone

String

N

”GMT+9:00“

threshold

float

N

顔認証の類似度のしきい値 [0, 1]の範囲 1:Nの利用時に、この値を利用 デフォルト:0.9

image

Object

Y

顔画像

process_mode

int

N

APIの処理モード 0:非同期、user_id を返さない。画像検索処理は非同期。 (0以外のパラメータは未サポート)

extend

Json String

N

認証レコードに入力できる拡張項目。 サイズは最大1K Byte

image objectについて

名前

形式

必須

説明

data

String

Y

Base64でエンコードされた顔画像 制限:1MByte以下、フォーマットはJPG/PNGであること

rectangle

Object

N

画像内の領域範囲の指定。 領域内の最も大きい顔を検出。下記4つのパラメータを指定。

rectangleで指定するパラメータ

名前

形式

必須

説明

top

int

N

領域の最上部

left

int

N

領域の左端

width

int

N

領域の幅

height

int

N

領域の高さ

レスポンスフィールド

名前

形式

説明

code

int

message

string

data

object

dataフィールド

名前

形式

説明

record_id

long

認証レコードのID

image_id

認証レコードのスナップショットのID

リクエスト

{
    "sn":"JKQ00009234",
    "timestamp": 1659423903029,
    "threshold": 0.92,
    "extend":"{\"device_name\":\"xxxxx\"}",
    "image":{
        "data":"base64 encode image",
        “/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJ
                     <中略>
         SdP0ykG0WjdF3AfoumAO6DRmyYC5SQ//2Q==“
        "rectangle":{
            "top":12,
            "left":32,
            "width":84,
            "height":23
        }
    }
}

レスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
       "record_id":930490000,
       "image_id": "5fceef6e1ddb2800010d1409"
}

2.11.2 認証レコード+ の取得 (/api/v1/plus/record)

概要

認証レコード+ を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/record

リクエスト方法

GET

リクエストパラメーター

名前

形式

必須

説明

time_from

string

Y

認証レコードの取得範囲の開始時刻(SenseLinkがレコードを保存した時刻) 例:2022-12-11T00:00:00+09:00

time_to

string

Y

認証レコードの取得範囲の終了時刻(SenseLinkがレコードを保存した時刻) 例:2022-12-11T23:59:59+09:00 制限:time_to - time_from で指定できる範囲は最大24時間まで。

sn

string

N

デバイスのシリアルナンバー

order

int

N

0:レコードIDで降順

1:レコードIDで昇順(デフォルトは0)

page

int

N

ページ番号(初期値は1)

size

int

N

各ページのエントリ数(デフォルトは20、最大は100)

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"page_num": 2,
		"page_size": 10,
		"total": 10,
		"list": [{
			"record_id": 1392523, // SenseLink CloudのレコードID
			"sn": "SN1234012345123", // デバイスのシリアルナンバー
			"image_id": "5fceef6e1ddb2800010d1409", // SenseLink Cloudの画像ID画像
			"user_id": 123, // SenseLink CloudのユーザーID
			"verify_score": 0.959, // 類似度のレベル
			"device_timestamp":130000000, // デバイスのタイムスタンプ
			"timezone":"GMT+9:00", // デバイスのタイムゾーン
			"create_at":130000000, // SenseLink Cloudがレコードを生成した時間 
			"extend":"Json string" // デバイスの拡張情報
		}],
	}
}

2.11.3 認証レコード+ スナップショット取得 (/api/v1/plus/image/{image_id})

概要

認証レコード+に登録された、認証レコードのスナップショットデータを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/plus/image/{image_id}

リクエスト方法

GET

リクエストパラメーター

名前

形式

必須

説明

{image_id}

string

Y

認証レコード+に登録された、認証レコードのイメージID

通常のレスポンス

顔写真のバイナリーストリームデータ

2.3 デバイスアラートの API

2.3.1 デバイスアラートの取得 (/api/v2/device/alarm/list)

概要

デバイスアラートのリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device/alarm/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

dateFrom

string

No

yyyy-MM-dd 形式の開始時間

dateTo

string

No

yyyy-MM-dd 形式の終了時間

deviceId

long

No

デバイスのID

code

int

No

アラートのタイプ

10001:デバイスの盗難アラート

10002 :ドア・ゲート強制突破アラート

10003:ドアセンサータイムアウト

10004:パスワードクラッキング

10005 :(サポートされないアラートです。現在利用できません)

10006:サーモカメラ接続異常

20001:カメラの汚れ

20002:Non-Living アタック(非生体による認証)

20003:消防アラート

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

status

int

No

アラートのステータス

0:すべて

1:アラート作動中

2:解除中

3:解除済み

page

int

No

ページ番号(デフォルトは 1)

size

int

No

ページサイズ(デフォルトは 20、最大 1000)

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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": "SenseGate.ChenXiaoZhao",
                  "deviceSn": "SGBD-b8b2201baea00d3918c49989838d81c0",
                  "userId":0,
                  "alarmTimeL": 1566376557395,
                  "id": 378018,
                  "deviceLocation": "306.Michael",
                  "status": 0
                  "releaseTimeL":1635404432323
           }],
           "size": 20,
           "totalPage": 32,
           "pageSize": 20,
           "pageNum": 1
    }
}

レスポンスのフィールド

パラメーター名

型

説明

total

int

総計

size

int

サイズ

data

object

データ

page_num

int

現在のページ番号

page_size

int

ページサイズ

total_page

int

ページ合計

dataフィールドの説明

パラメーター名

型

説明

id

long

アラートレコードのID

level

int

アラートのレベル。 1 は通常のアラートを示し、2 は異常を示します

code

int

アラートのタイプ

10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

10003:ドアセンサータイムアウト

10004:パスワードクラッキング

10005:(サポートされないアラートです。現在利用できません)

10006:サーモカメラ接続異常

20001:カメラの汚れ

20002:Non-Living アタック(非生体による認証)

20003:消防アラート

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

description

string

アラートの説明

status

int

アラートのステータス

0:解除する必要がありません

1:アラート作動中

2:解除中

3:解除済み

traceId

string

デバイスが生成するアラートのシリアル番号であり、アラートの固有の識別番号です。

deviceId

long

デバイスID

deviceName

string

デバイス名

deviceSn

string

デバイスの LDID 番号

deviceLocation

string

デバイスの設置場所

alarmTime

string

アラート時間

alarmTimeL

long

アラートのタイムスタンプ(ミリ秒単位)

releaseTimeL

long

アラートリリースのタイムスタンプ(ミリ秒単位)

alarmPhoto

string

アラート写真

resolveOption

int

アラートの解除オプション

0:解除不要

1:デバイスエンドでの解除のみをサポート

2:リモート解除のみをサポート

3:デバイスエンドまたはリモートでの解除

0:解除不要

10004:パスワードクラッキング

20002:Non-Living アタック(非生体による認証)

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

1:デバイスエンドでの解除のみをサポート

10003:ドアセンサータイムアウト

10005:(サポートされないアラートです。現在利用できません)

10006:サーモカメラ接続異常

20001:カメラの汚れ

3:デバイスエンドまたはリモートでの解除 10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

20003:消防アラート

userId

long

登録者ID 。コード内でパスされます。40001

userName

string

登録者名。コード内でパスされます。40001

userType

int

登録者のタイプ

1:従業員

2:ビジター

3:拒否リストコード内でパスされます。40001

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

開始時間が不正です

30001

Param Invalid

終了時間が不正です

30001

Param Invalid

ページサイズが大きすぎます

2.3.2 デバイスアラートの解除 (/api/v2/device/alarm/disarm)

概要

オンラインデバイスにアラート解除コマンドを送信します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device/alarm/disarm

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

traceId

string

Yes

アラートのシリアル番号

description

string

No

イベントの説明

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {}
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

498

Param Invalid

リモートで解除できないアラートです(以下のアラートタイプのみ

10004:パスワードクラッキング

20002:Non-Living アタック(非生体による認証)

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

10003:ドアセンサータイムアウト

10006:サーモカメラ接続異常

20001:カメラの汚れ)

620

Record non-existent Error

アラートは解除されています

620

Record non-existent Error

アラートのシリアル番号が存在しません

30001

Param Invalid

イベント説明が長すぎます

30001

Param Invalid

アラートのシリアル番号が空にできません

30001

Param Invalid

会社とグループが一致しません

50001

RPC FAILED

リモートサービスの呼び出しに失敗しました

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

10 イベント

認証レコードやアラートなど、様々なイベントを管理する機能について記載されています。

イベント画面では、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。

SensePass GE V1.2.3では、イベント機能、勤怠はサポートされません。

10.1 認証レコードの管理

Basicプランは30日間、Professionalプランは365日間、認証レコードが保存されます。 ご契約のプランについては、サービス開始時に契約担当者様に送付されるメール「サービス開始のご連絡」にてご確認ください。

ナビゲーションメニューの[イベント]→[認証レコード]をクリックしてください。認証レコードの一覧が表示されます。

以下の情報が認証レコードとして記録されます。認証結果やデバイスの設定によっては、空欄の場合があります。

表:認証レコード項目

項目

概要

スナップショット

認証時にデバイスが撮影した写真。一覧では顔部分のサムネイルのみ表示されますが、ホバーすると全体が表示されます

認証用写真(認証時写真)

登録者情報で認証用顔写真として登録された写真

※現在バグにより、画面上「認証時写真」と表示されています

ID写真

(サポートされない項目です)

氏名

氏名

登録者タイプ

従業員、ビジター、拒否リスト、未登録者、またはなりすましのいずれかが表示されます ※なりすましの詳細はの「なりすまし」を参照

認証方法

現在、顔認証のみサポートされています

グループ

所属する従業員グループ、ビジターグループ、または拒否リストグループ

拡張情報

デバイスからアップロードされる拡張情報が格納されます。 例: "勤怠フラグ:1"

方向

デバイスに設定された認証方向

デバイス名

デバイス名

異常検知タイプ

サポートされる異常検知タイプは以下のものです。その他の異常検知タイプはサポートされません

  • 来訪期間外

  • 勤務時間外

  • 異常な体温(温度異常)

  • マスク未着用

誤認証タイプ

をご参照ください。誤認証レコードの管理方法については次節をご参照ください

年齢

推定年齢

性別

推定性別

  • female:女性

  • male:男性

ヒゲ

推定ヒゲの生え状態

  • mustache_style_type_none:ヒゲなし

  • whiskers:ヒゲあり

メガネ

推定メガネの着用状態

  • glasses_style_type_none:メガネなし

  • transparent_glasses:透明なメガネ

  • sunglasses:サングラス

帽子

<SenseNebula専用項目>

推定帽子の着用状態

  • hat_style_type_none:帽子なし

  • cap:帽子あり

表情

時間

認証時間

マスク

未着用の場合「未着用」と表示されます。着用していた場合、何も表示されません

体温(温度)

デバイスの設定によらず摂氏で表示されます

表:誤認証タイプ

誤認証タイプ

概要

他人として認証

登録者が他の登録者として認証された場合

未登録者として認証

登録者が未登録者として認証された場合

Non-Livingとして認証

写真やビデオ、3Dマスクなどによるなりすましではないのに、生体認識の結果なりすましであると認識された場合

未登録者突破

未登録者が登録者として認証された場合

なりすまし

写真やビデオ、3Dマスクなどによるなりすましなのに、なりすましではないと認識された場合

「なりすまし」とは、第三者が写真やビデオ画像、3D顔マスク等を使って、別の人に偽装してシステムを利用したり、認証する活動を指します。SenseThunderなどのデバイスに備わっている生体検知機能において、生体として認識できなかった場合の認証レコードでは登録者タイプが「なりすまし」と表示されます。

表検索できる項目には、登録者タイプ、認証方法、誤認証タイプ、異常検知タイプ、登録者グループ、認証期間、デバイス、登録者名があります。 検索した項目を選択して検索ボタンをクリックしてください。検索結果が表示されます。

リセットボタンをクリックすると検索結果が解除され、デフォルトの一覧画面が表示されます。

登録者タイプの「その他」は現在開発中の項目のため、使用できません。

ユーザーのプライバシーを保護するために、特定のフィルターとキーワードによって認識レコードを削除できます。

認証レコードを削除しても、ダッシュボードで表示している当日分の集計値は変わりません。

認証レコードを削除すると、認証統計、勤怠レコード、勤怠統計に影響します。 記録は回復できません。 認証レコードを削除するときに、十分ご注意ください。

10.2 誤認証レコードの管理

SenseLinkのユーザーは認証レコードを確認し、認証結果が誤りだと判断した場合に誤認証のタグをレコードに付与して管理することができます。

誤認証タイプは前節の 表:誤認証タイプに記載されています。 誤認証タグを付与する認証レコードの認証時写真にマウスオーバーしてください。写真全体が表示され、写真の下部に「誤認証タグ」が表示されるのでクリックしてください。

誤認証タグ登録画面が表示されます。誤認証タイプを選択し、必要であれば特記事項欄に特記事項を記入して適用ボタンをクリックしてください。

「この操作は取り消ししません。タグをつけますか?」のメッセージが表示されます。この情報でよければ、確定ボタンをクリックしてください。

誤認証タグを付与した認証レコードの誤認証タイプ欄に、付与したタグが表示されていることを確認してください。

10.3 登録者別 認証レコードの管理

登録者別に認証レコードを管理することができます。

ナビゲーションメニューの[イベント]→[登録者別 認証レコード]をクリックしてください。登録者別の認証レコードの概要が表示されます。登録者の認証レコードの詳細を確認する場合は、設定欄の詳細をクリックしてください。

認証レコードページに遷移し、選択した登録者のみの認証レコードが一覧で表示されます。

デフォルトでは、認証を行なっていない登録者は一覧に表示されません。認証していない登録者を表示させるには、検索欄にある「未認証登録者を表示」にチェックを入れてください。

10.4 デバイスアラートの管理

デバイスが検知した様々なアラートを管理することができます。

Basicプランは30日間、Professionalプランは365日間、デバイスアラートが保存されます。 ご契約のプランについては、サービス開始時に契約担当者様に送付されるメール「サービス開始のご連絡」にてご確認ください。

SensePass GE V1.2.3では、発生したアラートの管理はサポートされません。

ナビゲーションメニューの[イベント]→[デバイスアラート]をクリックしてください。デバイスアラートの一覧が表示されます。

表:アラートタイプ

アラートタイプ

概要

盗難アラート

デバイスにある盗難アラートボタンが押された場合に発生します

ドア・ゲート強制突破アラート

通行者が規定の方法以外でドアまたはゲートの通行(突破)したことを検知した場合に発生します。デバイス側でGPIO端子によるドア開閉センサーの設定がされている場合のみ有効です

ドアセンサータイムアウト

デバイスの設定項目「ドアオープンタイム」の設定時間内にドアの開閉が終了しない場合に発生します。デバイス側でGPIO端子によるドア開閉センサーの設定がされている場合のみ有効です

パスワードクラッキング

デバイスでパスワードの入力を5回間違った場合に発生します。不審者による不正ログインを検知できます

オフラインアラート

デバイスの故障またはネットワーク、その他が原因でデバイスがSenseLinkに接続されない状態を「オフライン」と呼びます。デバイスがオフラインになった場合に発生します

Bluetooth 電池残量低下

(サポートされない機能です。利用できません)

サーモカメラ接続アラート

SenseThunderシリーズのサーモグラフィカメラ部分の接続に不具合がある場合に発生します

RGBカメラ異常

(サポートされない機能です。利用できません)

IRカメラ異常

(サポートされない機能です。利用できません)

カメラ汚れ

SenseNebulaシリーズにおいて、カメラ部分の汚れ等により認証ができない場合に発生します

Non-living アタック

写真やビデオ、3Dマスクなどによるなりすましを検知した場合に発生します

消防アラート

デバイス側でGPIO端子による消防アラートシステム等との接続設定がされている場合のみ有効です

特徴量抽出エラー

顔認証時にデバイスが顔特徴量の抽出に失敗した場合に発生します

検索項目として、日付、デバイス、アラートタイプ、アラートのステータスがあります。検索したい項目を設定し、検索ボタンをクリックしてください。検索結果が表示されます。

アラートを確認後、アラートを解除することができます。 アラート発生中の場合、アラート一覧のアラートステータスが「アラート発生中」となります。解除したいアラートの「アラート解除」ボタンをクリックしてください。 ステータスが「アラート発生中」から「解除完了」になります。

オフラインでデバイスアラートを生成した後でオンラインにした場合、初回のみダッシュボード上に警告が表示されることがあります。表示された場合は画面を再表示(リロード)することで、警告は表示されなくなります。

サーモカメラ接続アラートは、SenseLinkからアラート解除を行うことができません。SenseThunderシリーズをSenseLinkに接続した状態で、サーモカメラをSenseThunderシリーズのデバイスへ接続すると、自動的にSenseLink上のアラートが解除されます。

10.5 認証レコードのエクスポート

認証レコードの一覧を最大100,000件までExcelファイルへエクスポートすることができます。ただし写真はエクスポートできません。

ナビゲーションメニューの[イベント]→[認証レコード]をクリックしてください。認証レコード一覧が表示されます。検索したレコードのみエクスポートする場合は、検索条件を選択して検索ボタンをクリックしてください。

一覧上部にあるエクスポートをクリックしてください。

追加エクスポートフィールド選択画面が表示されます。Excelファイルに追加でエクスポートしたいフィールドを選択し、確認をクリックしてください。

エクスポートフィールドは以下です。

フィールド

デフォルト

氏名

Yes

登録者タイプ

Yes

グループ

Yes

方向

Yes

デバイス

Yes

時間

Yes

認証方法

Yes

ICカード番号(デバイスで読み取った番号)

Yes

IDカード番号(デバイスで読み取った番号)

(サポートされない機能です。利用できません)

Yes

異常検知タイプ

Yes

携帯電話番号

No

部署

No

役職

No

従業員番号

No

ICカード番号

No

メールアドレス

No

IDカード

No

温度

No

マスク検知

No

顔の属性

No

拡張情報

No

「エクスポートされたExcelファイルのパスワードは現在のアカウントです」というメッセージが表示されます。確定ボタンをクリックすると、認証レコードが記載されたExcelファイルがご利用中のPCに保存されます。

以下のExcelファイル名で保存されます。[YYYY]-[MM]-[DD]_[HH]_[MM]_[SS]は、認証レコード一覧検索で設定された開始日時と終了日時が指定されます。 認証レコード_[YYYY]-[MM]-[DD] [HH]_[MM]_[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]_[SS].xlsx

Excelファイルを開くには、パスワードを入力する必要があります。パスワードはExcelファイルエクスポートを行なったユーザーのアカウントです。

10.6 登録者別 認証レコードのエクスポート

登録者別 認証レコードのサマリーを最大100,000件までExcelファイルへエクスポートすることができます。ただし写真はエクスポートできません。

ナビゲーションメニューの[イベント]→[登録者別 認証レコード]をクリックしてください。認証レコード一覧が表示されます。検索したレコードのみエクスポートする場合は、検索条件を選択して検索ボタンをクリックしてください。

一覧上部にあるエクスポートをクリックしてください。追加エクスポートフィールド選択画面が表示されます。Excelファイルに追加でエクスポートしたいフィールドを選択し、確認をクリックしてください。

エクスポートフィールドは以下です。

フィールド

デフォルト

氏名

Yes

登録者タイプ

Yes

グループ

Yes

初回アクセス(検索期間範囲での初回認証時間)

Yes

最終アクセス(検索期間範囲での最終認証時間)

Yes

合計(合計の認証回数)

Yes

携帯電話番号

No

部署

No

役職

No

従業員番号

No

ICカード番号

No

メールアドレス

No

IDカード(サポートされない機能です。利用できません)

No

「エクスポートされたExcelファイルのパスワードは現在のアカウントです」というメッセージが表示されます。確定ボタンをクリックすると、認証レコードが記載されたExcelファイルがご利用中のPCに保存されます。

以下のExcelファイル名で保存されます。[YYYY]-[MM]-[DD] [HH]_[MM]_[SS]は認証レコード一覧検索で設定された開始日時と終了日時が指定されます。登録者別認証レコード_[YYYY]-[MM]-[DD] [HH]_[MM]_[SS]_[YYYY]-[MM]-[DD] [HH]_[MM]_[SS].xlsx

Excelファイルを開くには、パスワードを入力する必要があります。パスワードはExcelファイルエクスポートを行なったユーザーのアカウントです。

10.7 認証レコード+

APIマニュアルの「2.10 イベントサブスクリプション API」に記載された、顔認証のレコードを作成することができます。認証レコード+は、そこで作成されたレコードを表示するためのUIです。

認証レコード+のUIで表示される情報は以下です。

表示情報における注意点 ・表示範囲は最大1週間 ・SenseLink Cloud ID Pack Annual Subscription(ID Pack)の利用プランのみ表示

表示される情報

スナップショット

認証時写真

氏名

登録者タイプ

グループ

時間 (APIで指定した時間)

10.7.1 認証レコードの検索とエクスポート

条件に合うデータを検索したり、エクスポートしたりすることができます。期間を設定し、登録者タイプやグループ名、氏名などが指定できます。

検索条件は、さまざまな条件が用意されている

認証レコード+の利用において、以下の注意・制限事項があります。 ・検索範囲は最大1週間 ・保存されるデータは3ヶ月以内 ・利用には SenseLink Cloud ID Packの購入が必須 ・顔写真のサイズは1MB以下、対応フォーマットはJPGとPNG

誤認証タイプ
表: 誤認証タイプ

4 ダッシュボード

ログイン後のトップページとして表示されるダッシュボードについて記載されています。

4.1 ダッシュボード概要

ログインすると、以下のようなダッシュボード画面が表示されます。

ダッシュボード

ダッシュボードは主に、以下の3つのエリアに分かれます。各エリアについては、次節以降で説明します。

ダッシュボードの各エリア

4.2 エリアA:ナビゲーションメニュー

エリアAでは、SenseLinkのナビゲーションメニューが表示されます。それぞれのメニューの詳細は、本章以降の各章で説明されます。また一部のメニューは、一部のユーザーからのみ操作/参照できます。各ユーザーが持つ権限の詳細については、4.5.1節 ユーザーの種類(ロール)をご参照ください。プロジェクトの詳細については、4.6章 プロジェクトをご参照ください。

カテゴリー

メニュー名

概要

プロジェクト

デバイス、アクセス、イベント、勤怠、アップデートなど、さまざまなデータ情報がプロジェクトにより、分離されています。 権限は、ユーザーのロールと、デバイス対するプロジェクトの権限によって決定されます

プロジェクトリスト

現在のユーザーがアクセスできるプロジェクトのリスト

ダッシュボード

当日の認証レコードやデバイスのステータスなどをダッシュボード画面で確認できます

デバイス

顔認証デバイスの登録や削除、設定変更などを行います

アクセス

デバイスや登録者グループごとに、アクセス・認証可能な期間や時間帯を設定します

イベント

認証レコードや登録者別認証レコード、デバイスアラートを管理します

勤怠

勤務日や休日、出退勤時間を登録し、従業員の勤怠を管理します

アップデート

デバイスのファームウェアとアプリケーションのアップデートを管理します

共通

共通メニューは、すべてのプロジェクトで表示されます。 権限は、ユーザーのロールと、ユーザーのグループに対する権限によって決定されます

登録者タイプ

従業員、ビジター、拒否リストなど、顔認証を行う対象者の情報を登録管理します

システム

企業情報の管理、 Platformの管理、操作ログ管理など、システム管理者向けの機能を管理します

4.3 エリアB:ヘッダーメニュー

エリアBでは、SenseLinkのヘッダーメニューが表示されます。

4.3.1 ヘッダーメニューの各種ボタン

ハンバーガーボタン:

設定ボタン:

表:ヘッダーメニュー一覧

ボタン

機能・設定項目

ハンバーガーボタン

ナビゲーションメニュー(エリアA)の縮小表示、通常表示を操作できます デフォルトでは通常表示が選択されています

設定ボタン

ダッシュボードの表示方法の設定を行います

詳細は を確認してください

ドキュメント

当ドキュメントのトップページへ遷移します

言語の選択

SenseLinkの表示言語設定を行います 日本語、英語(English)、簡体中国語(簡体中文)、繁体中国語(繁體中文)、韓国語(한국어)から選択できます

[ユーザー名]

[ユーザー名]をクリックすると、[SenseLinkについて]、[パスワードを変更]、[ユーザー]、[プロジェクト]、[オープンプラットフォーム]、[ログアウト]が選択できます※

※ユーザーのロールによっては、一部表示されないボタンがあります

  • [SenseLinkについて]を選択すると、利用中のSenseLinkの概要が表示されます

  • [パスワードを変更]を選択すると、パスワード変更画面が表示されます

  • [ユーザー]を選択すると、ユーザー管理画面が表示ます。Super AdminとSub Adminユーザーのみが利用できます。詳細はをご参照ください

  • [プロジェクト]を選択すると、プロジェクト管理画面が表示ます。プロジェクトを作成、変更、および削除できるのは、Super Adminユーザーのみです。それ以外のユーザーは、自分が権限を持っているプロジェクトのみを参照できます。詳細はをご参照ください

  • [オープンプラットフォーム]を選択すると、OpenAPIとイベントサブスクリプション管理画面が表示されます。Super Adminユーザーのみが利用できます。詳細は詳細はをご参照くださいをご参照ください

  • [ログアウト]を選択すると、ログアウトされます SenseLink利用後は、必ずログアウトしてください

4.3.2 ダッシュボードの設定

ダッシュボードの設定は、設定(歯車マーク)ボタンをクリックして行うことができます。

表:ダッシュボードの設定

タイプ

設定項目

概要

デフォルト/温度

展示会モード

ナビゲーションメニューを表示させない[展示会モード]のON/OFF設定を行います デフォルトでは「OFF」が選択されており、ナビゲーションメニューが表示されます

デフォルト

自動更新

ダッシュボードに表示される各統計・ステータスを自動更新する設定を行います デフォルトでは「OFF」が選択されており、自動更新されません ONにした場合、更新インターバル設定が表示され、1秒〜20秒の間で自動更新の間隔を設定できます ダッシュボードタイプで検温(温度検知)が選択されている場合、この項目は設定できません

デフォルト/温度

アラート表示

各種アラートが発生した場合、ダッシュボードにアラートを表示させるかを設定できます デフォルトでは「ON」が選択されています アラートが発生すると、赤枠のアラートがダッシュボード上に表示されます

デフォルト/温度

ダッシュボードタイプ

デフォルトまたは検温(温度検知)を選択できます 検温(温度検知)ダッシュボードでは、異常な検温数やマスク未着用者数など、SenseThunderシリーズによる測定に関するデータに特化して情報を表示します デフォルトでは「デフォルト」が選択されています

温度

音声アナウンス

音声メッセージのタイプを選択できます 詳細はをご参照ください

デフォルトでは「全て」が選択されています

アラート発生時のダッシュボード上のアラート表示 (アラート表示オプションON時)

SensePass GE V1.2.3では、発生したアラートの表示と管理はサポートされません。

アラート表示をONにした場合、ダッシュボードに表示されるアラートは、盗難アラート、強制突破アラート、ドアセンサータイムアウト、サーモカメラ接続アラート、消防アラートのみです。パスワードクラッキング、オフラインアラート、カメラ汚れ、Non-livingアタック、顔特徴量抽出エラーはダッシュボードには表示されません。これらはイベント管理メニューのデバイスアラートから確認してください。

4.3.3 パスワードの変更

ユーザーは自分でパスワードを変更できます。

ヘッダーメニューの[ユーザー名]→[パスワードの変更]を選択してください。

パスワード変更

パスワード更新画面が表示されます。

パスワード更新画面

現在のパスワードと新しいパスワード、確認欄に新しいパスワードを再入力して保存ボタンを押してください。

アカウントのパスワードは次の要件を満たす必要があります。 8〜20文字 1つ以上の大文字を含む 1つ以上の小文字を含む 1つ以上の数字を含む 1つ以上の表示可能な特殊文字を含む ~ ! @ # $ ^ * _ +

4.4 エリアC:ダッシュボード

ダッシュボードでは、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。

認証レコードを削除しても、ダッシュボードで表示している当日分の集計値は変わりません。

4.4.1 デフォルトダッシュボード

表:デフォルトダッシュボード項目

項目

概要

認証

当日の認証レコード数や登録タイプ別レコードの延べ数を表示します

デバイス

登録されているデバイス数やステータスを表示します

デイリーチェックイン

従業員と来訪予定ビジターの当日の認証状況を表示します。ユニーク数が表示されます

デイリーアラート

当日発生したアラートの一覧を表示します

前日勤怠

前日の勤怠状況を表示します

4.4.2 検温(温度検知)ダッシュボード

表:温度検知ダッシュボード項目

項目

概要

認証

当日の温度検知数や温度検知結果を表示します 総数、正常な温度、異常な温度、マスク未着用、デバイスアラート、それらを表示します

データマップ

温度検知結果やマスク着用の状況、時間毎の推移をグラフで表示します

異常イベント

異常温度検知数、マスク未着用数をグラフで表示します

イベント

最新の温度検知レコードを写真付きで表示します

4.4.3 音声メッセージについて

検温ダッシュボードを表示している際に検温を実施すると、測定結果に応じて以下の音声メッセージが流れます。 音声メッセージは種類ごとにオフにすることもできます。ヘッダーメニューの設定(歯車マーク)ボタンをクリックし、必要なガイダンスタイプのみを選択してください。

表:音声メッセージ項目

タイプ

音声メッセージ

概要

正常温度

正常な温度です

温度検知でしきい値以下の温度の場合

異常温度

ご注意ください。異常な温度です

温度検知でしきい値以上の温度の場合

マスク着用無

マスクをつけてください

マスク検知モードで運用時に、被験者がマスクを着けていなかった場合

4.5 ユーザー

ユーザー画面では、新規ユーザー作成、既存ユーザーの変更・削除、およびパスワードのリセットをすることができます。このユーザー画面は、Super AdminとSub Adminユーザーのみが利用できます。

ヘッダーメニューの[ユーザー名]→[ユーザー]を選択してください。

ユーザー画面への移動

ユーザー画面が表示されます。

ユーザー画面

ダッシュボードやその他のメニューへ戻るには、画面上部の[ダッシュボードに戻る]をクリックします。

ダッシュボードへ戻る

4.5.1 ユーザーの種類(ロール)

利用用途に合わせて異なるロールのユーザーを管理することで、安全にSenseLinkを利用することができます。ロール別のメニュー権限詳細は、付録 A ユーザーの権限明細をご参照ください。

ロール

概要

Super Admin

  • 最高権限を持つロール

  • SenseLink Cloudの契約時に1ユーザーのみ発行されるロールであり、追加できません

  • すべてのメニューの更新権限を持ちます

  • すべてのプロジェクトのデータ権限を持ちます

  • すべての登録者と登録者グループのデータ権限を持ちます

  • 他のユーザーの新規登録ができます

  • 他のユーザーの更新権限を持ちます

Sub Admin

  • 複数ユーザー登録可能

  • Super AdminおよびSub Admin以外のロールのユーザーの新規登録ができます

  • Super Adminと他のSub Admin以外のユーザーの更新権限を持ちます

  • Open Platformの参照権限を持ちません

  • システム設定の参照権限を持ちません

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • オペレーションログの自身のユーザーのログのみ参照権限を持ちます

  • 上記以外はSuper Adminと同等の権限を持ちます

General Admin

  • 複数ユーザー登録可能

  • 各メニューの参照権限のみ持ち、更新権限を持ちません

  • システム設定、ライセンス管理は参照権限も持ちません

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • 自身のユーザーのみパスワード変更ができます

  • オペレーションログの自身のユーザーのログのみ参照権限を持ちます

Device Admin

  • 複数ユーザー登録可能

  • デバイス管理メニュー、デバイスアラートのみ更新権限を持ちます

  • ダッシュボードと企業情報のみ参照権限を持ちます

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • 自身のユーザーのみパスワード変更ができます

  • オペレーションログの自身のユーザーのログのみ参照権限を持ちます

Visitor Admin

  • 複数ユーザー登録可能

  • ビジター管理と拒否リスト管理のみ更新権限を持ちます

  • ダッシュボード、ビジターと拒否リストの認証レコード、企業情報のみ参照権限を持ちます

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • 顔認証デバイスのログインには利用できません

  • 自身のユーザーのみパスワード変更ができます

Personnel Admin

  • 複数ユーザー登録可能

  • 認証登録者管理の更新権限を持ちます

  • ダッシュボード、企業情報のみ参照権限を持ちます

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • 顔認証デバイスのログインには利用できません

  • 自身のユーザーのみパスワード変更ができます

Recognition Records Admin

  • 複数ユーザー登録可能

  • 認証レコードおよび従業員別認証レコード、企業情報の参照権限を持ちます

  • プロジェクトのデータ権限が付与されたプロジェクトのみ

  • 登録者のデータ権限が付与された登録者グループに所属する登録者のみ

  • 顔認証デバイスのログインには利用できません

  • 自身のユーザーのみパスワード変更ができます

Device Login Admin

  • 複数ユーザー登録可能

  • 顔認証デバイスのログインのみに利用できます

  • WebブラウザからのSenseLinkへのログインに利用できません

Personnel Record Admin

  • 複数ユーザー登録可能

  • 関連づけた従業員グループ、ビジターグループ、拒否リストグループの登録者に対してのみ、登録者の管理や認証レコードの表示ができます。

  • 顔認証デバイスのログインには利用できません

Register Admin

  • 複数ユーザー登録可能

  • 顔写真のセルフサービス登録ページにログインできます

Approval Admin

  • 複数ユーザー登録可能

  • 顔写真の登録申請の承認ページにログインできます。

4.5.2 ユーザーの新規登録

Super AdminおよびSub Adminは、ユーザーの新規登録が可能です。Sub Adminは別のSub Adminの新規登録はできません。

ユーザー画面の[登録]を選択してください。

ユーザーの新規登録

新規ユーザー登録画面が表示されます。

ユーザー新規登録画面

以下の項目を入力してください。

項目

概要

氏名

  • 1~30文字(半角換算)で登録可能

  • Super Adminの氏名は変更不可

  • ユーザー間の重複可能

ロール

  • をご参照ください。

アカウント

  • SenseLinkやデバイスのログイン時に利用

  • 半角英数字、アンダースコアのみ利用可能

  • 6~25文字で登録可能

  • 一意であること

  • アカウントは一度登録すると変更不可

パスワード生成方法

新規ユーザー登録時のパスワードの生成方法 以下のいずれかから選択可能

  • ランダム生成(ランダムパスワードをメールで送信)

  • デフォルトパスワード生成(Admin1234@)

メールアドレス

Eメールアドレス

  • パスワード生成方法でランダム生成が選択されている場合、登録されたEメールアドレスにランダムパスワードが送信されます

  • パスワード生成方法でデフォルトパスワードを選択している場合も登録することが可能です

  • 半角英数字、-._@+(半角)の6~45文字で、 [email protected] または [email protected]の形式のみ登録可能です

  • 必須項目です Super Adminはご契約時に申請いただいたEメールアドレスが登録されます。お客様ご自身では変更できません。変更が必要な場合は、JCVサポート窓口までご連絡ください

携帯電話番号

  • 必須項目です

  • フォーマットは自動で修正されます

特記事項

  • 1~200文字(半角換算)で登録可能

  • Super Adminは登録不可

従業員グループ

  • 必須項目です

  • 従業員グループを割り当てることで、ユーザーにデータ権限を与えます

  • このユーザーが管理できる従業員は、追加されたグループに所属している従業員のみです

ビジターグループ

  • 必須項目です

  • ビジターグループを割り当てることで、ユーザーにデータ権限を与えます

  • このユーザーが管理できるビジターは、追加されたグループに所属しているビジターのみです

拒否リストグループ

  • 必須項目です

  • 拒否リストグループを割り当てることで、ユーザーにデータ権限を与えます

  • このユーザーが管理できる拒否リストは、追加されたグループに所属している拒否リストのみです

プロジェクト

  • 必須項目です

  • プロジェクトを割り当てることで、ユーザーにデータ権限を与えます

  • このユーザーが管理できるデバイスは、追加されたプロジェクトに所属しているデバイスのみです

デフォルトプロジェクト

  • 必須項目です

  • 追加されたプロジェクトの中から、1つをデフォルトプロジェクトとして選択します

  • デバイスがこのユーザーで新規登録時、選定されたプロジェクトに追加されます

多要素認証

  • 「オン」になっている場合、ログインするには携帯電話またはメールで確認コードが必要です

  • 自分のユーザーには設定できません

  • 企業のMFA設定※が有効になっている場合にのみ使用可能で

  • 企業のMFA設定を変更したい場合は、JCV製品窓口にお問い合わせください ※MFA設定:本人確認のための要素を複数、ユーザーに要求する認証方式

項目を入力後、保存をクリックしてください。ユーザーが発行されます。

パスワード生成方法でランダム生成を選択した場合、登録したユーザーのメールアドレスにアカウントとパスワードが送信されます。デフォルトパスワード生成を選択した場合は、登録者が対象のユーザーにアカウントとデフォルト(Admin1234@)を連絡してください。

[email protected]からのメールを受信できるよう、かつ迷惑メールフォルダに振り分けられないよう、ご利用のメールサービスの設定のご確認をお願いします。

4.5.3 ユーザーの修正と削除

Super Adminはすべてのユーザー、Sub AdminはSuper AdminとSub Admin以外のすべてのユーザーに対して、修正と削除を行うことができます。

ヘッダーメニューから[ユーザー名]→[ユーザー]を選択し、ユーザーの一覧を表示し、修正または削除したいユーザーの更新ボタンをクリックしてください。

ユーザーの修正と削除

自身のユーザーの更新をクリックすると、以下のようなパスワード更新画面が表示されます。現在のパスワードと新しく設定したいパスワード、確認欄に新しいパスワードを再入力して、保存ボタンを押してください。

パスワード更新画面

アカウントのパスワードは次の要件を満たす必要があります。 8〜20文字 1つ以上の大文字を含む 1つ以上の小文字を含む 1つ以上の数字を含む 1つ以上の表示可能な特殊文字を含む ~ ! @ # $ ^ * _ +

Super AdminとSub Adminが自身以外のユーザーの更新をクリックすると、以下の更新画面が表示されます。 修正する場合、修正内容を入力して保存ボタンをクリックしてください。 削除する場合、削除ボタンをクリックしてください。

ユーザー修正画面

4.5.4 パスワードのリセット

Super Admin以外がパスワードを忘れた場合や強制的なパスワードのリセットが必要な時、Super AdminとSub Adminはパスワードをリセットすることができます。

対象ユーザーのリセットボタンをクリックしてください。

パスワードリセットボタン

「リセット後のパスワードをデフォルトパスワード(Admin1234@)とするか、もしくはランダムパスワードとするかを選択できます。選択したパスワード生成方法のボタンをクリックしてください。」というメッセージが表示されます。 ランダム生成を選択した場合、対象ユーザーに新しいパスワードがメールで共有されます。デフォルトパスワードを選択した場合、パスワードがAdmin1234@にリセットされたことを対象ユーザーに連絡してください。

パスワードリセット画面

[email protected]からのメールを受信できるよう、また迷惑メールフォルダに振り分けられないようご利用のメールサービスの設定を確認してください。

4.6 プロジェクト

SenseLinkではプロジェクトを使用することで、顔認識デバイスと認識レコードなどの関連情報をグループ化および分離することができます。プロジェクトは、プロジェクト画面で管理できます。 Super Adminのみがこの画面にアクセスできます。

ヘッダーメニューの[ユーザー名]→[プロジェクト]を選択してください。

プロジェクト画面への移動

ユーザー画面が表示されます。初期状態では、「デフォルトプロジェクト」という名称のプロジェクトが作成されています。 なお、この「デフォルトプロジェクト」は変更または削除できません。

プロジェクト画面

検索可能な項目には、プロジェクト名と備考があります。 検索キーワードを入力し、虫眼鏡マークのボタンをクリックしてください。検索結果が表示されます。「×」マークをクリックすると検索結果が解除され、デフォルトの一覧画面が表示されます。

プロジェクト検索

ダッシュボードやその他のメニューに戻るには、画面上部の[ダッシュボードに戻る]をクリックします。

ダッシュボードへ戻る

4.6.1 プロジェクトの新規登録

新しいプロジェクトを作成して、デバイスと関連情報を分離することができます。

プロジェクトの作成は、画面の[プロジェクトを登録]を選択してください。

新規プロジェクト登録

新規プロジェクト登録画面が表示されます。

プロジェクト登録画面

以下の項目を入力してください。

項目

概要

名前

1~20文字(半角換算)で登録可能

重複不可

特記事項

1~20文字(半角換算)で登録可能

項目入力後、保存をクリックしてください。プロジェクトが登録されます。

プロジェクト保存

4.6.2 プロジェクトの修正

Super Adminは、デフォルトプロジェクト以外のすべてのプロジェクトを変更できます。

ヘッダーメニューから[ユーザー名]→[プロジェクト]を選択し、プロジェクトの一覧を表示して修正したいプロジェクトの更新ボタンをクリックしてください。

プロジェクト修正

選択したプロジェクトの編集メニューが表示されます。「更新」ボタンをクリックして、編集モードに入ります。

プロジェクト編集モード

修正内容を入力して保存ボタンをクリックしてください。選択したプロジェクトの編集メニューが表示されます。「更新」ボタンをクリックして、編集モードに入ります。

4.6.3 プロジェクトの削除

Super Adminはデフォルトのプロジェクト以外、どのユーザーにも権限が付与されていないプロジェクトを削除することができます。

ヘッダーメニューから[ユーザー名]→[プロジェクト]を選択し、プロジェクトの一覧を表示し、削除したいプロジェクトの削除ボタンをクリックしてください。

プロジェクト削除

クリックすると「プロジェクトを削除してもよろしいですか? この操作を復元することはできません。登録者情報、デバイス情報、記録など、本プロジェクトのすべてのデータは削除されます。」というメッセージが表示されます。削除しても問題ない場合は現在ログイン中のアカウントのパスワードを入力し、削除ボタンをクリックしてください。

プロジェクト削除確認

プロジェクトに対する権限を保持しているユーザーがいる場合は、削除はできずに次のメッセージが表示されます。「このプロジェクトは削除できません。このプロジェクトのアクセス権限を持っているユーザーが存在します。削除する前に、該当ユーザーに確認してください。」

4.6.4 プロジェクトの切り替え

複数のプロジェクトに対する権限を持つユーザーは、プロジェクトを切り替えることで、プロジェクトによって分離された顔認識デバイスと認識レコードなどの関連情報を表示および管理できます。

ナビゲーションメニューの上部にある現在のプロジェクトをクリックすると、ログイン中のユーザーが権限を持っているプロジェクトのリストが表示されます。目標プロジェクトを選択すると、その特定のプロジェクトに登録されたデバイスの関連情報のみが表示されます。

プロジェクトの切り替え

1つのデバイスは1つのプロジェクトに登録することしかできません。デバイスを一度プロジェクトに登録されると、SenseLinkで別のプロジェクトに移動することはできません。

デバイスの登録を別のプロジェクトへ移動するには、SenseLinkに登録されているデバイスを削除し、デバイスから移動先のプロジェクトをデフォルトプロジェクトとして設定しているユーザーをアカウントからSenseLinkに登録する必要があります。5.9節 デバイスの削除およびデバイスのユーザーマニュアルを参照してください。

4.7 オープンプラットフォーム

OpenAPIサービスとイベントサブスクリプションサービスは、オープンプラットフォーム画面で構成できます。 Super Adminのみがこの画面にアクセスできます。

ヘッダーメニューの[ユーザー名]→[オープンプラットフォーム]を選択してください。

オープンプラットフォーム画面への移動

AppキーとAppシークレットを管理するオープンプラットフォーム画面が表示されます。

オープンプラットフォーム画面

4.7.1 APIの管理

SenseLinkのAPIを利用することで、SenseLinkを様々な外部システムと連携することができます。

オープンプラットフォーム画面の利用方法やAppキー、Appシークレットの管理方法の詳細については、APIマニュアルの1.2節 キーとシークレットの取得 を参照してください。

4.7.2 サブスクリプションサービスの管理

SenseLinkのサブスクリプションサービスを利用することで、SenseLinkを様々な外部システムと連携することができます。

サブスクリプションサービスの管理方法については、APIマニュアルの2.10節 イベントサブスクリプション API を参照してください。

5 デバイス

AI検温ソリューションSenseThunderシリーズや顔認証デバイスの管理について記載されています。

SenseLinkからデバイス(SensePass、SenseThunder-E、SenseThunder-Mini、SenseThunder-Air)を登録することはできません。登録するには、デバイス側(SensePass、SenseThunder-E、SenseThunder-Mini、SenseThunder-Airなど)からSenseLinkへ接続するとSenseLinkへ登録されます。 各種デバイスからSenseLinkへの登録方法は、SenseThunder-Miniの「」節とSenseThunder-Eの「」節とSenseThunder-Airの「」節をご参照ください。

各種デバイスからSenselinkへ接続する際に、プロキシをお使いの場合は、Websocketをサポートしたプロキシをご利用お願いします(HTTPプロキシは未対応です)。詳しくは、SenseThunder-Miniの「」項とSenseThunder-Eの「」項とSenseThunder-Airの「」項をご参照ください。

デバイス画面では、現在のプロジェクトに登録されたデバイスのデータのみが表示されます。

5.1 デバイス画面

ナビゲーションメニューから[デバイスリスト]を選択してください。SenseLinkに連携している顔認証デバイスリストが表示されます。

検索できる項目には、デバイス名、設置場所、概要、デバイスLDID、シリアルナンバーです。 検索キーワードを入力し、虫眼鏡マークのボタンをクリックしてください。すると検索結果が表示されます。「×」マークをクリックすると検索結果が解除され、デフォルトの一覧画面が表示されます。

エリアA:デバイス台数

  • 「/」の前の数値:(一括設定のために)選定したデバイスの台数

  • 「/」の後の数値:SenseLinkに登録されているデバイスの総台数

エリアB:デバイス詳細情報

表:デバイス詳細情報

5.2 デバイス設定

デバイスの設定を行います。デバイスリスト画面で設定したいデバイスの詳細ボタンをクリックすると、デバイス個別設定画面が表示されます。各設定項目の詳細については、5.3節以降を参照してください。

各項目を設定するには設定タブをクリックし、 タブメニューで更新ボタンをクリックして編集モードにしてください。なお、ここで表示される一部の設定項目は、デバイスがオンラインステータス時のみ編集が可能となるものがあります。

設定内容を編集後、保存ボタンをクリックすると、変更された情報の確認画面が表示されます。内容を確認し、適用ボタンをクリックして設定内容を反映してください。 設定をキャンセルする場合は、キャンセルボタンを選択してください。

5.3 デバイス情報

デバイスリスト画面で、設定したいデバイスの詳細ボタンをクリックしてください。そのデバイスの情報が表示されます。更新ボタンをクリックし、編集モードにしてください。

以下の項目を表示、編集できます。

表:基本情報

表:その他(すべて変更不可)

ゲート(ドア)連動モードとしてNetwork(TCP)を選択した場合、0xから始まる16進数表記でデバイス概要を入力する必要があります。(例:0x747A5E)。 入力形式に誤りがある場合、エラーメッセージ「The format of Gate/Door ID is wrong.」(Gate/Door IDのフォーマットが誤っています)が表示され、設定を保存できません。正しい形式で入力し直してください。

編集後、保存ボタンをクリックして適用ボタンを選択し、設定内容を反映してください。 編集内容を破棄・キャンセルする場合はキャンセルボタンを選択してください。

5.4 デバイス設定(個別)

デバイスリスト画面で、設定したいデバイスの詳細ボタンをクリックしてください。デバイス設定タブを選択すると、そのデバイスのデバイス設定情報が表示されます。設定を変更する場合は、更新ボタンをクリックし、編集モードにする必要があります。

デバイスの種類やバージョンにより、SenseLink Cloudでの表示項目が異なります。

SenseThunder-Mini V2.3.x の場合は以下の項目を表示・編集できます。デバイスがオンラインステータス時のみ編集できます。SenseThunder-Mini V2.3.x 以外のデバイスの設定については、SensePass/Thunderのマニュアルをご参照ください。

表:一般設定

表:温度検知設定

表:顔認証設定

顔認証方式を変更する場合は、SenseLink Cloud Professional+ID Packの契約が必要です。

表:ドア設定

表:パーソナライズ

表:レコード設定

表:システム設定

一部のバージョンではデバイスのデフォルト設定値に戻すことができます。編集モードの状態で、画面右上の「既定値に戻す」をクリックしてください。各項目が既定の設定値に設定されます。

「既定値に戻す」を選択後に保存しないと、既定値の設定が反映されません。

SenseThunder-Airでは、「既定値に戻す」機能を利用できません。

編集後、保存ボタンをクリックし、適用ボタンを選択して設定内容を反映してください。 編集内容を破棄・キャンセルする場合はキャンセルボタンを選択してください。

5.5 顔認証モードの切替

SenseLink Cloud ID Pack をご利用の場合、「サーバー認証」の設定をSenseLink Cloud のデバイス設定から変更することで、顔認証モードについて、デバイス認証とサーバー認証の相互切り替えが可能です。

デバイス認証とサーバー認証の切り替えは、Sense/Thunder App v2.3.5 以降でサポートされます

顔認証モードの切り替えは SenseLink Cloud から実施可能です。デバイス側の設定からは変更できません

デバイス認証からサーバー認証に切り替えた際、デバイス側の顔認証レコードや顔登録情報は削除されます。

同一デバイスで、デバイス認証からサーバー認証に切り替えた後、再度デバイス認証に戻すと、認証率が変動する場合があります。

5.6 アクセス設定

デバイスリスト画面で、設定したいデバイスの詳細ボタンをクリックしてください。アクセス設定タブを選択すると、そのデバイスのアクセス設定情報が表示されます。更新ボタンをクリックし、編集モードにしてください。

画面下部に表示されるアクセスルール、認証レコード 表示を選択すると、それぞれアクセスルール設定ページ、認証レコードページに遷移します。なおドアコントロールはサポート機能されていませんので、選択しないでください。

表:アクセス設定

設定したグループ以外の従業員/ビジター/拒否リストの情報はデバイスに連携されず、グループ以 外の登録者が顔認証を行なった場合は「Stranger」(未登録者)となります。

編集後、保存ボタンをクリックし、適用ボタンを選択して設定内容を反映してください。 編集内容を破棄・キャンセルする場合は、キャンセルボタンを選択してください。

5.7 勤怠設定

デバイスリスト画面で、設定したいデバイスの詳細ボタンをクリックしてください。勤怠設定タブを選択すると、そのデバイスの勤怠設定情報が表示されます。更新ボタンをクリックし、編集モードにしてください。

勤怠管理で設定することで、勤怠エリアをデバイスと連携することができます。登録された従業員がデバイスで顔認証を行うと、連携された勤怠エリアが勤怠レコードの位置情報として記録されます。設定を行わない場合、デバイス情報の設置場所が位置情報として利用されます。

編集後、保存ボタンをクリックし、適用ボタンを選択して設定内容を反映してください。 編集内容を破棄・キャンセルする場合は、キャンセルボタンを選択してください。

5.8 デバイス設定(一括)

オンラインステータスとアプリケーションバージョンが同じデバイスの設定項目を、一括に設定することができます。

ナビゲーションメニューから[デバイスリスト]選択してください。SenseLinkに連携している顔認証デバイスリストが表示されます。一括設定する対象のデバイスのチェックボックスを選択後、設定ボタンをクリックしてください。

一括設定の[デバイス設定]画面に遷移します。

画面上部に選定したデバイスの数量が表示されます。他の設定タブをクリックすると、[アクセス設定]と[勤怠設定]を一括設定することが可能です。

設定欄にデバイス設定 の設定項目が表示されます。と設定と を参照し、各項目を設定してください。

編集後、保存ボタンをクリックして適用ボタンを選択し、設定内容を反映してください。 編集内容を破棄・キャンセルする場合はキャンセルボタンを選択してください。

5.9 デバイスの削除

登録されているデバイスをSenseLinkから削除します。削除したデバイスがオンラインの場合、顔認証やSenseLinkに関するデータがデバイスから消去し、ログアウトされ、その後は認証を行うことができなくなります。デバイスがオフライン状態の場合、オンラインになるまで認証を行うことができますが、オンラインになった時点で認証できなくなります。

1つのデバイスは、1つのプロジェクトに登録することしかできません。デバイスを一度プロジェクトに登録すると、SenseLinkで別のプロジェクトに移動することはできません。 別プロジェクトへ設定を移動するにはSenseLinkに登録されているデバイスをいったん削除し、デバイスから目標プロジェクトをデフォルトプロジェクトとして設定しているユーザーを使用して、SenseLinkに登録する必要があります。

プロジェクトに関する詳細はご参照ください。

デバイスを削除するには、デバイスリスト画面で削除したいデバイスの詳細ボタンをクリックしてください。そのデバイスの情報が表示されます。更新ボタンをクリックし、編集モードにしてください。

編集モードにすると、削除ボタンが表示されます。

クリックすると「デバイスを削除したら、接続が切断されますが、オフラインでの顔認識を行うことができます。」というメッセージが表示されます。削除しても問題ない場合は現在ログイン中のアカウントのパスワードを入力し、削除ボタンをクリックしてください。

SenseLinkではデバイスを登録することができません。削除したデバイスを再度SenseLinkに登録したい場合は、デバイス側から登録操作を行なってください。

5.10 デバイス情報のエクスポート

デバイス情報の一覧をCSVファイルへエクスポートすることができます。デバイスリスト画面で、検索欄右にあるエクスポートをクリックしてください。

「リスト内のすべてのデバイス情報をエクスポートします。 総数は(N)台です。」というメッセージが表示されます。確定ボタンをクリックすると、デバイス情報が記載されたCSVファイルが利用中のPCに保存されます。

以下のCSVファイル名で保存されます。[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS]はエクスポート日時です。 デバイスリスト_[YYYY]-[MM]-[DD]_[HH]_[MM]-[SS].csv

エクスポートはすべてSenseLinkに連携している顔認証デバイスの情報が出力されます。検索機能で表示される結果だけではありません。

5.10 デバイスログのアップロード

本機能は、SensePass/Thunder 2.5.1 以降のデバイスでサポートされます。

本機能はデフォルトで無効となっています。弊社サポート担当の指示があった場合のみ、実施してください。

デバイス設定画面の「デバイスログの送信」ボタンをクリックすることで、デバイスの障害調査ログをデバイスから自動取得し、JCVサポート担当に直接アップロードすることができます。

アップロードを行う場合は、JCVサポート担当の指示に従い、以下のフローで実施ください。

1 . JCVサポート担当がお客様のテナントの「デバイスログの送信」機能を有効化します。

2 . ログの採取対象のデバイスをデバイスリストから選択し、デバイス設定を開きます。

3 . "デバイスログの送信" ボタンをクリックします。

4 . "デバイスログの送信" というポップアップが表示されます。現在接続している SenseLink Cloud の管理者パスワードを入力し、「確定」をクリックしてください。

5 . "デバイスログの送信" ボタンをクリックしたことを、JCVサポート担当にお伝えください。

6 . JCVサポート担当より、デバイスログのアップロードの完了を確認します。

項目

説明

デバイス名

デバイスの名称

デバイス側からSenseLinkへ接続する時、お客様側で自由に設定できます

ファームウエア

デバイスのファームウェアバージョン

アプリケーション

デバイスのアプリケーションバージョン

シリアルナンバー

デバイスを識別するためのシリアルナンバー

設置場所

デバイスの設置場所

デバイス側からSenseLinkへ接続する時、お客様側で自由に設定できます

例:1F入口

概要

デバイスの概要説明

SenseLink側でのみ登録可能です

IPアドレス

デバイスが接続しているIPアドレス

オンライン

デバイスのオンライン/オフラインステータス

設定

詳細ボタンをクリックすると、指定デバイスの詳細情報が表示されます

項目

詳細

デバイスLDID

デバイスの識別番号

変更不可

デバイスタイプ

変更不可

デバイスIP

デバイスのIPアドレス 変更不可

デバイス名

半角全角英数、ひらがな、全角カタカナ、漢字 -_/%(半角)半角文字数1~50

設置場所

半角全角英数、ひらがな、全角カタカナ、漢字 -_/%(半角)半角文字数1~50

デバイス概要

デバイスの説明

(SenseLink GE V1.10.7にてGate/DoorID フィールド名で表示されていた項目)

半角全角英数、ひらがな、全角カタカナ、漢字 -_/%(半角)半角文字数1~50

ゲート(ドア)連動モードとしてNetwork(TCP)を選択した場合、入力値が入退館管理コントローラーとの通信データの一部として利用されます

初回オンライン

初回オンライン時間

変更不可

最終オンライン

最終オンライン時間

変更不可

最終アップデート

最終設定変更時間

変更不可

カテゴリ

項目

ステータス情報

ドアステータス

サーモカメラステータス

アプリケーション情報

パッケージ

アプリケーションバージョン

アプリケーションバージョンコード

SDK情報

バージョン名称

バージョン番号

ライセンス

ファームウェア情報

プロダクトモデル

シリアルナンバー

ファームウェアバージョン

開発元

ハードウェアバージョンコード

項目

詳細

ベンダークライアント

デバイスのベンダー情報(変更不可)

有効な状態

デバイスのオン/オフを設定します

実行中: デバイスが利用可能

利用停止: デバイスが利用不可能(メンテナンス状態)

項目

詳細

温度検知

温度検知のオン/オフを設定します

温度検知環境

温度検知の環境のモードを設定します

初期設定は通常モードです

温度単位

温度表示単位を設定します(摂氏/華氏)

温度アラームしきい値(℃)

温度検知結果からアラーム音を出力するしきい値温度を設定します

連続温度検知間隔(s)

連続して温度検知を行われた際の検知時間間隔を設定します

温度正常時アクセス許可

オンに設定すると温度検知結果が正常時にドア解除信号を送信します

温度異常時アクセス許可

オンに設定すると温度検知結果が異常時にドア解除信号を送信します

温度検知距離(m)

温度検知を行う際のデバイスから被写体の顔までの距離を設定します

サーモグラフィー表示

温度検知画面でのサーモグラフィー画像表示のオン/オフを設定します

項目

詳細

顔認証

顔認証機能のオン/オフを設定します

生体検知

生体検知機能のオン/オフを設定します

生体検知セキュリティしきい値

生体検知機能のしきい値を設定します

設定範囲: 0〜1.00

顔認証しきい値

顔認証のしきい値を設定します

設定範囲: 0〜1.00

顔認証距離(m)

顔認証距離を設定します

設定範囲は顔認証デバイスの種類によります

認証完了後、名前を表示

オンにすると顔認証が完了した被写体の名前を顔認証結果の顔認証デバイスの画面上に表示します

認証成功時アクセス許可

オンに設定すると顔認証成功時にドア解除信号を出力することが可能です。オフに設定すると顔認証成功時にドア解除信号は出力されません。

認証失敗時アクセス許可

オンに設定すると顔認証失敗時にドア解除信号を出力することが可能です。オフに設定すると顔認証失敗時にドア解除信号は出力されません。

同一顔の認証間隔(s)

顔認証を連続して行う際の検知タイミングの時間間隔を設定します

認証完了後、写真を表示

登録者を認証した際、登録者の表示写真を顔認証デバイスの画面上に出力するかを設定します。登録者の表示写真が設定されていない場合、認証写真が表示されます

試験的な機能

オンにすると顔認証時に本人認証精度を向上することができます。尚、その一方で他人を誤って受け入れてしまう確率もわずかに増加します。

マスク着用検知

マスクを着用した被写体の顔認証を行う機能のオン/オフを設定します

マスク未着用時アクセス拒否

マスク未着用を検知した場合、ドア解除信号の出力を禁止する機能のオン/オフを設定します

項目

詳細

ドア強制突破アラーム

ドア解錠ができない場合、デバイスにてアラートメッセージをポップアップ表示します。デバイスがSenseLinkと接続されている場合は、SenseLinkに例外通知を送信します。

ドアオープンモード

ドア解錠信号を送信する方法を選択します

  • ネットワーク(TCP)設定

  • ローカルリレー

  • Wiegand 26(8+16bit)

  • Wiegand 32

  • Wiegand 34

  • Wiegand 35

  • Wiegand 26(24bit)

ドアオープン時間(s)

ドアオープンシグナル継続時間の設定

設定範囲: 1〜255秒

ドアマグネットタイムアウト(s)

ドアセンサータイムアウト時間の設定

設定範囲:1~255秒

GPIO A-出力(ドアベル)

GPIO A出力シグナル種類の選択

(None、ドアベル、アラート、デフォルト:None)

GPIO-B 入力(ドアマグネット)

GPIO B入力シグナル種類の選択

(None、ドアコンタクト、REXボタン、消防アラートシグナル、デフォルト:None)

GPIO C-入力(ドアオープンボタン)

GPIO C入力シグナル種類の選択

(None、ドアコンタクト、REXボタン、消防アラートシグナル、デフォルト:None)

Wiegand入力

Wiegandシグナル入力の設定

  • Wiegand26/32/34

  • Wiegand26(8+16bit)

  • Wiegand35

パルスサイクル(us)

Wiegandのパルスサイクル設定

パルス幅(us)

Wiegandのパルス幅設定

カード番号を入れ替え

Wiegandのカード番号の入れ替え設定

項目

詳細

個人設定

個人設定のオン/オフを設定します

ウェルカムメッセージ

デバイスの顔認証待機時、デバイス画面に表示するメッセージの設定(最大50半角文字)

従業員メッセージ表示

登録者タイプが従業員の人物を顔認証した際、画面左下に表示されるメッセージの設定

ビジターメッセージ表示

登録者タイプがビジターの人物を顔認証した際、画面左下に表示されるメッセージの設定

未登録者メッセージ表示

登録者タイプが未登録者の人物を顔認証した際、画面左下に表示されるメッセージの設定

拒否リストメッセージ表示

登録者タイプが拒否リストの人物を顔認証した際、画面左下に表示されるメッセージの設定

従業員背景色

登録者タイプが従業員の人物を顔認証した際の背景色

ビジー背景色

登録者タイプがビジターの人物を顔認証した際の背景色

未登録者背景色

登録者タイプが未登録者の人物を顔認証した際の背景色

拒否リスト背景色

登録者タイプが拒否リストの人物を顔認証した際の背景色

認証済み画面の 追加フィールド表示

認証成功時表示する従業員情報の設定(従業員番号、部署名、役職、カスタムメッセージ)(複数選択可) (IDカード番号は利用できません。選択しないでください)

拒否リスト通行許可

項目

詳細

レコードアップロード

デバイスのレコードアップロード機能のオン/オフを設定します

アップロードモード

デバイスからのレコードアップロードモードを選択します

通常モード、顔キャプチャ画像圧縮モード、顔キャプチャ記録無効モードから選択が可能です

アラートレコード

オンに設定すると、アラートレコードがSenseLinkへのアップロード対象と設定されます。オフにするとSenseLinkにはアップロードされません。

従業員グループレコード

オンに設定すると、登録者タイプが従業員の認証レコードがSenseLinkへのアップロード対象と設定されます。オフにするとSenseLinkにはアップロードされません。

ビジターグループレコード

オンに設定すると、登録者タイプがビジターの認証レコードがSenseLinkへのアップロード対象と設定されます。オフにするとSenseLinkにはアップロードされません。

未登録者レコード

オンに設定すると、登録者タイプが未登録者の認証レコードがSenseLinkへのアップロード対象と設定されます。オフにするとSenseLinkにはアップロードされません。

拒否リストグループレコード

オンに設定すると、登録者タイプが拒否リストグループの認証レコードがSenseLinkへのアップロード対象と設定されます。オフにするとSenseLinkにはアップロードされません。

項目

詳細

NTPサーバーアドレス

時刻同期可能なNTPサーバーを選択することができます。初期設定は自動です。

指定したNTPサーバーを使用する場合は SensePass/Thunder のマニュアルをご参照ください。

盗難アラート

デバイスの盗難防止スイッチが作動した際のアラート音の出力を、オン/オフで設定できます。

サーバー認証

顔認証モードの確認や変更ができます

  • オフ: デバイス認証

  • オン: サーバー認証

サーバー認証を利用される際は、SenseLink Cloud ID Pack が必要です

認証モード

顔認証モードを選択します

  • 顔認証+カード

  • 顔認証

  • 顔認証/QRコード/ICカード

音声アナウンス

オンにすると音声アナウンス機能が有効になります

温度正常時アナウンス

温度検知結果が温度アラームしきい値を超えない場合に出力される音声アナウンスを設定します

高温時アナウンス

温度検知結果が40℃以上となる場合に出力される音声アナウンスを設定します

低温時アナウンス

温度検知結果が35℃以下となる場合に出力される音声アナウンスを設定します

マスク未着用時アナウンス

マスクが着用されていない場合の音声アナウンスを設定します

認証成功時アナウンス

顔認証が成功した場合に出力される音声アナウンスを設定します

認証失敗時アナウンス

顔認証が失敗した場合に出力される音声アナウンスを設定します

言語

表示言語を設定することができます。設定できる言語は中文、繁体、英語、韓国語、日本語から選択が可能です。

画面の明るさ

デバイスのディスプレイ画面の明るさを設定できます

暗所補助光

RGBカメラの周辺輝度が低く顔認証ができない場合に使用します。補助光がオンの場合は、1m離れた光源の光の明るさが少なくとも10lux未満となる場合には補助光が発光され、発光中の明るさが20luxを超えると補助光が消灯されます。

スリープ・スタンバイ

デバイスをスリープ状態やスタンバイ状態とするかどうかをオン/オフで設定することができます

自動再起動

自動再起動を行うかどうかをオン/オフで設定することができます

画面にタッチして認証

デバイスの以下の画面を表示し、一度タッチした後に、温度検知画面の表示に切り替えることができる設定をオン/オフで設定できます

USBキーボード・マウス

オンに設定すると本デバイスにUSBで接続されたキーボード・マウスを認識します

USBメモリ

オンに設定すると本デバイスに接続されたUSBメモリを認識します

デバイス認証

デバイス側で顔認証し、その結果をSenseLink Cloud に送信します

サーバー認証

デバイスから顔写真をSenseLink Cloudに送信し、SenseLink Cloud側で顔認証を行います

項目

詳細

方向

デバイスのアクセス方向の設定

Null:設定しない

In: 入館

Out:退館

従業員グループ

デバイスと連携する従業員グループの設定

設定したグループの従業員の情報のみがデバイスに連携され、認証可能です

ビジターグループ

デバイスと連携するビジターグループの設定

設定したグループのビジターの情報のみがデバイスに連携され、認証可能です

拒否リストグループ

デバイスと連携する拒否リストグループの設定

設定したグループの拒否リストの情報のみがデバイスに連携され、認証可能です

ドアステータス

サポートされない機能です。利用できません

オープン時間

ルール管理で設定されたアクセスタイムテーブル

SensePass GE V1.2.3では利用できません

クローズ時間

サポートされない機能です。利用できません

5. SenseLink 接続方法
5. SenseLink 接続方法
4. Senselink 接続方法
5.3.1 SenseThunder-Miniのネットワーク通信仕様
5.3.1 SenseThunder-Eのネットワーク通信仕様
4.2.1 SenseThunder-Airのネットワーク通信仕様
5.4節 デバイス設定(個別)
5.6節 アクセス
5.7節 勤怠設定
4.6章 プロジェクト
デバイスリスト
デバイス個別設定画面への遷移
デバイス個別設定画面編集モードへの遷移
変更内容を保存する
編集モード-デバイス情報
変更内容を保存する-デバイス情報
編集モード-デバイス設定
デバイスのデフォルト設定値に戻す
変更内容を保存する-デバイス設定
編集モード-アクセス設定
アクセス設定から各メニューへの遷移
変更内容を保存する-アクセス設定
編集モード-勤怠設定
変更内容を保存する-勤怠設定
デバイスの設定(一括)
デバイスの一括設定画面
編集モードへの遷移
デバイスの削除
デバイスリストエクスポート
表:ダッシュボードの設定
4.5章 ユーザー
4.6章 プロジェクト
4.7章 オープンプラットフォーム
4.4.3節 音声メッセージについて
4.5.1節 ユーザーの種類(ロール)
図4.2.1 ハンバーガーボタン
図4.2.2 設定ボタン

2.9 部署の API

2.9.1 部署リストの取得 (/api/v2/department)

概要

部署リストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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
            }
      ]
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

leader_name

string

部署長の名前

user_num

int

部署内の人数

children

list<department>

下位部署のリスト

department フィールドの説明

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

leader_name

string

部署長の名前

user_num

int

部署内の人数

children

list<department>

下位部署のリスト

2.9.2 部署コードでの部署の検索 (/api/v2/department/search/code)

概要

部署コードから部署情報を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/search/code

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

code

string

Yes

部署コード。長さ制限は 45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 11,
        "name": "test",
        "code": "003",
        "parent_id": 0,
        "leader_id": null
    }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

30004

Missing Param

部署コードが指定されていません

2.9.3 ID での部署の検索 (/api/v2/department/{id})

概要

部署 ID から部署情報を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/{id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": “003”,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

部署IDが存在しません

30001

Param Invalid

2.9.4 部署の作成 (/api/v2/department)

概要

部署作成のインターフェースです。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

parentId

long

Yes

上位部署 ID

name

string

Yes

名前。長さ制限は 50。空の値で登録しないでください

leaderId

long

No

部署長の ID

code

string

No

部署コード。長さ制限は 45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": " 開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

上位の部署を選択ください

610

Similar record Exist

同じ名前の部署が同じレベルに存在します

620

Record non-existent Error

上位部署の ID が存在しません

30001

Param Invalid

無効なパラメーターです。上位部署のIDは空にはできません

30001

Param Invalid

無効なパラメーターです。部署名は空にはできません

30001

Param Invalid

無効なパラメーターです。部署名の長さ制限は 50です

30001

Param Invalid

無効なパラメーターです。部署コードの長さ制限は 45です

30001

Param Invalid

無効なパラメーターです。部署長が存在しません

30001

Param Invalid

無効なパラメーターです。部署コードはすでに存在します

30001

Param Invalid

無効なパラメーターです。部署IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。上位部署IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。部署長IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。の型変換失敗しました

2.9.5 部署の更新 (/api/v2/department/update)

概要

部署インターフェースを更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/update

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

parentId

long

Yes

上位部署 ID。上位部署IDが存在しない場合、エラーとなる可能性があります。ご注意ください

name

string

Yes

名前。長さ制限は 50です

leaderId

long

No

部署長の ID

code

string

No

部署コード。長さ制限は 45です

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 2,
        "name": "開発部",
        "code": null,
        "parent_id": 0,
        "leader_id": 55505
    }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

部署ID

name

string

部署名

parent_id

long

上位部署の ID。0 は企業を示します

leader_id

long

部署長の ID

code

string

部署コード

エラーレスポンスのフィールド

コード

メッセージ

説明

610

Similar record Exist

同じ名前の部署が同じレベルに存在します

620

Record non-existent Error

上位部署の ID が無効です(現在のノードの上位部署は指定できません)

620

Record non-existent Error

部署IDは存在しません

30001

Param Invalid

無効なパラメーターです。部署長が存在しません

30001

Param Invalid

無効なパラメーターです。部署 ID は空にはできません

30001

Param Invalid

無効なパラメーターです。部署IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。上位部署IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。部署長IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。会社IDの型変換失敗しました

30001

Param Invalid

無効なパラメーターです。部署名の長さ制限は 50です

30001

Param Invalid

無効なパラメーターです。部署コードの長さ制限は 45です

30001

Param Invalid

無効なパラメーターです。部署名は空にはできません

30001

Param Invalid

無効なパラメーターです。上位部署の ID は存在しません

2.9.6 部署の削除 (/api/v2/department/delete)

概要

部署を削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/delete

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

部署ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
 "message": "OK"
}

エラーレスポンスのフィールド

コード

メッセージ

説明

610

Similar record Exist

部署にユーザーが存在しているため、部署を削除できません

610

Similar record Exist

部署に下位部署があります

620

Record non-existent Error

上位部署の ID が存在しません

30001

Param Invalid

無効なパラメーターです

30004

Missing Param

部署コードが指定されていません

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.5 登録者グループの API

2.5.1 グループの追加 (/api/v1/group)

概要

グループを追加します。

リクエストアドレスの例

https://link.japancv.co.jpT/api/v1/group

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

name

string

Yes

グループ名。長さ制限は 45

type

int

Yes

グループタイプ

1 : 従業員グループ

2 : ビジターグループ

5 : 拒否リストグループ

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

company_id

long

企業ID

create_at

string

作成時間

update_at

string

前回の変更時間

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

無効なパラメーターです。登録者グループ名の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者グループタイプは空にはできません

30001

Param Invalid

無効なパラメーターです。登録者グループタイプが無効です

30001

Param Invalid

無効なパラメーターです。登録者グループ名はすでに存在します

30001

Param Invalid

無効なパラメーターです。グループタイプが不正です

50001

RPC FAILED

RPCに失敗しました。グループ作成に失敗しました

2.5.2 登録者グループリストの表示 list (/api/v1/group)

概要

登録者グループのリストを表示します。デフォルトの順序はID の降順です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/group

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

page

int

No

ページ番号(デフォルトは 1 )

size

int

No

1 ページあたりのデータ数(デフォルトは 20 )

type

int

No

登録者グループタイプ

1:従業員

2:ビジター

5:拒否リスト

deviceId

long

No

デバイスの ID

groupIds

list<long>

No

グループID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

total

string

総計

pageNum

string

ページ数

size

string

サイズ

pageSize

string

ページサイズ

totalPage

string

ページ合計

data

object

データ

data.dataフィールドの説明

パラメーター名

型

説明

id

int

登録者グループの ID

name

string

登録者グループ名

company_id

int

企業 ID

create_at

string

作成時間

update_at

string

更新時間

type

int

登録者グループタイプ

user_number

int

グループ内の人数

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

無効なパラメーターです。登録者グループタイプが無効です

30001

Param Invalid

無効なパラメーターです。デバイスが存在しません

30001

Param Invalid

無効なパラメーターです。タイプが一致しません

20002

Permission Denied

権限がありません

2.5.3 グループの登録者リストの取得 (/api/v1/group/user)

概要

グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/group/user

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

グループID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": [
        1014,
        1241,
        2896,
        5124,
        5125,
        5126,
        5127
    ]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

list<long>

登録者ID

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

620

Record non-existent Error

グループID が存在しません

30001

Param Invalid

無効なパラメーターです

2.5.4 登録者グループの更新 (/api/v3/group/update)

概要

登録者グループを更新します。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/group/update

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

グループID

name

string

No

グループ名

device_ids

list<long>

No※

デバイスID リスト

※SenseLink Cloud V2.3.8では必須になっていましたが、V2.3.9以降は必須ではなくなっています。

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {
 "id": 253,
 "name": "zml2",
 "type": 1,
 "devices": [{
 "id": 268,
 "name": "q",
 "type": 0
 }],
 "is_default": 0
 }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

グループ ID

name

string

グループ名

type

int

グループタイプ

devices

list<device>

デバイス

is_default

int

デフォルトのグループかどうかの識別

device フィールドの説明

パラメーター名

型

説明

id

int

デバイスの ID

name

string

デバイス名

type

int

デバイスタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

グループ名が長すぎます

30001

Param Invalid

グループIDが不正です

30001

Param Invalid

グループタイプが不正です

30001

Param Invalid

デバイスIDが存在しません

30001

Param Invalid

グループが存在しません

30001

Param Invalid

グループ名が存在しません

30001

Param Invalid

該当グループが変更できません

600

Sync Failed

リモートリクエストエラー

2.5.5 グループの削除 (/api/v1/group/delete/{id})

概要

グループを削除します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/group/delete/{id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

登録者グループの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 はリクエストが成功したことを示します

message

string

リターンメッセージ

エラーレスポンスのフィールド

code

メッセージ

説明

20002

Permission Denied

操作権限がないため、デフォルトのグループを削除できません

30001

Param Invalid

無効なパラメーターです。グループID が存在しません

30001

Param Invalid

無効なパラメーターです。変更グループは企業に属しておりません

50001

RPC FAILED

RPCに失敗しました。グループの削除に失敗しました

2.5.6 登録者のグループへの一括追加 (/api/v1/user/add/group)

概要

登録者を一括でグループに追加します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/user/add/group

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

groupId

long

Yes

登録者グループの ID

userIds

list<long>

Yes

一括で追加する登録者ID。1回の操作で最大2,000人を追加できます

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスフィールドの説明

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

エラーレスポンスのフィールド

code

メッセージ

説明

620

Record non-existent Error

グループID が存在しません

620

Record non-existent Error

登録者IDが存在しません

20002

Permission Denied

権限がありません

30001

param-invalid

無効なパラメーターです。2,000 を超える数を一度にグループに追加することはできません

30001

param-invalid

無効なパラメーターです。groupId が空です

30001

param-invalid

無効なパラメーターです。登録者の userId array が空です

30001

param-invalid

無効なパラメーターです。登録者とグループタイプが一致しません

30001

param-invalid

無効なパラメーターです。グループが存在しません

50001

RPC FAILED

RPCに失敗しました。一括登録者追加に失敗しました

50501

user.exceed-max-capacity

グループ内の最大人数に達しました

2.5.7 登録者のグループからの一括削除 (/api/v1/user/remove/group)

概要

グループから一括で登録者を削除します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/user/remove/group

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

groupId

long

Yes

従業員のグループID

userIds

list<long>

Yes

一括で削除する登録者のID。最大2,000 まで一括で操作できます。

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 はリクエストが成功したことを示します

message

string

リターンメッセージ

エラーレスポンスのフィールド

code

メッセージ

説明

620

Record non-existent Error

グループID が存在しません

620

Record non-existent Error

登録者IDが存在しません

20002

Permission Denied

権限がありません

30001

param-invalid

無効なパラメーターです。2,000 を超える数を一度にグループから削除することはできません

30001

param-invalid

無効なパラメーターです。groupId が空です

30001

param-invalid

無効なパラメーターです。登録者の userId array が空です

30001

param-invalid

無効なパラメーターです。登録者とグループタイプが一致しません

30001

param-invalid

無効なパラメーターです。グループが存在しません

50001

RPC FAILED

RPCに失敗しました。グループからの登録者の一括削除に失敗しました

6 登録者タイプ

従業員、ビジター、拒否リストの登録者の登録や削除、管理について記載されています。

ご利用のプランによって、登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

登録者タイプ画面では、現在のユーザーに登録された登録者グループのデータのみが表示されます。

2020年10月より、ブラックリスト機能を拒否リスト機能に改名しています。 SenseLink一部モデルや一部機能、および一部デバイスではブラックリスト(blacklist)という名称が残っている場合がございますが、当マニュアルでは拒否リストとして説明しています。適宜読み替えてご利用ください。

6.1 登録者タイプ

SenseLinkでは、顔認証の対象者を以下の登録者タイプに分けて登録・管理することができます。

SensePass GE V1.2.3では、ビジターおよび拒否リストの顔認証をサポートしていません。

6.2 登録する認証写真の規格

SenseLinkに登録する認証用の顔写真は、以下の規格に合うものをご準備ください。なお顔写真品質チェックレベルの設定が低の場合、「自分の顔以外他人の顔が映っていないこと」、「写真データのフォーマットはpng、jpeg、またはjpgであること」、「写真データのサイズが約4M未満以下であること」の3点以外の顔写真品質チェックを行わずに登録が可能です。

  • 写真の仕様:

    • 3カ月以内に撮影したもの

    • 写真の幅は300ピクセル以上、高さは400ピクセル以上であること

    • 写真に加工をしていないこと

    • 写真データのフォーマットはpng、jpeg、またはjpgであること

    • 写真データのサイズが約4M未満以下であること

  • 写真の内容:

    • カラー写真

    • 背景は薄い青、もしくは水色で、他人や物、影が写り込んでいないこと

    • 鮮明であること(写真の焦点が合っていて、色調が正しいこと)

    • 明るさやコントラストが適切であること

    • 均一な照明で、顔に影や光っている部分がないこと

    • 背景と人物の境目がはっきりしていること

    • 写っている人物が1人のみで、他人の顔が写っていないこと

    • 正面、無帽、無背景

  • 顔の部分:

    • 目線が前方を見ていて、表情は自然であること

    • 口は閉じていて、上、横、下を見ていないこと

    • 均一な照明で、顔に影や光っている部分がないこと

    • 特別な理由がない限り、フードをかぶらないでください。フードをかぶる場合、顔に陰影が出ないようにしてください

    • 目は何も加工せず、影がかかっていないこと。特別な理由がない限り、眼鏡はかけないでください

    • 眼鏡をかけている場合:

      • 眼鏡のレンズに光が反射していないこと

      • 眼鏡のフレームは、目を覆っていないこと

      • サングラスや色付きレンズの眼鏡をかけていないこと

    • 平常の顔貌と著しく異ならないもの

    • 前髪やヒゲなどで、目や鼻などの顔のパーツや輪郭が隠れていないこと

    • 髪の毛で眉毛や目、耳を隠さないでください

    • 左右の眉毛は露出しなければなりません

    • 奇抜な髪型は避けてください

    • ヘアバンドなどで頭髪を覆っていないこと

    • 口を開けていないこと

    • 有効な顔のサイズは150✕150ピクセル以上であること

    • 顔部分のピッチ/ヨー/ロールが±20°であること

    • 顔部分の上下左右幅を変更していないこと

6.3 従業員の新規登録:個別登録

個別登録とは、従業員を1人ずつ登録する方法です。

従業員を登録する場合、必ず従業員グループを指定してください(必須項目)。

登録に必要な写真および情報を準備してください。

  • 従業員の写真

  • 従業員情報(詳細は「登録項目詳細」をご参照ください)

ナビゲーションメニューの[登録者タイプ]→[従業員管理]から従業員一覧を表示し、[登録]をクリックすると、個別登録画面が表示されます。

登録項目詳細

文字種に関する記載がないものは、文字種の制限がありません。

従業員番号欄などにアルファベット等を入力してもエラーが表示されませんが、内部的な処理で不具合が発生する可能性があるため、半角数字以外は入力しないでください。

必要な情報を入力した後、ページ最下部にある保存ボタンをクリックして登録を完了してください。登録完了まで数秒かかる場合があります。

6.4 ビジターの新規登録

登録に必要な写真および情報を準備してください。

  • ビジターの写真

  • ビジター情報(詳細は「登録項目詳細」をご参照ください)

ナビゲーションメニューの[登録者タイプ]→[ビジター管理]からビジター一覧を表示し、[登録]をクリックすると登録画面が表示されます。

登録項目詳細

文字種に関する記載がないものは制限がありません。

最小文字数、最大文字数は半角換算の文字数です。

登録したビジター情報は、来訪期間が過ぎても自動的に削除されません。デバイスに保存できる登録者の人数には上限があるため、不要となったビジター情報は定期的に削除することをお勧めします。

必要な情報の入力後、ページ最下部にある保存ボタンをクリックして登録を完了してください。登録完了まで数秒かかる場合があります。

6.5 拒否リストの新規登録

登録に必要な写真および情報をご準備ください。

  • 拒否リストの写真

  • 拒否リスト情報(詳細は「登録項目詳細」をご参照ください)

ナビゲーションメニューの[登録者タイプ]→[拒否リスト管理]から拒否リスト一覧を表示し、[拒否リストに登録]をクリックすると登録画面が表示されます。

登録項目詳細

文字種に関する記載がないものは制限がありません。

最小文字数、最大文字数は半角換算の文字数です。

必要な情報の入力後、ページ最下部にある保存ボタンをクリックして登録を完了してください。登録完了まで数秒かかる場合があります。

オフラインで拒否リストを認証した後でオンラインにした場合、初回のみダッシュボード上に拒否リストの警告が表示されることがあります。表示された場合は画面を再表示(リロード)することで、警告は表示されなくなります。

6.6 登録者情報の修正:個別修正

登録者情報を修正することができます。以下に、従業員情報の場合を例に、操作手順を記載します。ビジター、拒否リストの場合、それぞれビジター管理メニュー、拒否リスト管理メニューに読み替えて同様の手順を実施してください。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]から従業員一覧を表示し、設定欄にある詳細ボタンをクリックすると、登録者情報詳細が表示されます。

ページ最下部にある更新ボタンクリックすると、修正モードになります。

情報を修正した後、ページ最下部にある保存ボタンをクリックすると、修正内容が反映されます。

6.7 登録者情報の削除:個別削除

登録者情報を削除することができます。以下に、従業員情報の場合を例に、操作手順を記載します。ビジター、拒否リストの場合、それぞれビジター管理メニュー、拒否リスト管理メニューに読み替えて同様の手順を実施してください。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]から従業員一覧を表示してください。

削除したい登録者にチェックを入れ、削除ボタンをクリックしてください「この操作は取り消しできません。削除しますか?」のメッセージが表示されます。 「確定」をクリックして削除してください。なお、削除された登録者情報は復元できませんのでご注意ください。

また登録者情報詳細ページからも削除が行えます。

ナビゲーションメニューの[登録者管理]→[従業員管理]から従業員一覧を表示してください。削除したい従業員の詳細ボタンをクリックし、登録者情報詳細を表示してください。ページ最下部にある更新ボタンクリックすると修正モードになり、ページ最下部に削除ボタンが表示されます。削除ボタンをクリックしてください。

「この操作は取り消しできません。削除しますか?」のメッセージが表示されますので、「確定」をクリックして削除してください。

6.8 登録者タイプの変更

従業員またはビジターとして登録された登録者を、拒否リストの登録者に変更することができます。

拒否リストに登録したい従業員、またはビジターの登録者情報の詳細を表示してください。 ナビゲーションメニューの[登録者タイプ]→[従業員管理]または[ビジター管理から登録者一覧を表示させ、拒否リストに登録したい登録者の詳細ボタンをクリックすると詳細が表示されます。

ページ最下部にある更新ボタンをクリックして、修正モードにしてください。

編集モードにすると、同ページ最下部のボタンに「拒否リストに登録」ボタンが表示されます。クリックしてください。

登録する拒否リストグループを選択します。グループは複数選択可能です。

選択後、保存ボタンをクリックすると、「拒否リストに登録するとグループや部署、デバイスへの登録も削除されます。登録しますか?」のメッセージが表示されます。確定ボタンをクリックしてください。

操作完了後、ナビゲーションメニューの[登録者タイプ]→拒否リスト管理]から拒否リスト一覧を表示し、変更した登録者が登録されていることを確認してください。オリジナルの登録者タイプ欄には登録者のオリジナルの登録者タイプとして、従業員またはビジターが記録されています。

6.9 従業員の新規登録:複数登録

一度に最大50,000件まで、複数の従業員を登録することが可能です。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]を選択してください。従業員管理ページが表示されます。[一括操作]タブをクリックし、[複数登録]を選択してください。

複数登録のステップを説明するページが表示されます。内容を確認のうえ、アップロード開始ボタンをクリックしてください。

バッチ処理の履歴をタスクリストから確認できます。

タスクリストでは、タスクのプロセス、ステータス、登録者人数を確認できます。詳細については各タスクの結果をエクスポートして確認できます。

6.9.1 従業員情報のアップロード(Step 1)

従業員情報情報を入力するためのExcelテンプレートをダウンロードします。

①ダウンロード ボタンをクリックしてください。デフォルトのファイル名は 「senselink_employee_upload_template_ja.xlsx」 です。

保存されたExcelテンプレートを開いてください。

Excelテンプレートの1行目と2行目は編集・削除しないでください。 3行目から、従業員情報を入力できます。Excelテンプレートの3行目にPeterという従業員の入力例が記載されていますが、こちらはサンプルなので入力例を確認後、削除・上書きして登録してください。 名前と従業員グループは必須項目、その他はオプション項目です。

従業員を登録する場合、必ず従業員グループを指定してください(必須項目)。

携帯電話番号、従業員番号、ICカード番号は異なる従業員間で重複して登録することができず、一意である必要があります。

Excelテンプレートへの入力項目

文字数制限は半角換算の文字数です。

従業員で重複する名前が存在する場合、必ず異なる携帯電話番号を入力して管理してください。そうでないと、次項のStep2で顔写真の登録ができません。また など以降の操作でエラーが発生します。

この操作では、すでに登録済みの従業員情報を上書き・修正することはできません。修正が必要な場合は、 を参照してください。

顔写真の品質が条件を満たさない場合や必須項目の記入に漏れがある場合は、対象の従業員の登録はされません。

②アップロードボタンをクリックし、準備したExcelテンプレートを選択してください。 ③インポートボタンをクリックして、SenseLinkにExcelテンプレートに入力された従業員情報をインポートしてください。インポートに成功すると、自動的にStep2へ進みます。

Excelファイルの内容に誤りがある場合、エラーメッセージが表示されてインポートが完了しません。エラーメッセージの内容に従ってExcelファイルを修正し、もう一度アップロードおよびインポートを行なってください。

エラーメッセージのフォーマット

エラーを修正したExcelをアップロードする際には、先にアップロード済みのデータを削除する必要があります。削除した後、もう一度アップロードボタンから修正済みExcelテンプレートをアップロードしてください。

6.9.2 従業員の認証用顔写真のアップロード(Step 2)

従業員情報のインポートが完了すると、自動的に従業員の認証用顔写真アップロードのページに遷移します。

顔写真品質チェックレベル欄で、用顔写真品質チェックレベルを選択します。

認証用顔写真の圧縮ファイルの欄にある[ファイルを選択]ボタンをクリックして、顔写真ファイルの圧縮ファイル(ZIP)を選択してください。 圧縮ファイル(ZIP)および圧縮ファイル内の顔写真は、以下の規格を満たす必要があります。

  • 顔認証品質チェックレベルで高を設定している場合、写真がすべての規格項目をクリアしていること。認証用顔写真の規格はをご参照してください。「低」を設定している場合はその限りではありません。

  • 顔写真ファイル1件は約3.8MB(4,000,000バイト =約3,900KB)

  • 圧縮ファイル内の顔写真ファイル数が50,000件以下であること

  • 認証用顔写真の拡張子を除くファイル名が前節で登録した、またはすでに登録済みの従業員の氏名と一致していること

  • ただし氏名が重複する従業員が存在する場合、以下のフォーマットであること

    • [氏名]+[国別コード]-[携帯電話番号]

    • 従業員の氏名が[山田 太郎]、国別コードが[81]、携帯電話番号が[8012345678]の場合、山田 太郎+81-8012345678.jpg (または.png)が規定のファイル名

  • すべての顔写真が1つのZIPフォーマットのファイルに圧縮されていること

  • 圧縮ファイル(ZIP)のサイズが2GB以下であること

圧縮ファイルを作成する際、認証用顔写真のファイル名はUTF-8でエンコードされている必要があります。

[Windowsの場合] 、7-zipなど、UTF-8に対応した外部の圧縮ソフトを使用してください。

[MacOSの場合] 、「ば」「ぱ」「バ」「パ」など濁音/半濁音のひらがな/カタカナがファイル名に含まれる場合は、特殊な文字コードの影響で画像を正常に登録できない場合があります。これらの文字列がファイル名に含まれる場合は、Windows上でUTF-8対応のソフトを使用して圧縮ファイルを作成してください。

フォルダを選択後、次へ のボタンをクリックしてください。認証用顔写真のアップロードが開始されます。 フォルダまたは認証用顔写真ファイルに誤りがある場合、エラーメッセージが表示され、アップロードが開始されません。エラーメッセージの内容にしたがってフォルダまたは認証用顔写真ファイルを修正し、もう一度アップロードを行なってください。

アップロードが開始されると、進捗状況として経過時間が確認できます。アップロードは2段階の処理が行われるため、進捗も2種類表示されます。

アップロードが完了すると、完了メッセージが画面上部に表示されます。

アップロードの結果をエクスポートすることもできます。アップロード結果 表示ボタンをクリックしてください。Excelファイルがエクスポートされ、ファイルが開きます。

アップロード結果のエラーメッセージ

アップロード結果のExcelファイル2行目に、「.DS_Store」というファイル名に関するエラーが出力される場合があります。これは実際のアップロード結果と関係のない情報です。3行目以降に記載される情報を確認してください。

6.10 従業員情報の修正:複数修正

一度に複数の従業員情報を修正することが可能です。

当節の手順では従業員情報の修正のみ行い、従業員の認証用顔写真の修正を行うことができません。認証用顔写真の修正を行う場合は、次節を参照してください。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]を選択してください。従業員管理ページが表示されます。[一括操作]タブをクリックし、[複数更新]を選択してください。

登録済みの従業員情報をエクスポートします。「①従業員リストエクスポート」をクリックしてください。

「Excelファイルはパスワードで保護されます。パスワードは現在のアカウントです。」というメッセージが表示されます。確定ボタンをクリックすると、ご利用中のPCに従業員情報が記載されたExcelファイルがエクスポートされます。 ファイル名は [従業員リスト20YY-MM-DD.xlsx] (20YY-MM-DDはエクスポート実施日) エクスポートされたファイルを開く際にパスワードを求められます。パスワードはSenseLinkにログイン中のアカウントです。ログイン中のアカウントのパスワードではありませんのでご注意ください。

Excelファイル内の従業員情報について、以下の点に注意しながら修正してください。

  • Excelファイルの1行目と2行目は編集、削除しないようにご注意ください。3行目以降の従業員情報は修正することができます。

  • A列はSenseLinkが各従業員に付与し、管理するための内部IDです。編集、削除しないでください。

  • B列-S列の入力項目や制限は複数登録時のと同様です。

  • T列には認証用顔写真の登録有無が[Y]または[N]で記載されています。

R列の 性別 は、半角数字で ・1 (男性) ・2 (女性) という形式で入力する必要があります。

ダウンロードしたリストには「男性 / 女性」とテキスト形式で入力されていますが、性別情報を更新しない場合でも、R列を正しく『1 / 2』に入力し直す必要があります。

ダウンロード後に修正をせずテキスト状態のまま次の ②更新従業員リストアップロード を実行した場合、不正な情報で上書き更新が行われて既存の性別情報が失われてしまいますので、ご注意ください。

修正が完了したら、Excelファイルのパスワードによる保護を解除し、ファイルに[名前をつけて保存]してください。

Excelファイルのパスワードによる保護の解除方法

ファイル名および保存先選択画面の[ツール]をクリックし、[全般オプション]をクリックします。パスワードを消去してOKをクリックし、ファイルを保存してください。

ファイル名および保存先選択画面の[オプション]をクリックしてください。パスワードを消去してOKをクリックし、ファイルを保存してください。

Linuxをご利用中で、Microsoft Office Excel と互換性のあるソフトウェアの場合、ソフトウェアのマニュアルに従ってパスワードによる保護を解除してください。

SenseLinkに戻り、「②更新従業員リストアップロード」をクリックして、修正したExcelファイルをアップロードしてください。 アップロードが完了すると、「複数更新完了」のメッセージが画面上部に表示されます。

Excelファイルの内容に誤りがある場合、「アップロードされたフォーマットに {n} 点のエラーがあります。修正して再度アップロードしてください。」のエラーメッセージが表示されます。ファイルの内容を修正して、もう一度アップロードしてください。

6.11 従業員認証用顔写真の修正:複数修正

すでに登録済みの従業員の認証用顔写真の修正を行います。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]を選択してください。従業員管理ページが表示されます。[一括操作]タブをクリックし、[複数登録]を選択してください。

アップロード開始ボタンをクリックしてください。

Step1をスキップします。ページ下部にあるスキップボタンをクリックしてください。 「登録済みの従業員のみ認証用顔写真を登録できます。登録済みの従業員名と一致しない写真ファイルは登録されません。従業員情報アップロードをスキップしますか?」というメッセージが表示されるので、確定ボタンをクリックしスキップしてください。

以降の手順はを参照してください。

6.12 従業員の削除:複数削除

削除したい複数の従業員を指定して一括で削除することができます。

ナビゲーションメニューの[登録者タイプ]→[従業員管理]を選択してください。従業員管理ページが表示されます。[一括操作]タブをクリックし、[複数削除]を選択してください。

複数削除画面が表示されます。「①従業員リストのエクスポート」をクリックしてください。

「Excelファイルはパスワードで保護されます。パスワードは現在のアカウントです。」というメッセージが表示されます。確定ボタンをクリックするとご利用中のPCに従業員情報が記載されたExcelファイルがエクスポートされます。 以下のExcelファイル名で保存されます。[yyyy]-[mm]-[dd]はこの操作を行なった日付です。 従業員リスト[yyyy]-[mm]-[dd].xlsx

エクスポートされたファイルを開く際にパスワードを求められます。パスワードはSenseLinkにログイン中のアカウントです。ログイン中のアカウントのパスワードではないのでご注意ください。

ExcelファイルのT列に、 [削除する(Y)] の項目があります。削除したい従業員のT列に[Y]を記載してください。し、ファイルに[名前をつけて保存]してください。 また、ファイル形式ではExcelブックの.xlsx形式を選択してください。特殊な形式であるMicrosoft Excel 5.0/95ブックの.xls形式は選択しないでください。

ファイル形式は必ず Excelブック(.xlsx)形式 を選択してください。 画面上の表記に関わらず、Excel 97-2004ブック(.xls)形式 のファイルでは正常に動作しません。

Excelファイルは、T列以外の編集・削除は絶対に行わないでください。

SenseLinkに戻り、②[アップロードには削除が必要な従業員リスト]ボタン(削除する従業員リストのアップロード)をクリックして、先ほど編集・保存したExcelファイルをアップロードしてください。

③削除ボタンをクリックしてください。確認のためにパスワードの入力を求められます。現在ログイン中のアカウントのパスワードを入力してください。

削除が完了すると「一括削除に成功しました」のメッセージが表示されます。

大量のデータ削除のために処理時間が1分以上かかった際、「応答エラー」が発生することがあります。しかしバックグラウンドで削除が続いていますので、エラーが出てもデータ削除処理に影響はありません。

6.13 登録レコード

登録者ごとの顔写真の登録レコードを管理することができます。

顔写真の登録申請があった際は、操作列に「承認」および「却下」が選択可能です。「承認」をクリックすると、申請された顔写真が対象の従業員に反映されます。

ナビゲーションメニューの[登録者タイプ]→[登録レコード]をクリックすると、登録レコードが表示されます。検索機能として登録者タイプ選択、登録日付絞り込み、登録デバイス、登録者名や携帯電話番号などがあります。

6.14 写真による検索

登録者を写真で検索することができます。 ナビゲーションメニューの[登録者タイプ]→[写真による検索]をクリックしてください。写真による検索画面が表示されます。

写真アップロードをクリックして、検索に利用したい写真をアップロードしてください。写真の規格は を参照してください。

認証しきい値の値を設定してください。0.5~1.0の間で設定できます。 表示人数(上位)で、類似度の上位何人を検索結果として表示するかを設定してください。

設定が完了したら、検索ボタンをクリックしてください。検索結果が表示されます。 検索結果は類似度が高い順に表示されます。各検索結果の認証レコード 表示ボタンをクリックすると、登録者の認証レコードを確認することができます。

【しきい値とは】 しきい値は、SenseLinkのアルゴリズムによって計算される、本人を本人として認証する類似スコアの最小値です。類似スコアとは、登録した顔と検索した顔の特徴量の類似度を示すSenseLink独自のスコアであり、2つの顔の特徴量が完全一致する場合に1になるよう重みをつけたものです。 しきい値を高くすると認証の条件を厳しくしたこととなり、類似スコアがしきい値より高くないと認証されないため、FRR(False reject rate:本人棄却率、本人同士を他人だと間違えてしまう確率)が高くなります。 逆にしきい値を低くすると認証の条件を緩くしたこととなり、類似スコアが低くても認証してしまうため、FAR(False accept rate: 他人受入率、別人同士を本人だと間違えてしまう確率)が高くなります。

6.15 登録者情報のエクスポート

登録者情報を最大100,000件までExcelファイルにエクスポートすることができます。ただし写真はエクスポートできません。

従業員情報の場合を例に操作手順を記載します。ビジター、拒否リストの場合はそれぞれビジター管理メニュー、拒否リスト管理メニューに読み替えて同様の手順を実施してください。

ナビゲーションメニュー [登録者タイプ]→[従業員管理]から従業員一覧を表示してください。エクスポートしたい登録者または登録者グループを選択し、エクスポートボタンをクリックしてください。

「エクスポートされたExcelファイルのパスワードは現在のアカウントです。」というメッセージが表示されます。 確定ボタンをクリックすると、登録者情報が記載されたExcelファイルがご利用中のPCのダウンロードフォルダに保存されます。

登録者タイプが従業員、ビジター、拒否リストのそれぞれの場合、以下のExcelファイル名で保存されます。[yyyy]-[mm]-[dd]はこの操作を行なった日付です。

  • 従業員リスト[yyyy]-[mm]-[dd].xlsx

  • ビジターリスト[yyyy]-[mm]-[dd].xlsx

  • 拒否リスト[yyyy]-[mm]-[dd].xlsx

Excelファイルを開くには、パスワードを入力する必要があります。パスワードはExcelファイルエクスポートを行なったユーザーのアカウントです。

6.16 登録レコードのエクスポート

登録レコードを最大100,000件までExcelファイルにエクスポートすることができます。ただし写真はエクスポートできません。

ナビゲーションメニュー [登録者タイプ]→[登録レコード]から登録レコード一覧を表示してください。エクスポートしたいレコードを検索で絞り込み、エクスポートボタンをクリックしてください。

現在、絞り込み内容をエクスポートファイルに反映できるのは、日付と検索欄で検索したキーワードのみです。登録ステイタスとデバイスは、エクスポート条件として機能していません。

以下のExcelファイル名で保存されます。[yyyy]-[mm]-[dd]はこの操作を行なった日付です。 登録レコード[yyyy]-[mm]-[dd].xlsx

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

登録者タイプ

概要、他の登録者タイプとの違い

従業員

自社の従業員登録・管理用

  • 従業員番号、入社日、所属部署など従業員独自の管理項目

  • 一括操作メニューやToolKitによる一括登録や修正

  • 勤怠管理機能との連携

ビジター

来訪者の登録・管理用

  • 期間限定のアクセス権限管理

  • 企業名、来訪目的、受付担当者、ビジターカテゴリー(VIP/一般など)など、ビジター独自の管理項目

拒否リスト

不審者など拒否リスト上の人物の登録・管理用

  • 拒否リスト認証時にドアオープンOn/Offの設定

  • 拒否リスト認証時にデバイス上に独自メッセージ表示

項目

詳細、文字種制限、フォーマット、注意事項など

最小文字数

最大文字数

認証写真

認証用顔写真。

写真の注意事項は6.2節 登録する認証写真の規格 をご参照ください

必須項目ではありませんが、登録を行うまで顔認証は行われません(本人が顔認証を行なっても「未登録者」として検知されます)

-

-

顔写真品質チェックレベル

認証用顔写真登録時の品質チェックレベル。 新規登録の場合、デフォルトは「Ⅲ」です。 既存登録者を更新する場合、デフォルトは「Ⅰ」です。

Ⅲ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています。

Ⅱ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています。

Ⅰ:写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています。

-

-

表示写真

認証時に表示される顔写真。

JPEGまたはPNG形式、約3.8MB

設定しない場合、認証写真が認証時表示用顔写真として表示されます。SensePass V1.2.3で当機能はサポートされません。認証時は認証写真が表示されます

-

-

氏名

必須項目

1

30

性別

(選択肢)

-

-

従業員グループ

必須項目 (選択肢)

-

-

携帯電話番号①

国コード、国別コードを選択してください 日本の携帯電話を利用している場合、[+81]を選択してください

-

-

携帯電話番号②

  • すべての登録者タイプの中で一意である必要があります

  • 携帯電話番号①の国コードが異なる場合、同一の携帯電話番号を登録することはできません +81-08012345678 と+12-08012345678は、同一携帯電話番号として判断されます

  • 氏名が重複する従業員が存在する場合、複数更新を行うために必ず当項目を登録してください

  • ハイフンは利用できません。半角数字のみ利用してください

6

20

内線電話番号

半角数字

-

20

部署

(選択肢)

-

-

役職

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

40

従業員番号

半角英数字

一意である必要があります

-

20

メールアドレス

半角英数字、-._@(半角)

[email protected] または [email protected]の形式のみ

6

45

よく似た人

登録者と非常に似ている人がすでに登録されている場合(例:双子など)、「はい」を選択し、アクセスコード(4桁の数字)を入力してください。

-

-

IC カード

半角数字

10進数表記で一意の数値を入力してください

デバイス設定でゲート(ドア)連動でWiegand(26bit(8+16)、26bit(24)、32bit、34bit)のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号である必要があります。各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しません

-

20

IDカード

(中国国籍の方が持つ番号です。サポートされない機能のため、入力しないでください。)

-

-

勤務地

(自由入力)

-

40

生年月日

(日付選択)

-

-

年齢

(生年月日から自動計算)

-

-

入社年月日

(日付選択)

-

-

カスタムメッセージ

顔認証時に表示するカスタムメッセージ

-

45

特記事項

(自由入力)

-

200

項目

入力可能文字種、フォーマット、注意事項など

最小文字数

最大文字数

認証写真

認証用顔写真

写真の注意事項は6.2節 登録する認証写真の規格 をご参照ください

必須項目ではありませんが、登録を行うまで顔認証は行われません(本人が顔認証を行なっても「未登録者」として検知されます)

-

-

顔写真品質チェックレベル

認証用顔写真登録時の品質チェックレベル。 新規登録の場合、デフォルトは「Ⅲ」です。 既存登録者を更新する場合、デフォルトは「Ⅰ」です。

Ⅲ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています。

Ⅱ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています。

Ⅰ:写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています。

-

-

表示写真

認証時に表示される顔写真

JPEGまたはPNG形式、約3.8MB

設定しない場合、認証写真が認証時表示用顔写真として表示されます。SensePass V1.2.3では当機能はサポートされません。認証時は認証写真が表示されます

-

-

氏名

入力必須項目

1

30

来訪期間

(日付選択)

ビジターが来訪し、アクセスが可能な期間

来訪期間外にビジターが認証を行なった場合、アクセス権限なしと見なされてドアオープンシグナルは発信されず、ドア/ゲートが開きません SenseLinkの認証レコードには、来訪期間期間外の異常検知として記録されます

-

-

性別

(選択肢)

-

-

ビジターグループ

(選択肢)

-

-

携帯電話番号①

国コード、国別コードを選択してください

日本の携帯電話を利用している場合、[+81]を選択してください

-

-

携帯電話番号②

  • すべての登録者タイプの中で一意である必要があります

  • 携帯電話番号①の国コードが異なる場合、同一の携帯電話番号を登録することはできません +81-08012345678 と+12-08012345678は、同一携帯電話番号として判断されます

  • 氏名が重複するビジターが存在する場合、複数更新を行うために、必ず当項目を登録してください。

  • ハイフンは利用できません。半角数字のみ利用してください

6

20

企業

-

45

役職

-

40

来訪目的

-

50

受付担当者

(検索および選択肢)

-

-

メールアドレス

半角英数字、-._@(半角)

[email protected] または [email protected]の形式のみ

6

45

よく似た人

登録者と非常に似ている人がすでに登録されている場合(例:双子など)、「はい」を選択し、アクセスコード(4桁の数字)を入力してください。

-

-

ビジターカテゴリー

-

20

ICカード

半角数字

10進数表記で一意の数値を入力してください

デバイス設定でゲート(ドア)連動でWiegand(26bit(8+16)、26bit(24)、32bit、34bit)のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号である必要があります 各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しません

-

20

IDカード

(中国国籍の方が持つ番号です。サポートされない機能です。利用できません。)

-

-

生年月日

(選択)

-

-

年齢

(生年月日から自動計算)

-

-

カスタムメッセージ

顔認証時に表示するカスタムメッセージ

-

45

特記事項

-

200

項目

入力可能文字種、フォーマット、注意事項など

最小文字数

最大文字数

認証写真

認証用顔写真。

写真の注意事項は6.2節 登録する認証写真の規格 をご参照ください

認証写真は登録を行わず内容を保存することは可能ですが、登録を行うまで顔認証は行われません(本人が顔認証を行なっても「未登録者」として検知されます)

-

-

顔写真品質チェックレベル

認証用顔写真登録時の品質チェックレベル。 新規登録の場合、デフォルトは「Ⅲ」です。 既存登録者を更新する場合、デフォルトは「Ⅰ」です。

Ⅲ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています。

Ⅱ:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています。

Ⅰ:写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています。

-

-

表示写真

認証時表示用顔写真。

JPEGまたはPNG形式、約3.8MB以下

設定しない場合、認証用写真が認証時表示用顔写真として表示されます

SensePass GE V1.2.3では表示用顔写真をサポートしていません。認証時は認証写真が表示されます

-

-

氏名

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

入力必須項目です

1

30

性別

(選択肢)

-

-

拒否リストグループ

(選択肢)

-

-

携帯電話番号①

国コード、国別コードを選択してください

日本の携帯電話を利用している場合、[+81]を選択してください

-

-

携帯電話番号②

  • すべての登録者タイプの中で一意である必要があります

  • 携帯電話番号①の国コードが異なる場合、同一の携帯電話番号を登録することはできません +81-08012345678 と+12-08012345678は、同一携帯電話番号として判断されます

  • 氏名が重複する拒否リストが存在する場合、複数更新を行うために、必ず当項目を登録してください。

  • ハイフンは利用できません。半角数字のみ利用してください

6

20

メールアドレス

半角英数字、-._@(半角)

[email protected] または [email protected]の形式のみ

6

45

ICカード

半角数字 一意である必要があります

デバイス設定のゲート(ドア)連動でWiegand(26bit(8+16)、26bit(24)、32bit、34bit)のいずれかを選択した場合、各Wiegandの仕様を満たすICカード番号を入力いただく必要があります。各Wiegandの仕様を満たさないICカード番号が入力された場合、顔認証後のドアオープンシグナルが正常に動作しない可能性があります。ゲート(ドア)連動でのWiegandの選択に関わらず、10進数で入力ください

-

20

IDカード

(中国国籍の方が持つ番号です。サポートされない機能です。利用できません。)

-

-

生年月日

(日付選択)

-

-

年齢

(生年月日から自動計算)

-

-

カスタムメッセージ

顔認証時に表示するカスタムメッセージ。 半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

45

特記事項

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

200

項目

入力可能文字種、フォーマット、注意事項など

最小文字数

最大文字数

氏名

氏名。入力必須項目です。 半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

1

30

国コード

国番号、国別コード、国コード。日本の携帯電話番号を利用する場合は81を入力してください。

1

2

携帯電話番号

半角数字

一意である必要があります。

区番号(国番号、国コード)が異なる場合も81-8012345678 と12-8012345678 は同一携帯電話番号として判断し、同時に登録できません。

4

18

部署

  • 入力内容に従って自動的に部署の階層が登録されます。

  • 最上位部署から記入を開始し、下位部署は半角ハイフンの後に入力してください。 例:海外ビジネス部門-マーケティング本部

  • 1人の従業員は1つの部署のみに所属することができます。

  • 部署名に半角ハイフン(-)を含むことはできません。

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号 左欄の文字数は1部署名の制限です。

1

30

役職

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

40

従業員番号

半角数字

一意である必要があります。

-

20

部署責任者 (Y/N)

所属部署の責任者の場合はYを、責任者ではない場合はNを入力してください。

-

-

メールアドレス

半角英数字、-._@(半角) [email protected] または [email protected]の形式のみ

6

40

内線番号

半角数字

-

20

勤務地

勤務地 半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

40

ICカード番号

半角数字 10進数表記で従って入力してください。

一意である必要があります。

-

20

IDカード番号

中国国籍の方が持つ番号です。サポートされない機能のため、入力しないでください。

-

-

入社日付

入力フォーマットはYYYY-MM-DDです。 2020年4月1日入社の場合、半角数字と半角ハイフンで2020-04-01 と入力してください。

-

-

生年月日

入力フォーマットはYYYY-MM-DDです。 1975年1月1日生まれの場合、半角数字と半角ハイフンで1975-01-01 と入力してください。

-

-

従業員グループ

必須項目です。 デフォルトグループに所属させる場合は 「デフォルトグループ」、1人の従業員を複数の従業員グループに登録させる場合はグループ名を半角カンマ(,)で区切ってください 右欄の文字数は1グループ名の入力制限数です。

-

30

カスタムメッセージ

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

45

性別

1:女性、2:男性

-

1

特記事項

半角英数字、全半角スペース、漢字、ひらがな、カタカナ、全半角記号

-

200

No

アカウント名(氏名)

携帯電話番号

エラー詳細

エラー発生したExcel行

エラーが発生した従業員の氏名

エラーが発生した従業員の携帯電話番号

エラーの詳細、エラーメッセージ

レベル

詳細

Ⅲ

写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています

Ⅱ

写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています

Ⅰ

写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています

エラーメッセージ

メッセージの意味、必要な対処

库中未找到此人 The person does not exist

写真ファイル名に一致する氏名の従業員が登録されていません。写真ファイル名か、登録されている従業員の氏名を確認してください

库中存在同名的人 There is a person with the same name exist

同名の従業員が存在します。写真ファイル名を[氏名].jpg(または.png)から[氏名]+[国別コード付きの携帯電話番号].jpg(またはpng)に変更してください。

従業員に携帯電話番号を登録していない場合は登録してください

人脸质量不合格:未检测到人脸 Unqualified avatar: No faces are detected

写真の品質エラー。写真内に顔が存在しません。顔が1つ写っている写真を登録してください

人脸质量不合格:存在多人脸 Unqualified avatar: Multiple faces are detected

写真の品質エラー。写真内に複数の顔が存在します。顔が1つだけ写っている写真を登録してください

人脸质量不合格:图片尺寸过小 Unqualified avatar: Image size is too small

写真の品質エラー。写真のサイズが小さすぎます。規格に適合するサイズの写真を利用してください

人脸质量不合格:关键点置信度过低 Unqualified avatar: Alignment score is too low

写真の品質エラー。取得できる特徴点が少ないため、品質の高い写真を利用してください

人脸质量不合格:有效人脸区域像素过低 Unqualified avatar: Face area size is too small

写真の品質エラー。顔部分のサイズが小さすぎます

人脸质量不合格:俯仰角过大 Unqualified avatar: Pitch angle is too large

写真の品質エラー。顔のピッチが大きすぎます。正面を向いた写真を利用してください

人脸质量不合格:偏转角过大 Unqualified avatar: Yaw angle is too large

写真の品質エラー。顔のヨーが大きすぎます。正面を向いた写真を利用してください

人脸质量不合格:侧倾角过大 Unqualified avatar: Roll angle is too large

写真の品質エラー。顔のロールが大きすぎます。正面を向いた写真を利用してください

人脸质量不合格:人脸距离图片中心过远 Unqualified avatar: Face is too far from the center of the image

写真の品質エラー。顔が写真の中心から離れすぎています

人脸质量不合格:人脸占比过低 Unqualified avatar: Face proportion is too low

写真の品質エラー。写真と顔の比率が小さすぎます

人脸质量不合格:人脸遮挡过多 Unqualified avatar: Face occluded

写真の品質エラー。髪の毛や髭、帽子、物体で顔が隠れています

人脸质量不合格:图片过暗或过亮 Unqualified avatar: Image is too dark or too bright

写真の品質エラー。写真が明るすぎ、もしくは暗すぎます

人脸质量不合格:图片过模糊 Unqualified avatar: Image is too blurry

写真の品質エラー。顔がぼやけています

人脸质量不合格:嘴部过度张开 Unqualified avatar: Mouth is opened too much

写真の品質エラー。口が開いています

人脸质量不合格:面部缺失过多 Unqualified avatar: Too much loss of face

写真の品質エラー。写真に顔が収まっていません

人脸质量不合格

写真の品質エラー

6.10節 従業員情報の修正:複数修正
6.10節 従業員情報の修正:複数修正
6.2節 登録する認証写真の規格
Excelテンプレートへの入力項目
6.9.2項 従業員の認証用顔写真のアップロード(Step 2)
Excelファイルのパスワードによる保護を解除
6.2節 登録する認証写真の規格
従業員の登録
保存ボタン
登録者情報の修正
登録者情報の修正
修正内容の保存
登録者情報の削除
登録者タイプの変更
拒否リストに登録ボタン
拒否リストグループ登録
複数登録画面への遷移方法
複数登録のステップ説明とアップロード開始ボタン
タスクリスク画面への遷移方法
タスクリスク画面
Excelテンプレート
アップロード済みExcelファイルの削除方法
アップロード結果エクスポート
複数修正画面への遷移方法
複数登録画面への遷移方法
アップロード開始ボタン
Step1のスキップボタン
複数削除画面への遷移
複数削除画面
登録者ごとの顔写真の登録レコードを管理できる
写真による検索
検索結果
エクスポートボタン

2.10 イベントサブスクリプション API

2.10.1 概要

外部システムはSenseLinkのサブスクリプションサービスを利用することで、SenseLinkのイベントをサブスクライブすることができます。SenseLinkはデバイスの認証とアラート(以下、「イベント」)をPOSTリクエスト(以下、「Push」)することができます。

サブスクリプションサービスの概要

2.10.2 利用の開始

当節で記載される手順・設定の他にJCVサポート窓口へ以下の情報を申請してください。申請およびJCVサポート窓口の処理が完了するまで、イベントサブスクリプション機能は利用できません。

  • イベントを処理するAPIエンドポイント(アプリケーションのURL)

  • 上記エンドポイントのIPアドレス

サブスクリプション申請時に提出する情報は以下のものです

  • 固定IPアドレスとポート番号(必須)

  • URL(サブスクリプションを受け取るクライアント側URL)(必須)

    ※注:クライアント側URLとの通信に際し、BASIC認証などの認証技術は対応しておりません。

  • アカウントID (必須)

  • テナントID(オプション)

イベントをサブスクライブする外部システムのAPIエンドポイントは、SenseLinkのナビゲーションメニュー [ユーザー名]→[オープンプラットフォーム] 内のサブスクリプションサービスステータス欄のドメイン管理、もしくは本マニュアル内のAPIで設定および更新することができます。

イベントサブスクリプションサービス設定

サブスクリプションサービス設定を選択して表示されるイベント処理サーバーアドレスの欄に、連携する外部システムのサーバーアドレスを入力してください。プロトコルはhttp、httpsをサポートしています。https://またはhttps://から入力してください。複数のエンドポイントを設定することができますので、セミコロン(;)で区切ってください。

サブスクリプションイベントタイプ欄で「認証レコード」にチェックを入れ、サブスクライブするイベントのタイプを選んでください。

デバイスで認証が行われた際、認証レコードをPushで受け取るには認証レコード、デバイスアラートが発生した場合にPushで受け取るにはデバイスアラートを選択してください。 なお、両方を選択することも可能です。

2.10.4 認証レコードタイプの種類

認証レコードタイプには、以下の種類があります。

パラメーター名

正常な認証レコード

顔+IDカード不一致

顔+ICカード不一致

顔+QRコード不一致

来訪期間外

アクセス時間外

無効なIDカード

無効なICカード

無効なQRコード

温度異常

マスク検知用

認証レコード+

サブスクリプションを更新した際に、再保存時に認証レコードタイプ/デバイスアラートタイプが「未選定」の状態になる場合があります。その場合は再設定してください。

設定が完了したら、保存ボタンをクリックしてください。オープンプラットフォーム画面に戻ります。 サブスクリプションサービスステータスが「Normal」と表示されていれば、イベントがサブスクライブされています。

2.10.5 サブスクリプションサービスの設定の変更と停止

サブスクリプションサービスの設定を変更するには、サブスクリプションサービス欄の詳細ボタンをクリックしてください。

イベントサブスクリプション詳細設定画面

サブスクリプションサービスを停止するには、サブスクリプション停止ボタンをクリックしてください。サービスが停止され、外部システムにイベントがPushされなくなります。

サブスクリプションサービスの設定を修正するには、サブスクリプション更新ボタンをクリックしてください。設定内容を変更できます。変更内容を入力後、保存してください。

2.10.6 Push失敗の場合

イベントのPush後、外部システムは100秒以内にレスポンスを返却するか、リターンコード200を返却する必要があります。

100秒以内にレスポンスが返却されない場合、またはリターンコードが200以外の場合はエラーとみなされ、SenseLinkはそのイベントを再Pushしません。その後SenseLinkは外部システムのサブスクリプションステータスを「異常」に変更し、エラーログとして保存されます。ただし、その後発生した新しいイベントのPushには影響はありません。

なお、レスポンスが100秒以内に返却された、かつリターンコードが200になった場合、サブスクリプションステータスは「正常」に戻ります。

2.10.7 イベントPushログ

オープンプラットフォーム画面のサブスクリプションサービスステータス欄の詳細をクリックし、サブスクリプションサービスの設定画面にあるログボタンをクリックすると、最新のイベントPushの結果(以下、「ログ」)を確認することができます。

イベントサブスクリプション詳細設定画面

ログは最大100件まで保存され、100件を越えると古いものから順に削除されます。各ログの詳細ボタンをクリックすると認証レコードページまたはデバイスアラートページに遷移し、イベントの詳細を確認することができます。 イベントタイプまたはステータスで、ログを検索することができます。リセットボタンをクリックすると検索による絞り込みがリセットされ、すべてのログが表示されます。

ログ

テストイベント送信ボタンをクリックすると、テストイベントを連携中の外部システムにPush することができます。 認証レコードとデバイスアラートが選択されている場合、または認証レコードのみが選択されている場合は認証レコードのテストイベントが送信されます。 デバイスアラートのみが選択されている場合、デバイスアラートのテストイベントが送信されます。

2.10.8 イベントPushのプロトコル

リクエスト方法

POST application/json

イベントPushの例

認証レコード

{
    messageId: '75835750-6dd9-4eed-a929-ba1b4c062405',
    eventType: 30000,
    data: { 
        id: 120260,
        userId: 30707,
        name: '次郎',
        type: 1,
        avatar: '5e65c020f54fd90001fe4a33',
        direction: 0,
        verifyScore: 0.94,
        receptionUserId: 0,
        receptionUserName: null,
        groups: [ { id: 1, name: 'Default group', type: 1 } ],
        deviceName: 'SenseTest',
        sn: 'SPS-e33b1811dbd9189c5eeedffd557fd779',
        signDate: '2020-03-09',
        signTime: 1583726625,
        signAvatar: '5e65c021f54fd90001fe4a37',
        signBgAvatar: '5e65c021f54fd90001fe4a38',
        companyId: 1,
        mobile: '18014398265',
        icNumber: '',
        idNumber: '',
        jobNumber: '3867452109',
        remark: 'welcome',
        entryMode: 1,
        signTimeZone: '+09:00',
        docPhoto: '',
        latitude: 0,
        longitude: 0,
        address: '',
        location: 'SZ-40F',
        abnormalType: 40001,
        userIcNumber: '4751283096',
        userIdNumber: '1g2qW2hz5OwbudHe5gekKbZtmUt0Xwfy',
        bodyTemperature: 38,
        mask: 1,
        signTimeStr:'2021-10-28 12:08:53'
        extInfo:"[{\"name\":\"attendance_flag\",\"value\":1}]"
    },
    sendTime: 1583726626015,
}

デバイスアラート

{
    messageId: '5ee92a0e-7c6b-416c-8843-54a154a3a409',
    eventType: 30100,
    data:{
        id: 35569,
        traceId: '1583726800000',
        code: 10001,
        alarmTime: '2020-03-09 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: '',
        status: 3
    },
    sendTime: 1583726801752
}

Pushするイベントのパラメーター

パラメーター名

型

必須

説明

messageId

string

Yes

イベントの固有の識別子

eventType

int

Yes

30000:認証レコード

30100:デバイスアラート

sendTime

long

Yes

イベント発生時刻(デバイス時間)

data

object

Yes

イベントの対象

認証レコードデータの属性

パラメーター名

型

説明

id

int

レコードID

userId

int

認証されたユーザーのID

name

string

認証されたユーザーの名前

type

int

ユーザーの識別子タイプ

1:従業員

2:ビジター

3:未登録人物

5:拒否リスト

avatar

string

認証用顔写真

direction

int

デバイスのアクセス方向

verifyScore

float

認証スコア

receptionUserId

int

認証されたユーザーの対応者ID

receptionUserName

string

認証されたユーザーの対応者の名前

groups

list<group>

認証されたユーザーのグループ情報

deviceName

string

デバイス名

sn

string

この認証レコードのデバイス LDID番号をアップロードします

signDate

string

認証レコードの日付

signTime

timestamp

認証時刻(秒)

signAvatar

string

認証時写真(サムネイル)

signBgAvatar

string

認証時写真(大)

companyId

long

企業ID

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写真

latitude

double

緯度

longitude

double

経度

address

string

住所

location

string

デバイスの設置場所

abnormalType

int

認証レコードの異常のタイプ

0:なし

10001:IDカード不一致

10002:認証カード不一致

10003:認証コード不一致

20001:ビジターが有効期限外

20002:アクセス期限内ではない

30001:無効なIDカード

30002:無効なICカード

30003:無効なQRコード

40001:異常な体温

50001:マスク着用なし

userIdNumber

(利用できません)

bodyTemperature

float

体温

mask

int

マスク着用識別子

0:不明

1:着用なし

2:着用あり

signTimeStr

string

認証時刻

extinfo

string

拡張情報

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

1:従業員グループ

2:ビジターグループ

5:拒否リストグループ

デバイスのアラートレコードのデータ属性

パラメーター名

型

説明

id

long

アラートレコードのID

traceId

string

アラートのシリアル番号。デバイスによって生成されるアラート固有の識別番号です。

code

int

アラートのタイプ

10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

10003:ドアセンサータイムアウト

10004:パスワードクラッキング

10005 :(サポートされないアラートです。現在利用できません)

10006:サーモグラフィカメラ接続異常

20001:カメラの汚れ

20002:Non-Living アタック(非生体による認証)

20003:消防アラート

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

alarmTime

string

アラート時間

level

int

アラートレベル

1:アラート

2:異常

deviceId

long

デバイスのID

deviceSn

string

デバイスのLDID

deviceLocation

string

デバイスの設置場所

deviceName

string

デバイス名

resloveOption

int

アラートの解除オプション

0:解除不要

1:デバイスエンドでの解除のみをサポート

2:リモート解除のみをサポート

3:デバイスエンドまたはリモートでの解除

0:解除不要

10004:パスワードクラッキング

20002:Non-Living アタック(非生体による認証)

30001:デバイスオフラインアラート

1:デバイスエンドでの解除のみをサポート

10003:ドアセンサータイムアウト

20001:カメラの汚れ

10005 :(サポートされないアラートです。現在利用できません)

10006:サーモグラフィカメラ接続異常

3:デバイスエンドまたはリモートでの解除

10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

20003:消防アラート

alarmPhoto

string

アラート写真

companyID

long

企業ID

description

string

アラートの説明

releaseTime

string

アラートの解除時間

status

int

アラートのステータス

1:アラート作動中

2:解除中

3:解除済み

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

必須

説明

code

int

Yes

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

Yes

リターン情報です。インターフェース実行情報を記録します。successは成功の情報を示し、その他は失敗を示します

desc

string

No

リターンの説明

data

object

No

データ

2.10.9 サブスクリプション更新API (/api/v4/event/updateSub)

概要

イベントのサブスクリプションを追加または更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/event/updateSub

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

recognition_records_types

list<int>

Yes

認証レコードの異常のタイプ

0:正常な認証レコード

10001:IDカード不一致

10002:認証カード不一致 10003:認証コード不一致

20001:ビジターが有効期限外

20002:アクセス期限内ではない

30001:無効な ID カード

30002:無効な IC カード

30003:無効な QR コード

40001:異常な体温

50001:マスク着用なし

device_alarm_types

list<int>

Yes

アラートのタイプ

10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

10003:ドアセンサータイムアウト

10004:パスワードクラッキング

10005:(サポートされないアラートです。現在利用できません)

10006:サーモグラフィカメラ接続異常

20001:カメラの汚れ

20002:Non-Living アタック(非生体による認証)

20003:消防アラート

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

event_dest

string

Yes

イベントをサブスクライブする外部システムのサーバーアドレスを指定します。restful コールバックを利用し、http および https をサポートしています。 スタイルは、 または で、 最大 1,024 文字です。 外部システムのサーバーアドレスは指定された仕様に基づいて申請したパーティから提供されます。外部システムのインターフェースの認証は必要ありません。

空の値で登録しないでください

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code":200,
    "message":"OK",
    "data":{
        "recognition_records_types":[
            0,
            10001,
            10002
        ],
        "device_alarm_types":[
            20003,
            30001,
            40001
        ],
        "event_dest":"https://ip:port/eventRcv",
        "sub_status":1
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

recognition_records_types

list<int>

認識レコードタイプの配列

device_alarm_types

list<int>

デバイスアラートの配列

event_dest

string

イベントをサブスクライブする外部システムのサーバーアドレス

sub_status

int

サブスクリプションサービスのステータス

0:構成されていません

1:正常

2:異常(最後のPushステータスに基づく)

エラーレスポンスのフィールド

code

メッセージ

説明

60001

openapi status error

OpenAPIステータス異常

30001

Param Invalid

外部システムのサーバーアドレスが不正です

30001

Param Invalid

イベントIDが存在しません

30001

Param Invalid

無効なパラメーターです

30001

Param Invalid

認識レコードタイプが不正です

30001

Param Invalid

デバイスアラートタイプが不正です

2.10.10 サブスクリプション停止API (/api/v3/event/stopSub)

概要

イベントのサブスクリプションを停止します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/stopSub

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します

desc

string

リターンの説明

data

object

データ

エラーレスポンスのフィールド

code

メッセージ

説明

60001

openapi status error

OpenAPIステータス異常

60002

not config event sub

サブスクリプションサービスが構成されていません

2.10.11 サブスクリプション詳細表示API (/api/v4/event/viewSub)

概要

サブスクリプションの詳細を表示します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/event/viewSub

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "success",
    "desc": "",
    "data": {
        "recognition_records_types": [
            50001,
            40001
        ],
        "device_alarm_types": [
            10001,
            10002
        ],
        "event_dest": "https://ip:port/eventRcv",
        "sub_status": 1
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

recognition_records_types

list<int>

認証レコードの異常のタイプ

0 :正常な認証レコード

10001:IDカード不一致

10002:認証カード不一致

10003:認証コード不一致

20001:ビジターが有効期限外

20002:アクセス期限内ではない

30001:無効な ID カード

30002:無効な IC カード

30003:無効な QR コード

40001:異常な体温

50001:マスク着用なし

device_alarm_types

list<int>

アラートのタイプ

10001:デバイスの盗難アラート

10002:ドア・ゲート強制突破アラート

10003:ドアセンサータイムアウト

10004:パスワードクラッキング

10005:(サポートされないアラートです。現在利用できません)

10006:サーモグラフィカメラ接続異常

20001:カメラの汚れ

20002:Non-Living アタック(非生体による認証)

20003:消防アラート

30001:デバイスオフラインアラート

40001:特徴量抽出エラー

event_dest

string

イベントをサブスクライブする外部システムのサーバーアドレス

sub_status

int

サブスクリプションサービスのステータス

0:構成されていません

1:正常

2:異常(最後のPushステータスに基づく)

エラーレスポンスのフィールド

コード

メッセージ

説明

60001

openapi status error

OpenAPIステータス異常

60002

not config event sub

サブスクリプションサービスが構成されていません

2.10.12 イベントPushログの表示 (/api/v3/event/viewLog)

概要

イベントのPushログを表示します。

サブスクリプションサービスが起動されなくても、該当するAPIを使って前に生成されたログを取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/viewLog

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": [
        {
            "id": 20816,
            "status": 200,
            "company_id": 1162,
            "event_type_id": 30000,
            "event_message": null,
            "create_at": "2022-03-21T02:14:16.000+0000",
            "message_id": 29767021,
            "push_id": "00000000-0000-0000-0000-000000000000",
            "is_test": null,
            "abnormal_code": 0,
            "event_dest": "https://ip:port/eventRcv"
        },
    ]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

リターン情報です。インターフェース実行情報を記録します。success は成功の情報を示し、その他は失敗を示します

desc

string

リターンの説明

data

object

リターンデータです。イベントサブスクリプションの詳細です

dataフィールドの説明

パラメーター名

型

説明

id

int

イベントID

company_id

int

企業ID

event_type_id

int

イベントタイプの ID

30000:認証レコード

30100:アラートPush

event_message

string

Pushメッセージ本体

status

int

リターンステータス

200:成功

404:サーバー応答不可

500 : 内部例外

create_at

string

イベント生成時間

message_id

int

レコードID、またはアラームID

push_id

string

イベントプッシュID

is_test

int

テストイベント:1

非テストイベント:0

abnormal_code

int

イベントメッセージ

event_dest

string

イベント処理サーバーアドレス

エラーレスポンスのフィールド

コード

メッセージ

説明

60001

openapi status error

OpenAPIステータス異常

60002

not config event sub

サブスクリプションサービスが構成されていません

2.10.13 テストイベントの送信 (/api/v3/event/sendTest)

概要

テストイベントをPush送信します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/sendTest

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード。200 は成功を示し、その他のコードは失敗を示します

message

string

リターン情報です。インターフェース実行情報を記録します。success は成功を示し、その他は失敗を示します

desc

string

リターンの説明

data

object

リターンデータ

エラーレスポンスのフィールド

コード

メッセージ

説明

60001

openapi status error

OpenAPIステータス異常

60002

not config event sub

サブスクリプションサービスが構成されていません

http://ip:port/eventRcv
https://ip:port/eventRcv
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.8 認証用顔写真の API

2.8.1 顔の数の検知 (/api/v1/recognition/check)

概要

認証用顔写真内の顔の数を特定します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/recognition/check

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

face_avatar

file

Yes

認証用顔写真

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": 4
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

不正なリターンの説明

data

int

顔の数

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

認証用顔写真のタイプが不正です

30003

No Face Detected In The Image

顔が検出されませんでした。

2.8.2 認証用顔写真品質の検出 (/api/v3/recognition/quality)

概要

選定した品質チェックレベルで、認証用顔写真の品質を検出します。 写真に複数の顔がある場合、最大の顔の情報のみ表示されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

face_avatar

file

Yes

認証用顔写真

qa_level

int

No

品質チェックレベル。1:低、2:高、3:厳格。既定値は3です。

品質チェックレベル:

  • 低:写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています。

  • 高:写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています。

  • 厳格:パスポートの要件を参照し、写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています。

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス(qa_level='1')

{
    "code": 200,
    "message": "OK",
    "data": {
        "qa_code": 0,
        "qa_desc": "Pass",
        "qa_msg": "Pass"
    }
}

通常のレスポンス(qa_level='2')

{
    "code": 200,
    "message": "OK",
    "data": {
        "face": {
            "pose": { 
                "yaw": -6.984859, 
                "pitch": 14.09827, 
                "roll": -2.4992712 
            },
            "distance2center": 0.8623486, 
            "size": 0.39172968,  
            "brightness": 0.29538798, 
            "sharpness": 1.0, 
            "missing": 1.0,  
            "occlusion_total":0.9,
            "mouth_open": 0.9553734 
        },
        "qa_code": 0,
        "qa_desc": "Pass",
        "qa_msg": "Pass"
    }
}

通常のレスポンス(qa_level='3')

{
    "code": 200,
    "message": "OK",
    "data": {
        "face": {
            "pose": { 
                "yaw": -6.984859, 
                "pitch": 14.09827, 
                "roll": -2.4992712 
            },
            "occlusion": { 
                "eye": 1.0, 
                "nose": 1.0, 
                "mouth": 1.0, 
                "eyebrow": 1.0, 
                "face_line": 0.9
            },
            "distance2center": 0.8623486, 
            "size": 0.39172968,  
            "brightness": 0.29538798, 
            "sharpness": 1.0, 
            "missing": 1.0,  
            "mouth_open": 0.9553734 
        },
        "qa_code": 0,
        "qa_desc": "Pass",
        "qa_msg": "Pass"
    }
}

レスポンスのフィールド

パラメーター名

型

説明

qa_code

int

リターンコード

qa_msg

string

リターンメッセージ

qa_desc

string

リターンの説明

face

Object

顔の品質情報(qa_codeは0「通過」の場合のみ、表示されます)

face項目の説明(qa_level='2')

パラメーター名

型

値域

説明

pose/yaw

float

[-90,90]

顔が上下を軸にした回転角度

頭が左寄りのほど、値は大きくなります

pose/pitch

float

[-90,90]

顔が左右を軸にした回転角度

頭が下げたほど、値は大きくなります

pose/roll

float

[-90,90]

顔が前後を軸にした回転角度

頭が反時計回りのほど、値は大きくなります

occlusion_total

float

[0,1]

目が遮蔽された度合い

目の遮蔽が少ないほど、値は大きくなります

distance2center

float

[0,1]

顔の中心と写真の中心との位置偏差

2つの中心の距離が近いほど、値は大きくなります

size

float

[0,1]

写真全体に対する顔枠面積の比率

顔枠の面積が大きいほど、値は大きくなります

brightness

float

[-1,1]

顔枠の平均明るさ

明るいほど、値は大きくなります

sharpness

float

[-1,1]

MAGICアルゴリズムで計算したシャープネス(鋭さ)

鋭いほど、値は大きくなります

missing

float

[0,1]

ランディングポイントが写真の中に含めない度合い

含まれていないランディングポイントが少ないほど、値は大きくなります

occlusion_total

float

[0,1]

目・口・鼻が遮蔽された度合い

目・口・鼻の遮蔽が少ないほど、値は大きくなります

mouth_open

float

[0,1]

口が閉じている度合い

口が閉まるほど、値は大きくなります

face項目の説明(qa_level='3')

パラメーター名

型

値域

説明

pose/yaw

float

[-90,90]

顔が上下を軸にした回転角度

頭が左寄りのほど、値は大きくなります

pose/pitch

float

[-90,90]

顔が左右を軸にした回転角度

頭が下げたほど、値は大きくなります

pose/roll

float

[-90,90]

顔が前後を軸にした回転角度

頭が反時計回りのほど、値は大きくなります

occlusion/eye

float

[0,1]

目が遮蔽された度合い

目の遮蔽が少ないほど、値は大きくなります

occlusion/nose

float

[0,1]

鼻が遮蔽された度合い

鼻の遮蔽が少ないほど、値は大きくなります

occlusion/mouth

float

[0,1]

口が遮蔽された度合い

口の遮蔽が少ないほど、値は大きくなります

occlusion/eyebrow

float

[0,1]

眉毛が遮蔽された度合い

眉毛の遮蔽が少ないほど、値は大きくなります

occlusion/face_line

float

[0,1]

顔の輪郭が遮蔽された度合い

顔の輪郭が遮蔽が少ないほど、値は大きくなります

distance2center

float

[0,1]

顔の中心と写真の中心との位置偏差

2つの中心の距離が近いほど、値は大きくなります

size

float

[0,1]

写真全体に対する顔枠面積の比率

顔枠の面積が大きいほど、値は大きくなります

brightness

float

[-1,1]

顔枠の平均明るさ

明るいほど、値は大きくなります

sharpness

float

[-1,1]

MAGICアルゴリズムで計算したシャープネス(鋭さ)

鋭いほど、値は大きくなります

missing

float

[0,1]

ランディングポイントが写真の中に含めない度合い

含まれていないランディングポイントが少ないほど、値は大きくなります

mouth_open

float

[0,1]

口が閉じている度合い

口が閉まるほど、値は大きくなります

qa_code の説明(qa_level='1')

リターンコード

リターンメッセージ

リターンの説明

0

PASS

通過

100

Internal error

内部エラー

101

Face count is over the max

顔の数が制限値を超えています

102

No face detected

顔を検知できませんでした

103

Read image file failed

顔写真の読み取りに失敗しました

104

Image file error format

顔写真のファイルタイプが不正です

105

Image too big

顔写真のサイズが大きすぎます

qa_code の説明(qa_level='2')

リターンコード

リターンメッセージ

リターンの説明

0

PASS

通過

100

Internal error

内部エラー

101

Face count is over the max

顔の数が制限値を超えています

102

No face detected

顔を検知できませんでした

103

Read image file failed

顔写真の読み取りに失敗しました

104

Image file error format

顔写真のファイルタイプが不正です

105

Image too big

顔写真のサイズが大きすぎます

10201

Image pixels is too small

顔写真のサイズが小さくて認識できません。300x400ピクセル以上の顔写真データを使用してください

10301

The alignment score is substandard

検知スコアが低すぎます

1030201

Face frame pixels too small

画像中の顔部分が小さくて認識できません。少なくとも150x150ピクセル以上の顔画像が必要です

1030301

The face pose pitch is substandard

ピッチ角が大きすぎます

1030302

The face pose yaw is substandard

転向角が大きすぎます

1030303

The face pose roll is substandard

ロール角が大きすぎます

10401

Face distance to center is substandard

対面距離が基準を満たしていません

10402

Face size is substandard

顔サイズ比が小さすぎます(顔の長方形の領域/ 画像領域)

10403

Face covered is substandard

顔が遮られすぎています

10404

Brightness is substandard

明るさが基準を満たしていません

10405

Sharpness is substandard

写真がぼやけています

10406

Mouth opened is substandard

口が開き過ぎています

10407

Face missing is substandard

欠けた顔の画像が多すぎます

qa_code の説明(qa_level='3')

リターンコード

リターンメッセージ

リターンの説明

0

PASS

通過

100

Internal error

内部エラー

102

No face detected

顔を検知できませんでした

103

Read image file failed

顔写真の読み取りに失敗しました

104

Image file error format

顔写真のファイルタイプが不正です

105

Image too big

顔写真のサイズが大きすぎます

106

Image is black and white

白黒の顔写真は利用できません。カラー写真を使用してください

10201

Image pixels is too small

顔写真のサイズが小さくて認識できません。300x400ピクセル以上の顔写真データを使用してください

10301

The alignment score is substandard

検知スコアが低すぎます

1030201

Face frame pixels too small

画像中の顔部分が小さくて認識できません。少なくとも150x150ピクセル以上の顔画像が必要です

1030301

The face pose pitch is substandard

ピッチ角が大きすぎます

1030302

The face pose yaw is substandard

転向角が大きすぎます

1030303

The face pose roll is substandard

ロール角が大きすぎます

10401

Face distance to center is substandard

対面距離が基準を満たしていません

10402

Face size is substandard

顔サイズ比が小さすぎます(顔の長方形の領域/ 画像領域)

10403

Face covered is substandard

顔が遮られすぎています

104031

Eyes covered is substandard

目が遮られすぎています

104032

Nose covered is substandard

鼻が遮られすぎています

104033

Mouth covered is substandard

口が遮られすぎています

104034

Eyebrow covered is substandard

眉毛が遮られすぎています

104035

Face contour covered is substandard

顔枠が遮られすぎています

10404

Brightness is substandard

明るさが基準を満たしていません

10405

Sharpness is substandard

写真がぼやけています

10406

Mouth opened is substandard

口が開き過ぎています

10407

Face missing is substandard

欠けた顔の画像が多すぎます

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

qa_levelが1,2,3のみをサポートします

50002

Internal Server Error

シリアル化エラー

2.8.3 認証用顔写真品質の検出 (/api/v2/recognition/quality)

概要

「厳格」の品質チェックレベルで、認証用顔写真の品質を検出します。 写真に複数の顔がある場合、最大の顔の情報のみ表示されます。

品質チェックレベルを指定したい場合、V3のAPIをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

face_avatar

file

Yes

認証用顔写真

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "face": {
            "pose": { 
                "yaw": -6.984859, 
                "pitch": 14.09827, 
                "roll": -2.4992712 
            },
            "occlusion": { 
                "eye": 1.0, 
                "nose": 1.0, 
                "mouth": 1.0, 
                "eyebrow": 1.0, 
                "face_line": 0.9
            },
            "distance2center": 0.8623486, 
            "size": 0.39172968,  
            "brightness": 0.29538798, 
            "sharpness": 1.0, 
            "missing": 1.0,  
            "mouth_open": 0.9553734 
        },
        "qa_code": 0,
        "qa_desc": "Pass",
        "qa_msg": "Pass"
    }
}

レスポンスのフィールド

パラメーター名

型

説明

qa_code

int

リターンコード

qa_msg

string

リターンメッセージ

qa_desc

string

リターンの説明

face

Object

顔の品質情報(qa_codeは0「通過」の場合のみ、表示されます)

face項目の説明

パラメーター名

型

値域

説明

pose/yaw

float

[-90,90]

顔が上下を軸にした回転角度

頭が左寄りのほど、値は大きくなります

pose/pitch

float

[-90,90]

顔が左右を軸にした回転角度

頭が下げたほど、値は大きくなります

pose/roll

float

[-90,90]

顔が前後を軸にした回転角度

頭が反時計回りのほど、値は大きくなります

occlusion/eye

float

[0,1]

目が遮蔽された度合い

目の遮蔽が少ないほど、値は大きくなります

occlusion/nose

float

[0,1]

鼻が遮蔽された度合い

鼻の遮蔽が少ないほど、値は大きくなります

occlusion/mouth

float

[0,1]

口が遮蔽された度合い

口の遮蔽が少ないほど、値は大きくなります

occlusion/eyebrow

float

[0,1]

眉毛が遮蔽された度合い

眉毛の遮蔽が少ないほど、値は大きくなります

occlusion/face_line

float

[0,1]

顔の輪郭が遮蔽された度合い

顔の輪郭が遮蔽が少ないほど、値は大きくなります

distance2center

float

[0,1]

顔の中心と写真の中心との位置偏差

2つの中心の距離が近いほど、値は大きくなります

size

float

[0,1]

写真全体に対する顔枠面積の比率

顔枠の面積が大きいほど、値は大きくなります

brightness

float

[-1,1]

顔枠の平均明るさ

明るいほど、値は大きくなります

sharpness

float

[-1,1]

MAGICアルゴリズムで計算したシャープネス(鋭さ)

鋭いほど、値は大きくなります

missing

float

[0,1]

ランディングポイントが写真の中に含めない度合い

含まれていないランディングポイントが少ないほど、値は大きくなります

mouth_open

float

[0,1]

口が閉じている度合い

口が閉まるほど、値は大きくなります

qa_code の説明

リターンコード

リターンメッセージ

リターンの説明

0

PASS

通過

100

Internal error

内部エラー

102

No face detected

顔を検知できませんでした

103

Read image file failed

顔写真の読み取りに失敗しました

104

Image file error format

顔写真のファイルタイプが不正です

105

Image too big

顔写真のサイズが大きすぎます

106

Image is black and white

白黒の顔写真は利用できません。カラー写真を使用してください

10201

Image pixels is too small

顔写真のサイズが小さくて認識できません。300x400ピクセル以上の顔写真データを使用してください

10301

The alignment score is substandard

検知スコアが低すぎます

1030201

Face frame pixels too small

画像中の顔部分が小さくて認識できません。少なくとも150x150ピクセル以上の顔画像が必要です

1030301

The face pose pitch is substandard

ピッチ角が大きすぎます

1030302

The face pose yaw is substandard

転向角が大きすぎます

1030303

The face pose roll is substandard

ロール角が大きすぎます

10401

Face distance to center is substandard

対面距離が基準を満たしていません

10402

Face size is substandard

顔サイズ比が小さすぎます(顔の長方形の領域/ 画像領域)

10403

Face covered is substandard

顔が遮られすぎています

104031

Eyes covered is substandard

目が遮られすぎています

104032

Nose covered is substandard

鼻が遮られすぎています

104033

Mouth covered is substandard

口が遮られすぎています

104034

Eyebrow covered is substandard

眉毛が遮られすぎています

104035

Face contour covered is substandard

顔枠が遮られすぎています

10404

Brightness is substandard

明るさが基準を満たしていません

10405

Sharpness is substandard

写真がぼやけています

10406

Mouth opened is substandard

口が開き過ぎています

10407

Face missing is substandard

欠けた顔の画像が多すぎます

エラーレスポンスのフィールド

コード

メッセージ

説明

50002

Internal Server Error

シリアル化エラー

2.8.4 認証用顔写真品質の検出 (/api/v1/recognition/quality)

概要

認証用顔写真の品質を検出します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

face_avatar

file

Yes

認証用顔写真

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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"
    }
}

レスポンスのフィールド

パラメーター名

型

説明

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

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

欠けた顔が多すぎます

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

30001

Param Invalid

写真が大きすぎます

30005

Avatar File Illegal

ファイルのサイズが大きすぎます

30005

Avatar File Illegal

処理中にエラーが発生しました

30006

Face Number Invalid

無効な顔です

50002

Internal Server Error

シリアル化エラー

2.8.5 顔検索 (/api/v1/image/search)

当APIをご利用いただくためには、「SenseLink Cloud Professional Annual Subscription」と「SenseLink Cloud ID Pack Annual Subscription」、両方のご契約が必要となります。ご了承ください。

概要

顔写真を指定し、現在のテナントに登録されている顔情報から検索し、類似した上位Kの結果を返します。認識結果は、認証スコアの高から低の順に返されます。 認証スコアが同じ場合、登録写真の登録時間の新から旧の順に返されます。

最も正確な検索結果を取得する為に、以下の事項をご確認ください。

  • JPG、PNG、BMP、TIFF、GIF(最初の1フレーム)のフォーマットを使用してください。

  • 写真のサイズは最大8MBですが、事前に画像を200KB未満にトリミングまたは圧縮することを強くお勧めします。

  • 検出可能な最小の顔フレームサイズは、32x32ピクセルです。

  • 写真の画質が高いほど、精度が高くなります。 高品質で、単一の顔、正面、鮮明で、顔のサイズが200x200ピクセル以上の写真の使用を検討してください。

  • 一枚の写真に複数の顔がある場合、最大の顔のみが検索されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/image/search

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

image_base64

string

Yes

base64で暗号化後の写真データ

top_k

int

No

最も類似した顔の数を設定します デフォルトは1で、最大10です

threshold

float

No

認証スコアのしきい値 デフォルトは0.9で、範囲は0~1です

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
  "data": [
    {
      "type": 5,
      "score": 0.9747194,
      "user_id": 24089,
      "image_id": "60869eea895750000142d2bd"
    },
    {
      "type": 1,
      "score": 0.9747194,
      "user_id": 24087,
      "image_id": "60869e491ddb2800017e8c09"
    }
  ]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

array

顔写真の情報

data フィールドの説明

パラメーター名

型

説明

user_id

int

登録者ID

image_id

string

登録者の認証用顔写真

score

float

認証スコア

type

int

登録者の識別タイプ。 1:従業員、2:ビジター、5:拒否リスト

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

認証スコアのしきい値が不正

30001

Param Invalid

top_kが設定範囲外

30001

Param Invalid

認証スコアのしきい値は空にはできません

30001

Param Invalid

top_kは空にはできません

30001

Param Invalid

顔写真が大きすぎます

30001

Param Invalid

顔写真は空にはできません

30007

Server Face Recognition Not Supported

サーバー認証プランを使用しているテナントのみ使用可能

2.8.6 顔写真の取得(/v1/image/{type}/{image_id})

概要

登録者のタイプと写真のIDを指定し、該当する写真(圧縮後)が返されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/image/{type}/{image_id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名
型
必須
説明

type

int

Yes

写真のタイプ

1: 認証用顔写真

2: 認証時にデバイスが撮影した写真、認証時にデバイスが撮影したパックグラウンド写真、認証時にデバイスが撮影したサーマル画像を含む認証時の写真

3: アラート写真

image_id

string

Yes

写真のID

タイプ1の写真IDは下記APIから取得できます

- /api/v1/user

- /api/v1/guest

- /api/v2/user/update/{id}

- /api/v1/guest/update/{id}

- /api/v1/user/list

- /api/v2/black/update

- /api/v2/black

タイプ2の写真IDは下記APIから取得できます

- /api/v5/record/list

タイプ3の写真IDは下記APIから取得できます

- /api/v2/device/alarm/list

認証パラメーター

パラメーター名
型
必須
説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

// Picture binary data stream

エラーレスポンスのフィールド

コード
メッセージ
説明

600

Sync Failed

写真取得のリモートプロシージャコールに失敗しました

30001

Param Invalid

写真IDが見つかりません

30001

Param Invalid

写真タイプが不正です

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.6 アクセスルールAPI

2.6.1 タイムテーブルの追加 (/api/v3/pass/timetable)

概要

タイムテーブルを追加します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

name

string

Yes

タイムテーブルの名前

monday_period

list<time>

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

特別な祝日

Time フィールドの説明

パラメーター名

型

必須

説明

start_time

string

Yes

00:00:00 形式

end_time

string

Yes

00:00:00 形式

Special_day フィールドの説明

パラメーター名

型

必須

説明

date

string

Yes

日付

remark

string

No

特記事項

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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,
 "update_at": null
 }

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

ID

name

string

タイムテーブルの名前

monday

string

30分ごとのおおまかな 24 時間のアクセスルール

tuesday

string

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

タイムスタンプ(ミリ秒単位)

update_at

string

更新時間(使用できません)

special_days

list<special_day>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:00:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar record Exist

タイムテーブルの名前がすでに存在しています

30001

Param Invalid

タイムテーブルの名前が空です

30001

Param Invalid

タイムテーブルの名前が長すぎます

30001

Param Invalid

時間のフォーマットが不正です

30001

Param Invalid

特別な日が不正です

30001

Param Invalid

特記事項が長すぎます

30001

Param Invalid

特別な日が重複しています

50001

RPC FAILED

内部エラー

2.6.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

概要

タイムテーブルを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/delete

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar record Exist

タイムテーブルはアクセスルールに連携されているため、削除できません

620

Record non-existent Error

タイムテーブルが存在しません

30001

Param Invalid

パラメーターエラー

30004

Missing Param

パラメーターが不足しています

50001

RPC FAILED

内部エラー

2.6.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

概要

タイムテーブルを更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/update

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

id

int

Yes

タイムテーブルの ID

name

string

Yes

タイムテーブルの名前

monday_period

list<time>

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

特別な祝日

time フィールドの説明

パラメーター名

型

必須

説明

start_time

string

Yes

00:00:00 形式

end_time

string

Yes

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

必須

説明

date

string

Yes

日付

remark

string

No

特記事項

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

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

string

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>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar record Exist

タイムテーブルの名前がすでに存在しています

30001

Param Invalid

タイムテーブルの名前が空です

30001

Param Invalid

タイムテーブルの名前が長すぎます

30001

Param Invalid

時間のフォーマットが不正です

30001

Param Invalid

特別な日が不正です

30001

Param Invalid

特記事項が長すぎます

30001

Param Invalid

特別な日が重複しています

50001

RPC FAILED

内部エラー

2.6.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

概要

タイムテーブルリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/list

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": [{
 "id": 10,
 "name": "test1"
 }]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

タイムテーブルの ID

name

string

タイムテーブル名

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

2.6.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

概要

タイムテーブルの詳細を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

integer

タイムテーブルの ID

name

string

タイムテーブルの名前

monday

string

30分ごとのおおまかな 24 時間のアクセスルール

tuesday

string

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>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

2.6.6 アクセスルールの追加 (/api/v3/pass/rule)

概要

アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

list<passRule>

Yes

アクセスルールのパラメーター

passRule フィールドの説明

パラメーター名

型

必須

説明

device_id

long

Yes

デバイスの ID

group_id

long

Yes

グループID

timetable_id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

アクセスルールの ID

device_id

long

デバイスの ID

device_name

string

デバイス名

group_id

long

グループID

group_name

string

グループ名

group_type

int

グループタイプ

timetable_id

long

タイムテーブルの ID

timetable_name

string

タイムテーブル名

エラーレスポンスのフィールド

コード

メッセージ

説明

600

Sync Failed

リモートコールに失敗しました

620

grpc.device-strategy-failed

30001

Param Invalid

パラメーターエラー

2.6.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

概要

アクセスルールを削除します。一括削除が可能です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule/delete

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

ids

list<long>

Yes

アクセスルール ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

エラーレスポンスのフィールド

コード

メッセージ

説明

620

Record non-existent Error

レコードが存在しません。

30001

Param Invalid

パラメーターエラー

30004

Missing Param

パラメーターが不足しています

50001

RPC FAILED

内部エラー

2.6.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

概要

構成されているアクセスルールのリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule/list

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

アクセスルール ID

device_id

int

デバイスの ID

device_name

string

デバイス名

group_id

int

アクセスグループ ID

group_name

string

アクセスグループ名

timetable_id

int

タイムテーブルの ID

timetable_name

string

タイムテーブル名

group_type

int

グループタイプ

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

パラメーターエラー

2.6.9 デバイスおよびグループの連携情報の取得 (アクセスルール情報を含む) (/api/v3/pass/devices/passrules)

概要

すべてのデバイスおよびグループの連携関係 (アクセスルール情報を含む) を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/devices/passrules

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

device_ids

list<long>

Yes

デバイスの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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": ""
 }]
 }]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

device_id

int

デバイスの ID

device_name

string

デバイス名

timetable_groups

list<timetableGroup>

連携されているタイムテーブルとアクセスグループ

timetableGroup フィールドの説明

パラメーター名

型

説明

group_id

int

アクセスグループ ID

group_name

string

アクセスグループ名

group_type

int

グループタイプ

timetable_id

int

タイムテーブルの ID

timetable_name

string

タイムテーブル名

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

パラメーターエラー

60001

Device Not Exist

デバイスが存在しません

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.7 レコードの API

2.7.1 認証レコードの表示 (/api/v6/record/list)

概要

認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v6/record/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

order

int

No

並び順

0 : 認証時間で降順

1 : 認証時間で昇順

page

int

No

ページ番号(デフォルトは1)

size

int

No

1ページあたりのデータの数(デフォルトは 20)。最大値は100

date_time_from

string

No

顔認証時刻で範囲指定するオプション。(from)

デフォルト値は実行時の日付の 0:00:00 例 : 2018-07-20 12:30:45

date_time_to

string

No

顔認証時刻で範囲指定するオプション。(to)

デフォルト値は実行時の日付の 23:59:59 例 : 2019-07-20 12:30:45

create_at_from

string

No

認証レコードの作成時刻で範囲指定するオプション。(from)

例 : 2018-07-20 12:30:45

create_at_to

string

No

認証レコードの作成時刻で範囲指定するオプション。(to)

例 : 2019-07-20 12:30:45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"list": [{
			"id": 1392523,
			"direction": 0,
			"latitude": null,
			"longitude": null,
			"address": null,
			"location": "6488+",
			"remark": null,
			"groups": [{
				"id": 1,
				"name": "default group",
				"type": 1,
				"devices": null,
				"is_default": null
			}],
			"mobile": null,
			"mask": 0,
			"capture_picture": "5fceef6e1ddb2800010d1409",
			"capture_bg_picture": "5fceef6e1ddb2800010d140a",
			"avatar": "",
			"heat_avatar": null,
			"user_id": 0,
			"user_name": "",
			"user_type": 3,
			"group_id": null,
			"group_name": null,
			"device_name": "6488+",
			"device_ldid": "",
			"sign_time": 1607397229,
			"country_code": null,
			"place_code": null,
			"on_business": 0,
			"entry_mode": 1,
			"sign_time_zone": "GMT+09:00",
			"verify_score": 0.359,
			"mis_id": null,
			"mis_type": null,
			"doc_photo": "",
			"ic_number": "",
			"id_number": "",
			"abnormal_type": 0,
			"job_number": null,
			"user_ic_number": null,
			"user_id_number": "",
			"reception_user_id": null,
			"reception_user_name": "",
			"sign_date": "2020-12-08",
			"user_remark": null,
			"body_temperature": 0.0,
			"id_info": {
				"cap_style": "hat_style_type_none",
				"gender_code": "male",
				"glass_style": "transparent_glasses",
				"mustache_style": "mustache_style_type_none",
				"st_age": "st_adult",
				"st_age_value": "31.000000",
				"st_expression": "st_calm",
				"st_respirator": "st_respirator_mouth"
			},
			"ext_info": [{
				"name": "attendance_flag",
				"value": 1
			}]
			"create_at": "2021-05-25 16:25:35"
		}],
		"page_num": 2,
		"page_size": 10
	}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

list

list<recordItem>

認証レコード詳細

page_num

int

ページ番号(デフォルトは1 )

page_size

int

1ページあたりのデータの数(デフォルトは20)。最大値は100

recordItem フィールドの説明

パラメーター名

型

説明

id

int

認証レコードID

direction

int

デバイスのアクセス方向

latitude

double

緯度

longitude

double

経度

address

string

住所

location

string

勤務地

mobile

string

携帯電話番号

remark

string

特記事項

groups

list<group>

グループ

capture_picture

string

認証時にデバイスが撮影した写真(サムネイル)のID

capture_bg_picture

string

認証時にデバイスが撮影した写真(大)のID

avatar

string

認証用顔写真

heat_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

認証時間

country_code

(非サポートのパラメータ)

place_code

(非サポートのパラメータ)

on_business

(非サポートのパラメータ)

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:体温が異常

50001:マスク着用無し

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:着用あり

create_at

tring

認証レコード生成時刻

id_info

NebulaAttributeVO

SenseNebulaからの属性情報、または SensePass/SenseThunderからの属性情報

ext_info

List<Map<String, Object>>

拡張情報

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

id_info フィールドの説明

パラメータ名
型
説明

cap_style

string

帽子の情報

hat_style_type_none:帽子着用なし

cap: 帽子着用あり

gender_code

string

性別

female:女性

male:男性

glass_style

string

メガネ情報

glasses_style_type_none:メガネ着用なし

transparent_glasses:透明メガネ

sunglasses: サングラス

st_ordinary_glasses:一般メガネ

mustache_style

string

ひげ

mustache_style_type_none:ヒゲなし

whiskers:ひげ

st_age

string

年齢層

st_old:シニア層

st_adult: 大人

st_child:子供

st_age_value

string

年齢

st_expression

string

表情

st_angry:怒っている

st_happy:機嫌が良い

st_sorrow:悲しい

st_calm:落ち着いている

st_surprised:驚いた

st_scared:怖がる

st_disgust:嫌がる

st_yawn:あくび

st_respirator

string

マスク着用情報

st_respirator_full:正しい着用状態

st_respirator_nose:正しくない着用状態

st_respirator_mouth:非着用id_info フィールドの説明

ext_infoフィールドの説明

ext_infoには、以下のThunderデバイス用アプリケーションが出力する情報が格納されます。

  • Thunder Attendance

パラメータ名
説明

name

Thunder Attendance では、"attendance_flag"

value

Thunder Attendanceが出力する勤怠フラグ番号(数字)。値に対応するジェスチャーやフラグは 参照

エラーレスポンスのフィールド

code

message

desc

説明

30001

Param Invalid

records pull max-size once:100

1回の最大抽出レコード数100を超えています

30001

Param Invalid

page-can-not-be-zero

pageを0にできません

30001

Param Invalid

size-not-be-zero

sizeを0にできません

30001

Param Invalid

date_time_from_out_of_retention_periods_of_records

認証時間の期間がプランの保存期限を超えています

30001

Param Invalid

DATETIME_TO_CANNOT_EARLIER_THAN_DATETIME_FROM

認証時間の終了日が認証時間の開始日より前に設定されています

30001

Param Invalid

DATETIME_FROM_PATTERN_INVALID

認証時間の開始日のフォーマットが不正です

30001

Param Invalid

DATETIME_TO_PATTERN_INVALID

認証時間の終了日のフォーマットが不正です

30001

Param Invalid

Param-invalid.

パラメーターが不正です

500

Internal Server Error

internal-server-error

内部サーバーエラー

2.7.2 認証レコードの表示 (/api/v5/record/list)

概要

認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v5/record/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

order

int

No

並び順

0 : 認証時間で降順

1 : 認証時間で昇順

page

int

No

ページ番号(デフォルトは1)

size

int

No

1ページあたりのデータの数(デフォルトは 20)。最大値は100

date_time_from

string

No

顔認証時刻で範囲指定するオプション。(from)

デフォルト値は実行時の日付の 0:00:00 例 : 2018-07-20 12:30:45

date_time_to

string

No

顔認証時刻で範囲指定するオプション。(to)

デフォルト値は実行時の日付の 23:59:59 例 : 2019-07-20 12:30:45

create_at_from

string

No

認証レコードの作成時刻で範囲指定するオプション。(from)

例 : 2018-07-20 12:30:45

create_at_to

string

No

認証レコードの作成時刻で範囲指定するオプション。(to)

例 : 2019-07-20 12:30:45

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"list": [{
			"id": 1392523,
			"direction": 0,
			"latitude": null,
			"longitude": null,
			"address": null,
			"location": "6488+",
			"remark": null,
			"groups": [{
				"id": 1,
				"name": "default group",
				"type": 1,
				"devices": null,
				"is_default": null
			}],
			"mobile": null,
			"mask": 0,
			"capture_picture": "5fceef6e1ddb2800010d1409",
			"capture_bg_picture": "5fceef6e1ddb2800010d140a",
			"avatar": "",
			"heat_avatar": null,
			"user_id": 0,
			"user_name": "",
			"user_type": 3,
			"group_id": null,
			"group_name": null,
			"device_name": "6488+",
			"device_ldid": "",
			"sign_time": 1607397229,
			"country_code": null,
			"place_code": null,
			"on_business": 0,
			"entry_mode": 1,
			"sign_time_zone": "GMT+09:00",
			"verify_score": 0.359,
			"mis_id": null,
			"mis_type": null,
			"doc_photo": "",
			"ic_number": "",
			"id_number": "",
			"abnormal_type": 0,
			"job_number": null,
			"user_ic_number": null,
			"user_id_number": "",
			"reception_user_id": null,
			"reception_user_name": "",
			"sign_date": "2020-12-08",
			"user_remark": null,
			"body_temperature": 0.0,
			"id_info": {
				"cap_style": "hat_style_type_none",
				"gender_code": "male",
				"glass_style": "transparent_glasses",
				"mustache_style": "mustache_style_type_none",
				"st_age": "st_adult",
				"st_age_value": "31.000000",
				"st_expression": "st_calm",
				"st_respirator": "st_respirator_mouth"
			},
			"create_at": "2021-05-25 16:25:35"
		}],
		"page_num": 2,
		"page_size": 10
	}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

list

list<recordItem>

認証レコード詳細

page_num

int

ページ番号(デフォルトは1 )

page_size

int

1ページあたりのデータの数(デフォルトは20)。最大値は100

recordItem フィールドの説明

パラメーター名

型

説明

id

int

認証レコードID

direction

int

デバイスのアクセス方向

latitude

double

緯度

longitude

double

経度

address

string

住所

location

string

勤務地

mobile

string

携帯電話番号

remark

string

特記事項

groups

list<group>

グループ

capture_picture

string

認証時にデバイスが撮影した写真(サムネイル)のID

capture_bg_picture

string

認証時にデバイスが撮影した写真(大)のID

avatar

string

認証用顔写真

heat_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

認証時間

country_code

(非サポートのパラメータ)

place_code

(非サポートのパラメータ)

on_business

(非サポートのパラメータ)

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:体温が異常

50001:マスク着用無し

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:着用あり

create_at

tring

認証レコード生成時刻

id_info

NebulaAttributeVO

SenseNebulaからの属性情報、または SensePass/SenseThunderからの属性情報

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

id_info フィールドの説明

パラメータ名
型
説明

cap_style

string

帽子の情報

hat_style_type_none:帽子着用なし

cap:帽子着用あり

gender_code

string

性別

female:女性

male:男性

glass_style

string

メガネ情報

glasses_style_type_none:メガネ着用なし

transparent_glasses:透明メガネ

sunglasses: サングラス

st_ordinary_glasses:一般メガネ

mustache_style

string

ひげ

mustache_style_type_none:ヒゲなし

whiskers: ひげ

st_age

string

年齢層

st_old:シニア層

st_adult:大人

st_child:子供

st_age_value

string

年齢

st_expression

string

表情

st_angry:怒っている

st_happy:機嫌が良い

st_sorrow:悲しい

st_calm:落ち着いている

st_surprised:驚いた

st_scared:怖がる

st_disgust:嫌がる

st_yawn:あくび

st_respirator

string

マスク着用情報

st_respirator_full:正しい着用状態

st_respirator_nose:正しくない着用状態

st_respirator_mouth:非着用

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

1回の最大抽出レコード数100を超えています

30001

Param Invalid

pageを0にできません

30001

Param Invalid

sizeを0にできません

30001

Permission Denied

認証時間の期間がプランの保存期限を超えています

30001

Param Invalid

認証時間の終了日が認証時間の開始日より前に設定されています

30001

Param Invalid

認証時間の開始日のフォーマットが不正です

30001

Param Invalid

認証時間の終了日のフォーマットが不正です

30001

Param Invalid

パラメーターが不正です

2.7.3 認証レコードの表示 (/api/v4/record/list)

概要

認証レコードを表示します。

v3のインターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/record/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

date_time_from

string

No

認証時間の開始日。デフォルト値は現在の日付の0時。 例 : 2018-07-20 12:30:45

date_time_to

string

No

認証時間の終了日。デフォルト値は現在の日付の 23:59:59。 例 : 2019-07-20 12:30:45

order

int

No

並び順

0 : 認証時間で降順

1 : 認証時間で昇順

page

int

No

ページ番号(デフォルトは1)

size

int

No

1ページあたりのデータの数(デフォルトは 20)。最大値は100

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "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",
            "heat_avatar":null,
            "user_id": 100100,
            "user_name": "xlp update",
            "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,
            "mask":1
            }
        ],
        "total" : 19
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

list

list<recordItem>

認証レコード詳細

total

int

認証レコード合計数

recordItem フィールドの説明

パラメーター名

型

説明

id

int

認証レコードID

direction

int

デバイスのアクセス方向

latitude

double

緯度

longitude

double

経度

address

string

住所

location

string

勤務地

mobile

string

携帯電話番号

remark

string

特記事項

groups

list<group>

グループ

capture_picture

string

認証時にデバイスが撮影した写真(サムネイル)のID

capture_bg_picture

string

認証時にデバイスが撮影した写真(大)のID

avatar

string

認証用顔写真

heat_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

認証時間

country_code

(非サポートのパラメータ)

place_code

(非サポートのパラメータ)

on_business

(非サポートのパラメータ)

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:体温が異常

50001:マスク着用無し

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:着用あり

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

1回の最大抽出レコード数100を超えています

30001

Param Invalid

pageを0にできません

30001

Param Invalid

sizeを0にできません

30001

Permission Denied

認証時間の期間がプランの保存期限を超えています

30001

Param Invalid

認証時間の終了日が認証時間の開始日より前に設定されています

30001

Param Invalid

認証時間の開始日のフォーマットが不正です

30001

Param Invalid

認証時間の終了日のフォーマットが不正です

30001

Param Invalid

ページが大きすぎます

2.7.4 認証レコードの表示 (/api/v3/record/list)

概要

認証レコードを表示します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/record/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

start_record_id

long

No

認証レコード の開始ID

end_record_id

long

No

認証レコード の終了ID

device_sn

string

No

デバイスシリアル番号

type

int

No

タイプ

1:従業員

2:ビジター

3:未登録人物

5 : 拒否リスト

user_id

long

No

登録者ID

date_time_from

string

No

認証時間の開始日。デフォルト値は現在の日付の 0 時。 例 : 2018-07-20 12:30:45

date_time_to

string

No

認証時間の終了日。デフォルト値は現在の日付の 23:59:59。 例 : 2019-07-20 12:30:45

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:マスク着用無し

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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",
                    "heat_avatar":null,
                    "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,
                    "mask":1
                    }
                }
            ]
        },
        "page_num": 1,
        "page_size": 3,
        "total_page": 40
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

total

int

総計

size

int

容量

data

object

認証レコードの情報

page_num

int

現在のページ番号

page_size

int

ページサイズ

total_page

int

ページ合計

data.dataフィールドの説明

パラメーター名

型

説明

total

int

総計

user_count

int

従業員レコードの数

guest_count

int

ビジターレコードの数

stranger_count

int

未登録者レコードの数

record_list

list<recordItem>

認証レコード

recordItem フィールドの説明

パラメーター名

型

説明

id

int

認証レコードID

direction

int

デバイスのアクセス方向

latitude

double

緯度

longitude

double

経度

address

string

住所

location

string

勤務地

mobile

string

携帯電話番号

remark

string

特記事項

groups

list<group>

グループ

capture_picture

string

認証時にデバイスが撮影した写真(サムネイル)のID

capture_bg_picture

string

認証時にデバイスが撮影した写真(大)のID

avatar

string

認証用顔写真

heat_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

認証時間

country_code

(非サポートのパラメータ)

place_code

(非サポートのパラメータ)

on_business

(非サポートのパラメータ)

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:体温が異常

50001:マスク着用無し

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:着用あり

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

1回の最大抽出レコード数100を超えています

30001

Param Invalid

ページが大きすぎます

30001

Permission Denied

認証時間の期間がプランの保存期限を超えています

30001

Param Invalid

認証時間の終了日が認証時間の開始日より前に設定されています

30001

Param Invalid

認証時間の開始日のフォーマットが不正です

30001

Param Invalid

認証時間の終了日のフォーマットが不正です

1.3.1 シグネチャ(sign)
Thunder Attendanceのマニュアル
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.2 デバイスの API

2.2.1 デバイスの更新 (/api/v3/device/update)

概要

デバイス情報を更新します(ゲートウェイデバイスはグループに連携できません) 。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/update

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスのID

name

string

No

名前

location

string

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 のグループ)

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

デバイスの ID

name

string

デバイス名

location

string

デバイスの設置場所

state

string

デバイスのステータス

description

string

説明

direction

int

デバイスのアクセス方向

0:デフォルト(Null)

1:In

2 :Out

ip

string

IP アドレス

ldid

string

デバイスの シリアル番号

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

デバイスの最新のオフラインタイムスタンプ

group フィールドの説明

パラメーター名

型

説明

id

long

グループ ID

name

string

グループ名

type

int

グループタイプ

is_default

int

デフォルトのグループかどうかを示します

person_count

int

グループ内の人数を示します

エラーレスポンスのフィールド

コード

メッセージ

説明

30001

Param Invalid

デバイス名が長すぎます

30001

Param Invalid

デバイスの設置場所が長すぎます

30001

Param Invalid

デバイスの説明が長すぎます

30001

Param Invalid

アクセス方向が不正です

30001

Param Invalid

従業員グループが存在しません

30001

Param Invalid

ビジターグループが存在しません

30001

Param Invalid

拒否リストグループが存在しません

30001

Param Invalid

デバイスが存在しません

2.2.2 デバイスの削除 (/api/v3/device/delete)

概要

デバイス(ゲートウェイまたはカメラデバイス)を削除します。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/delete

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

エラーレスポンスのフィールド

code

メッセージ

説明

600

Sync Failed

RPCが失敗しました

30001

Param Invalid

パラメーターエラー

30001

Param Invalid

デバイスが存在しません

30004

Missing Param

パラメーターが存在しません

2.2.3 サブカメラのリストの取得 (/api/v3/gateway/cameraList)

開発中のため、当APIは現在利用できません

概要

カメラのリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/gateway/cameraList

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

gateway_id

long

Yes

ゲートウェイデバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

カメラデバイスのID

sn

string

Nebula デバイスのシリアル番号

channel

string

チャンネル番号

position

string

設置場所

url

string

Nebulaデバイスの IPアドレス

camera_sn

string

カメラの sn 番号

camera_name

string

カメラ名

state

int

1:オンライン

2 :オフライン

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

2.2.4 デバイスリストの表示 (/api/v2/device)

/api/v1/deviceではレスポンスフィールドの「sn」ではLDIDが取得されていましたが、/api/v2/deviceでは「sn」でデバイスのシリアル番号が取得できます。

概要

デバイスリストを表示します。デフォルトの順序はIDの降順です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

page

int

No

ページ番号(デフォルトは 1 )

size

int

No

1 ページあたりのデータ数(デフォルトは 20 )

ids

list<long>

No

デバイスID の配列

typeId

int

No

デバイスタイプID

4:SensePass

19:SenseThunder-Mini

20:SenseThunder-E

22:SenseThunder-Air

location

string

No

デバイスの設置場所

name

string

No

デバイス名

description

string

No

デバイスの説明

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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"
                         "node_type":0
                  },
                  "device": {
                         "id": 31,
                         "name": "306 3rd generation device",
                         "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,
                         "sn": "TE42GE61FC20K00003", // Device serial number
                         "ldid": "SID-5f51f769de2cdc8681e85ad590456516", // Device LDID
                         "company_id": 1,
                         "group_count": 1,
                         "create_at": "2019-03-20 09:50:08.0",
                         "update_at": "2019-08-28 08:56:05.0",
                         "last_offline_time":null
                  }
           }]
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

total

int

総計

size

int

サイズ

data

object

データ

pageNum

int

現在のページ番号

pageSize

int

ページサイズ

totalPage

int

ページ合計

dataフィールドの説明

パラメーター名

型

説明

device_type

object

デバイスタイプ

device

object

デバイス情報

device_type フィールドの説明

パラメーター名

型

説明

id

long

デバイスタイプID

4:SensePass

19:SenseThunder-Mini

20:SenseThunder-E

name

string

デバイスタイプ名

identifier

string

デバイスタイプの識別子(略称)

description

string

デバイスタイプの説明

create_at

string

作成時間

update_at

string

更新時間

node_type

int

ノードのタイプ

0:共通のデバイス

1:ゲートウェイデバイス

device フィールドの説明

パラメーター名

型

説明

id

long

デバイスのID

sn

string

デバイスのシリアル番号

ldid

string

デバイスのLDID

name

string

デバイス名

direction

string

デバイスの向き

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

最後のオフラインタイムスタンプ

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

無効なデバイスID

30001

Param Invalid

無効なデバイスタイプID

30001

Param Invalid

無効なページ番号

30001

Param Invalid

無効なページサイズ

2.2.5 デバイスリストの表示 (/api/v1/device)

概要

デバイスリストを表示します。デフォルトの順序は ID の降順です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/device

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

page

int

No

ページ番号(デフォルトは 1 )

size

int

No

1 ページあたりのデータ数(デフォルトは 20 )

ids

list<long>

No

デバイスID の配列

typeId

int

No

デバイスタイプID

4:SensePass

19:SenseThunder-Mini

20:SenseThunder-E

22:SenseThunder-Air

location

string

No

デバイスの設置場所

name

string

No

デバイス名

description

string

No

デバイスの説明

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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",
                         "node_type":0
                  },
                  "device": {
                         "id": 31,
                         "sn": "SID-5f51f769de2cdc8681e85ad590456516",
                         "name": "306 3rd generation device",
                         "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",
                         "last_offline_time":null
                  }
           }]
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

total

int

総計

size

int

サイズ

data

object

データ

pageNum

int

現在のページ番号

pageSize

int

ページサイズ

totalPage

int

ページ合計

dataフィールドの説明

パラメーター名

型

説明

device_type

object

デバイスタイプ

device

object

デバイス情報

device_type フィールドの説明

パラメーター名

型

説明

id

long

デバイスタイプID

4:SensePass

19:SenseThunder-Mini

20:SenseThunder-E

name

string

デバイスタイプ名

identifier

string

デバイスタイプの識別子(略称)

description

string

デバイスタイプの説明

create_at

string

作成時間

update_at

string

更新時間

node_type

int

ノードのタイプ

0:共通のデバイス

1:ゲートウェイデバイス

device フィールドの説明

パラメーター名

型

説明

id

long

デバイスのID

sn

string

デバイスのLDID

name

string

デバイス名

direction

string

デバイスの向き

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

最後のオフラインタイムスタンプ

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

無効なデバイスID

30001

Param Invalid

無効なデバイスタイプID

30001

Param Invalid

無効なページ番号

30001

Param Invalid

無効なページサイズ

2.2.6 リモート構成(一括複数アップデート)(/api/v2/device/update/config/batch)

概要

同じタイプのオンラインデバイスに対して、リモート構成コマンドを送信します。最大100台までの一括送信に対応しています。

現在、下記のデバイスをサポートしています。

  • SensePass

  • SenseThunder-E

  • SenseThunder-Mini

  • SenseThunder-Air

この機能をサポートするデバイスの最低バージョンは以下のとおりです。

  • SensePass(v1.2.3)

  • SenseThunder-E(v1.0.3)

  • SenseThunder-Mini(v1.0.1)

  • SenseThunder-Air(v2.2.1)

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device/update/config/batch

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

device_ids

list<long>

Yes

ID リスト。デバイスID のタイプは同じである必要があります

key

json

Yes

デバイス識別子、詳細については次のデバイス型番識別子をご参照ください

デバイス型番識別子

デバイス名称

デバイス型番識別子

SensePass

SPS

SenseThunder-E

SPSPE

SenseThunder-E Mini

SPSE

構成項目とパラメーターの説明

構成項目

型

値の範囲 / オプション

Pass

Thunder

Thunder Mini

実行ステータス

device_run_type

int

  • 1:実行

  • 2:停止

✓

✓

✓

利用モード

use_mode

int

デバイスによって異なります

✓ (1 :ゲートモード、2:ドアモード)

✓ (1:一人モード、2 :複数人モード)

✓ (1:ゲートモード、2:ドアモード)

認証モード

mode

int

  • 2:顔認証とカード

  • 3:顔認証またはID カード

  • 4:顔認証とID カード

  • 9:顔認証

  • 10:顔認証またはQR コードまたはカード

  • 11:ID カード

serverFRの場合、[9:顔認証]のみ利用可能

✓

✓

✓

音声ブロードキャスト

voice_broadcast

bool

  • true:オン

  • false:オフ

×

✓

×

プロンプト strong_hint

bool

  • true:オン

  • false:オフ

×

✓

×

温度検知

temperature_detect

bool

  • true:オン

  • false:オフ

×

✓

✓

温度アラームしきい値

fever_temperature

float

接続されるデバイスによって異なります

×

✓

✓

温度異常時にアクセス拒否

no_access_to_fevers

bool

  • true:オン

  • false:オフ

×

✓

✓

サーモグラフィ表示

show_thermal_screen

bool

  • true:オン

  • false:オフ

×

✓

✓

屋内温度

indoor_temperature

float

[5.0、40.0]、小数点以下 1桁です

×

✓

✓

温度単位

temperature_unit

int

  • 1:摂氏

  • 2:華氏

×

✓

✓

温度検知距離

temperature_detect_distance

float

デバイスによって異なります

×

[1.0、1.5]. 小数点第1位まで、1.0を推奨

[0.5、1.2]. 小数点第1位まで、1.2を推奨

温度異常ブザー

temperature_warn_volume

int

デバイスによって異なります

×

[0、100]

  • 0:オフ

  • 100:オン

高速検知モード

quick_detect_mode

bool

  • true:オン

  • false:オフ

×

✓

✓

温度正常時ドアオープン

quick_detect_mode_open_door

bool

  • true:オン

  • false:オフ

×

✓

✓

マスク検知

mask_detect

bool

  • true:オン

  • false:オフ

×

✓

✓

マスク未着用アクセス不可

no_access_without_mask

bool

  • true:オン

  • false:オフ

×

✓

✓

マスク未着用ブザー

mask_warn_volume

int

デバイスによって異なります

×

[0、100]

  • 0:オフ

  • 100:オン

ログ

save_and_upload_record

bool

  • true:オン

  • false:オフ

×

×

✓

タッチして認証

touch_recognition

bool

  • true:オン

  • false:オフ

×

✓

✓

省ネットワーク通信

save_elec_mode

bool

  • true:オン

  • false:オフ

×

✓

✓

未登録者ログ

need_stranger_record

bool

  • true:オン

  • false:オフ

×

✓

✓

顔写真

show_custom_avatar

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.98 です

✓

✓

✓

顔認証閾値

verify_threshold

float

[0、1]、小数点以下 2 桁です。推奨値は 0.9 です

✓

✓

✓

IDカード比較閾値certificate_threshold

float

当機能はご利用いただけません。

✓

✓

✓

顔認識距離(メートル)

verification_distance

float

[0.5、2.0]、小数点以下 1 桁です

✓

✓

✓

ドアオープンモード

open_door_type

int

  • 0:ローカルリレー

  • 1: Wiegand 26 (8+16bit id)

  • 2:Wiegand 32

  • 3:Wiegand 34

  • 4:ネットワークリレー + リレー ip

  • 5:Wiegand 26(24bit id)

  • 6:Network(TCP)

  • 9:サーバーからドアを開く

✓

✓

✓

ネットワークリレー IP アドレス

network_relay_address

string

  • ドアオープンモードでネットワークリレーを指定した際に必要です。

  • {IP}:{PORT} 形式(例 : 192.168.2.1:12345)

✓

✓

✓

ドアオープンタイム (秒)

keep_door_open_duration

int

[1、255]、整数

✓

✓

✓

ドアセンサータイムアウト

door_sensor_timeout

int

[1、255]、整数

✓

✓

✓

認証インターバル (秒)

open_interval

int

[1、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

  • 5:Wiegand 34

✓

✓

✓

アラート音スイッチ

buzzer_status

bool

  • true:オン

  • false:オフ

✓

✓

✓

フリッカー低減

short_exposure

int

  • 0:オフ

  • 50:50Hz

  • 60:60Hz

×

✓

✓

インストール環境

setup_env

int

  • 1:屋内

  • 2:半屋内

×

✓

×

システム言語

language_type

int

  • 1:簡体中国語

  • 2:英語

  • 3:繁体中国語

✓

✓

✓

自動スタンバイ

standby_open

bool

  • true:オン

  • false:オフ

✓

✓

✓

スタンバイ時間 (分)

wait_time

int

[3、30]、整数

✓

✓

✓

スリープ解除距離

wake_distance

int

[50、200]、整数

×

✓

✓

自動再起動

auto_reboot

bool

true:オン

false:オフ

✓

✓

✓

再起動時間

reboot_time

string

hh:mm:ss (時間、分、秒)

✓

✓

✓

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

リクエスト例

{
    "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

メッセージ

エラーの説明

498

Param Invalid

無効なパラメーターです

30001

Param Invalid

無効なパラメーターです

50001

RPC FAILED

RPCに失敗しました

2.2.7 リモートドアオープン (/api/v2/device/open)

概要

オンラインデバイスにドアオープンコマンドを送信します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device/open

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスの ID

remark

string

No

ドアオープンの特記事項。長さ制限は 255です

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

603

Device Offline

デバイスがオンラインではありません

30001

Param Invalid

無効なパラメーターです。デバイスが存在しません

30001

Param Invalid

無効なパラメーターです。特記事項が長すぎます

30001

Param Invalid

無効なパラメーターです。デバイスID は空にはできません

50001

RPC FAILED

RPCに失敗しました

2.2.8 通知の送信 (/api/v3/device/notify)

開発中のため当APIは現在利用できません

概要

オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/notify

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

payload

object[]

Yes

通知メッセージの対象。複数の送信が可能です

payload.ldid

string

Yes

メッセージを受信するデバイスの LDIDです

payload.type

string

Yes

通知タイプ。0000 はカスタマイズ通知を示します。メッセージは payload.content を通してカスタマイズします

payload.content

object

No

メッセージの内容は透過的にデバイスに送信されます。

trace_id

string

Yes

リクエストされるイベントのシリアル番号です。記号列は UUID と類似しています

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

620

pass timetable id not exist

タイムテーブルIDが存在しません

30001

Param Invalid

空にできません

30001

Param Invalid

デバイスのLDIDは無効です

30001

Param Invalid

内容は無効です

30001

Param Invalid

タイムテーブルID

30001

Param Invalid

デバイスがオンラインではありません

リクエスト例

パラメーター

説明

例

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 である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます }

]

}

2.2.9 デバイスLDIDの取得(/api/v3/device/ldid)

概要

デバイスのシリアル番号でデバイスのLDIDを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/ldid

リクエスト方法

GET

リクエストパラメーター

パラメータ名

型

必須

説明

duid

string

Yes

デバイスのID

identifier

string

Yes

デバイス識別子、詳細について、次のデバイス型番識別子をご参照ください

デバイス型番識別子

デバイス名称

デバイス型番識別子

SensePass

SPS

SensePass Pro

SPSP

SenseThunder-E

SPSPE

SenseThunder-Mini

SPSE

SenseThunder-Air

SPSPEA

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    " data": " SPS-c725f19ddf7d5d9fabee189c29f10b11"
}

レスポンスのフィールド

パラメータ

型

説明

code

int

コード

message

string

メッセージ

data

string

デバイスLDID

2.2.10 デバイスの設定情報の取得 (/api/v1/device/setting/{device_id})

概要

デバイスの設定情報を取得します。

本機能は、SenseThunder-Mini V2.3.6 限定でサポートされます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/device/setting/{device_id}

リクエスト方法

GET

リクエストパラメーター

パラメータ名

型

必須

説明

{device_id}

long

Yes

デバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
      "settings": {
        "device_run_type": 1,
        "use_mode": 1,
        "mode": 1,
        "welcome_tip": "welcomeTip",
        "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,
        "p12_in_base64": "", 
        "p12_id": "", 
        "expiry_date": ""
      }
    }
}

レスポンスのフィールド

パラメータ

型

説明

code

int

コード

message

string

メッセージ

desc

string

説明

data

string

デバイスの設定情報

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

Device do not exist

30001

Param Invalid

Do not support the device

50002

Internal Server Error

Internal Error

50051

RPC FAILED

600

Sync Failed

grpc failed

2.2.11 デバイスの設定変更 (/api/v1/device/setting/{device_id})

概要

デバイスの設定を変更します。

本機能は、SenseThunder-Mini V2.3.6 限定でサポートされます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/device/setting/{device_id}

リクエスト方法

POST: form-data

リクエストパラメーター

パラメータ名

型

必須

説明

settings

object

Yes

変更するデバイスの設定値

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

リクエスト例

{
 "settings":{
        "device_run_type": 1,
        "use_mode": 1,
        "mode": 1,
        "welcome_tip": "welcomeTip",
        "verify_success_tip": "verifySuccessTip",
        "verify_fault_tip": "verifyFaultTip",
 }
}

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスのフィールド

パラメータ

型

説明

code

int

コード

message

string

メッセージ

desc

string

説明

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

Device do not exist

30001

Param Invalid

Do not support the device

498

Param Invalid

Param %parameter% is invalid

498

Param Invalid

Param %parameter% is readonly

498

Param Invalid

TSL template is invalid

600

Sync Failed

sync failed

50051

RPC FAILED

Remote call failure

50010

CONTENT EMPTY EXCEPTION

TSL is not exist

50001

RPC FAILED

ex.grpc-status-error:UNKNOWN

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)

2.4 登録者のAPI

APIでの登録者操作では、ご利用のプランとAPIによって顔写真品質チェックの登録レベルが異なります。「サーバー側認証」かつ以下のAPIの場合、「レベル高」が実行されます。

  • /api/v2/black

  • /api/v2/black/update

「サーバー側認証」で上記以外のAPIを使用する場合と「端末側認証」で利用する場合は、全て「レベル低」が実行されます。認証精度向上のため、事前に認証用顔写真品質の検出APIで確認することをを推奨します。

2.4.1 従業員の追加 (/api/v1/user)

概要

従業員を追加します。

ご利用のプランによって、登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/user

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

avatarFile

file

No

認証用顔写真。4MB以下の写真データを利用してください

force

int

No

強制追加するかどうか

デフォルトで0

0:強制ではない

1:強制

groups

list<long>

Yes

従業員グループIDのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

icNumber

string

No

IC カード番号。空の string も指定可能。長さ制限は 20です

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)

mail

string

No

メールアドレス。長さ制限は 45です

position

string

No

役職。長さ制限は 45です

location

string

No

勤務地。長さ制限は 45です

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

prompt

string

No

顔認証時に表示するカスタムメッセージ

gender

int

No

性別。1 : 女性、2 : 男性

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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": 610,
    "message": "Similar User Exist",
    "data": {
        "similar_user_id": 65833,
        "similar_user_name": "11111111",
        "similar_user_avatar": "5cbe7dec35060d0001750f15",
        "can_force": 0
    },
    "desc": "ex.similar-user"
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

従業員ID

name

string

従業員名

avatar

string

認証用顔写真

mobile

string

携帯電話番号

remark

string

特記事項

type

int

タイプ。 1:従業員

2:ビジター

birthday

string

誕生日

mail

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

入社日

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

709

The maximum number of persons in the tenant has been reached.

ご利用のプランの登録人数上限に達しました。

30001

Param Invalid

無効なパラメーターです。登録者名の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者名が空です。

30001

Param Invalid

無効なパラメーターです。登録者IC 番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者の携帯電話番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。特記事項の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者の認証用顔写真の形式が無効です

30001

Param Invalid

無効なパラメーターです。登録者グループのID が存在しません

30001

Param Invalid

無効なパラメーターです。登録者のICカード番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。登録者のIDカード番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。登録者の携帯電話番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。従業員の認証用顔写真のファイルが大きすぎます

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。顔が検知されていません

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。複数の顔が検知されました

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。顔の検知に失敗しました

2.4.2 従業員の追加 (/api/v2/user)

概要

従業員を追加します。「similar」と「similarPin」、2つのパラメータが新規追加されました。 従業員を管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。この2パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、4桁4Pinコードを指定する必要があります。

ご利用のプランによって、登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/user

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

avatarFile

file

No

認証用顔写真。4MB以下の写真データを利用してください

force

int

No

強制追加するかどうか

デフォルトで0

0:強制ではない

1:強制

groups

list<long>

Yes

従業員グループIDのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

icNumber

string

No

IC カード番号。空の string も指定可能。長さ制限は 20です

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)

mail

string

No

メールアドレス。長さ制限は 45です

position

string

No

役職。長さ制限は 45です

location

string

No

勤務地。長さ制限は 45です

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

prompt

string

No

顔認証時に表示するカスタムメッセージ

similar

boolean

No

よく似た人。デフォルトは falseです

similarPin

string

No

よく似た人が存在する場合の当該登録者のパスコード。4桁の数字です。similarがtrueの場合、このパラメータは必須となります return cannnot show the similar pin

gender

int

No

性別。1 : 女性、2 : 男性

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"id": 65838,
		"name": "1312313123123122",
		"avatar": "5cbe78b135060d0001750ef5",
		"mobile": "",
		"remark": "",
		"type": 1,
		"birthday": "",
		"mail": null,
		"position": null,
		"location": null,
		"groups": [{
			"id": 1,
			"name": "default group",
			"type": 1,
			"devices": [{
				"id": 1,
				"name": "SenseThunderAir",
				"type": 19
			}],
			"is_default": 0,
			"person_count": 1
		}],
		"gender": 1,
		"prompt": "",
		"ic_number": "",
		"id_number": "te9+d6aXoDe5zTCUywgn9+zmx4HElB4W",
		"job_number": "",
		"companyId": 1,
		"create_at": "2019-04-23 10:30:08",
		"update_at": "2019-04-23 10:30:08",
		"department": 0,
		"area_code": null,
		"entry_time": "2018-9-10"
		"similar": true,
	}
}

類似登録者が存在する場合のレスポンス

{
    "code": 610,
    "message": "Similar User Exist",
    "data": {
        "similar_user_id": 65833,
        "similar_user_name": "11111111",
        "similar_user_avatar": "5cbe7dec35060d0001750f15",
        "can_force": 0
    },
    "desc": "ex.similar-user"
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

従業員ID

name

string

従業員名

avatar

string

認証用顔写真

mobile

string

携帯電話番号

remark

string

特記事項

type

int

タイプ。1:従業員、2:ビジター

birthday

string

誕生日

mail

string

メールアドレス

position

string

役職

location

string

勤務地

groups

list<group>

従業員グループ情報

gender

string

性別

ic_number

string

IC カード番号

id_number

string

IDカード番号(利用できません)

job_number

string

従業員番号

create_at

string

登録時間

update_at

string

更新時間

department

long

部署ID

area_code

string

携帯電話番号の国別コードおよび市外局番

entry_time

string

入社日

similar

boolean

よく似た人

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

devices

list<device>

デバイスのリスト

is_default

integer

デフォルトグループかどうか

person_count

integer

グループの人数

device フィールドの説明

パラメーター名

型

説明

id

long

デバイスID

name

string

デバイス名

type

int

デバイスタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

709

The maximum number of persons in the tenant has been reached.

ご利用のプランの登録人数上限に達しました。

30001

Param Invalid

無効なパラメーターです。登録者名の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者名が空です。

30001

Param Invalid

無効なパラメーターです。登録者IC 番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者の携帯電話番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。特記事項の長さが無効です

30001

Param Invalid

無効なパラメーターです。登録者の認証用顔写真の形式が無効です

30001

Param Invalid

無効なパラメーターです。登録者グループのID が存在しません

30001

Param Invalid

無効なパラメーターです。登録者のICカード番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。登録者のIDカード番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。登録者の携帯電話番号がすでに存在します

30001

Param Invalid

無効なパラメーターです。従業員の認証用顔写真のファイルが大きすぎます

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。顔が検知されていません

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。複数の顔が検知されました

50001

RPC FAILED

リモート rpc の呼び出しに失敗しました。顔の検知

2.4.3 従業員情報の変更 (/api/v2/user/update/{id})

概要

従業員情報を変更します。

バージョン v1 から、従業員ID、IC カード番号、および空の ID 番号の処理ロジックが改善されました。パラメーターが渡されなかった場合やパラメーターが null の場合、変更は行われません。空の string (””) が渡された場合、空として設定されます。バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/user/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

int

Yes

変更する従業員ID の情報。タイプは path で、URL に記述されます

avatarFile

file

No

従業員の認証用顔写真

force

int

No

強制追加するかどうか。デフォルトで0 0:強制ではない

1:強制

groups

list<group>

No

従業員グループIDのリスト。 空のリストが渡される場合、従業員はどのグループにも属さないことを示します。情報が渡されない場合、変更は行われません。 従業員はリスト内の有効なグループ(グループID が存在し、企業に属しており、かつグループタイプが従業員)にのみ追加されます。

icNumber

string

No

IC カード番号。長さ制限は 20です

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)です

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

入社日

mail

string

No

メールアドレス。長さ制限は 45です

position

string

No

役職。長さ制限は 45です

location

string

No

勤務地。長さ制限は 45です

prompt

string

No

カスタマイズされたウェルカムプロンプト

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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,
 }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

従業員ID

name

string

従業員名

avatar

string

従業員の認証用顔写真

mobile

string

携帯電話番号

remark

string

特記事項

type

int

タイプ。1:従業員、2:ビジター

birthday

string

誕生日

mail

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

入社日

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

30001

Param Invalid

無効なパラメーターです

50001

RPC FAILED

RPCに失敗しました(顔の検知に失敗したなど)

50002

Internal Server Error

内部エラーです。従業員をグループに連携できませんでした

2.4.4 従業員情報の変更 (/api/v3/user/update/{id})

概要

従業員情報を変更します。

バージョン v2 をもとに、「similar」と「similarPin」、2つのパラメータが新規追加されました。従業員を管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。この2パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、4桁のPinコードを指定する必要があります。

バージョン v2 のインターフェースは、引き続きご利用いただくことができます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/user/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

int

Yes

変更する従業員ID の情報。タイプは path で、URL に記述されます

avatarFile

file

No

従業員の認証用顔写真

force

int

No

強制追加するかどうか。デフォルトで0 0:強制ではない 1:強制

groups

list<group>

Yes

従業員グループIDのリスト。デフォルト値はタイプで定義します。空の場合は、どのグループにも追加しないことを示します

icNumber

string

No

IC カード番号。空の string も指定可能。長さ制限は 20です

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

jobNumber

string

No

従業員番号。空の string も指定可能。長さ制限は 45です

mobile

string

No

携帯電話番号。空の string も指定可能。長さ制限は 20です

name

string

Yes

従業員名。空の string は指定不可です

remark

string

No

特記事項。空の string も指定可能。長さ制限は 255

gender

int

No

性別。1 : 女性、2 : 男性

departmentId

int

No

部署ID

areaCode

string

No

電話番号の国別コードおよび市外局番

birthday

string

No

誕生日(日付形式:2019-06-15)

entryTime

string

No

入社日(日付形式:2019-06-15)

mail

string

No

メールアドレス。長さ制限は 45です

position

string

No

役職。長さ制限は 45です

location

string

No

勤務地。長さ制限は 45です

prompt

string

No

顔認証時に表示するカスタムメッセージ

similar

boolean

No

よく似た人。デフォルトはfalseです

similarPin

string

No

よく似た人が存在する場合の当該登録者のパスコード。4桁の数字です。similarがtrueの場合、このパラメータは必須となります

groupフィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 65838,
        "name": "1312313123123122",
        "avatar": "5cbe78b135060d0001750ef5",
        "mobile": "",
        "remark": "",
        "type": 1,
        "birthday": "",
        "mail": null,
        "position": null,
        "location": null,
        "groups": [
            {
                "id": 1,
                "name": "default group",
                "type": 1,
            }
        ],
        "gender": 1,
        "prompt": "",
        "ic_number": "",
        "id_number": "te9+d6aXoDe5zTCUywgn9+zmx4HElB4W",
        "job_number": "",
        "companyId": 1,
        "create_at": "2019-04-23 10:30:08",
        "update_at": "2019-04-23 10:30:08",
        "department": 0,
        "area_code": null,
        "entry_time": "2018-9-10"
        "similar": true,
    }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

従業員ID

name

string

従業員名

avatar

string

従業員の認証用顔写真

mobile

string

携帯電話番号

remark

string

特記事項

type

int

タイプ。1:従業員、2:ビジター

birthday

string

誕生日

mail

string

メールアドレス

position

string

役職

location

string

勤務地

groups

list<group>

従業員グループ情

gender

string

性別

prompt

string

顔認証時に表示するカスタムメッセージ

ic_number

string

IC カード番号

id_number

string

IDカード番号(利用できません)

job_number

string

従業員ID

companyId

long

企業ID

create_at

string

作成時間

update_at

string

更新時間

department

long

部署ID

area_code

string

携帯電話番号の国別コードおよび市外局番

entry_time

string

入社日

similar

Boolean

よく似た人がいるかどうか

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

is_default

integer

デフォルトグループかどうか

person_count

integer

グループの人数

device フィールドの説明

パラメーター名

型

説明

id

long

デバイスID

name

string

デバイス名

type

int

デバイスタイプ

エラーレスポンスのフィールド

Code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

30001

Param Invalid

無効なパラメーターです:名前が長すぎます

30001

Param Invalid

無効なパラメーターです:名前が空です

30001

ex.method-argument-type-mismatch:id

型が一致しません

30001

ex.method-argument-type-mismatch:groups

型が一致しません

30001

Param Invalid

部署が一致しません

30001

Param Invalid

無効なパラメーターです:特記事項が長すぎます

30001

Param Invalid

無効なパラメーターです:認証用写真タイプが無効です

30001

Param Invalid

無効なパラメーターです

30001

Param Invalid

登録者が存在しません

610

Similar record Exist

従業員ID番号がすでに存在します

610

Similar record Exist

従業員ICカード番号がすでに存在します

610

Similar record Exist

従業員携帯電話番号がすでに存在します

30001

Param Invalid

従業員グループが存在しません

30001

Param Invalid

ICナンバーが長すぎます

30001

Param Invalid

従業員番号が長すぎます

30001

Param Invalid

Emailの値が長すぎます

30001

Param Invalid

勤務地の値が長すぎます

30001

Param Invalid

役職の値が長すぎます

30001

Param Invalid

ID番号が長すぎます

30001

Param Invalid

認証用写真のタイプが違います

30001

Param Invalid

写真が大きすぎます

30001

Param Invalid

従業員がこの企業に存在しません

30001

Param Invalid

無効な携帯電話番号の国別コードおよび市外局番です

610

Similar record Exist

従業員番号がすでに存在します

50502

A batch upload task is still processing. Please try again after the task is finished

バッチ処理タスクが存在します。タスクが完了後に再度試してください

50501

The maximum number of persons in the group: %groupName% has been reached

当該グループの最大人数を超えます

600

Sync Failed

顔を検出できませんでした

600

Sync Failed

複数の顔を検出しました

500

Internal Server Error

内部エラーです。従業員を登録できませんでした

50002

Internal Server Error

内部エラーです。従業員を削除できませんでした

2.4.5 従業員の削除 (/api/v1/user/delete/{id})

概要

従業員を削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/user/delete/{id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

従業員のID。タイプは path で、URL に記述されます

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

エラーレスポンスのフィールド

code

メッセージ

説明

600

Sync Failed

削除が失敗しました

700

Multi Request Error

グループから解除できませんでした

30001

Param Invalid

無効なパラメーターです

2.4.6 指定された日付(日)に追加、または更新された従業員アバターの取得(/api/v2/staff/image_updated)

概要

指定された日付(日)に追加、または更新された従業員アバターリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/staff/image_updated

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

date

string

Yes

指定された日付

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
  "code": 200,
  "message": "OK",
	"data": [
        {
             "employee_id":"001"
             "image_URL": "xxx",
             "remark": 0
         },
         {
             "employee_id":"002"
             "image_URL": "xxx",
             "remark": 1
         }
    ]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

employee_id

string

従業員ID

image_URL

string

従業員アバターのリンク (現在はサポートしておりません。出力結果は無視 てください)

remark

int

従業員アバターの新規または更新の識別子 0:新規追加

1:更新

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

無効なパラメーターです

2.4.7 ビジターの追加 (/api/v1/guest)

概要

ビジターを追加します。

ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

name

string

Yes

ビジター名。長さ制限は 45です

avatarFile

file

Yes

認証用顔写真

mobile

string

Yes

携帯電話番号。長さ制限は20。空の値で登録しないでください

remark

string

Yes

特記事項。空の string も指定可能。長さ制限は 255です

groups

list<long>

Yes

ビジターグループIDのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

force

int

No

強制追加するかどうか。デフォルトで0 0:強制ではない

1:強制

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

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です

mail

string

No

メールアドレス。長さ制限は 45です

icNumber

string

No

IC カード番号。長さ制限は 20です

birthday

string

No

誕生日

level

string

No

ビジターのレベル。長さ制限は 20です

prompt

string

No

カスタマイズプロンプト。長さ制限は 45です

areaCode

string

No

携帯電話番号の国別コードおよび市外局番

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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
 }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

ビジターID

name

string

ビジター名

avatar

string

ビジターの認証用顔写真

mobile

string

電話番号

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

ビジターのレベル

mail

string

ビジターのメールアドレス

birthday

string

ビジターの誕生日。例 : 2019-06-17

prompt

string

カスタマイズプロンプト

gender

int

ビジターの性別。1:女性、2:男性

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

709

The maximum number of persons in the tenant has been reached.

利用プランの登録人数上限に達しました。

30001

Param Invalid

無効なパラメーターです。ビジター名の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジター名が空です

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 の呼び出しに失敗しました。顔の検知に失敗しました

2.4.8 ビジターの追加 (/api/v2/guest)

概要

ビジターを追加します。

バージョン v1 をもとに、「similar」と「similarPin」、2つのパラメータが新規追加されました。ゲストを管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。この2パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、4桁のPinコードを指定する必要があります。また、認証用顔写真「avatarFile」が非必須となります。

バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/guest

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

name

string

Yes

ビジター名。長さ制限は 45です

avatarFile

file

No

認証用顔写真

mobile

string

Yes

携帯電話番号。長さ制限は20。空の値で登録しないでください

remark

string

Yes

特記事項。空の string も指定可能。長さ制限は 255です

groups

list<long>

Yes

ビジターグループIDのリスト。デフォルト値はタイプで定義します。空の場合は、どのグループにも追加しないことを示します

force

int

No

強制追加するかどうか。デフォルトで0 0:強制ではない 1:強制

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

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です

mail

string

No

メールアドレス。長さ制限は 45です

icNumber

string

No

IC カード番号。長さ制限は 20です

birthday

string

No

誕生日

level

string

No

ビジターのレベル。長さ制限は 20です

prompt

string

No

カスタマイズプロンプト。長さ制限は 45です

areaCode

string

No

携帯電話番号の国別コードおよび市外局番

similar

boolean

No

よく似た人。デフォルトはfalseです

similarPin

string

No

よく似た人が存在する場合の当該登録者のパスコード。4桁の数字です。similarがtrueの場合、このパラメータは必須となります

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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=",
           "companyId": 12,
           "reception_user_id": 124794,
           "reception_user_name": "Jason",
           "date_time_from": "2018-07-20 12:30:45",
           "date_time_to": "2020-07-20 12:30:45",
           "area_code": "86",
           "guest_company": "",
           "guest_purpose": "",
           "similar": true
    }
}

類似登録者が存在する場合のレスポンス

{
    "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"
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

ビジターID

name

string

ビジター名

avatar

string

ビジターの認証用顔写真

mobile

string

電話番号

remark

string

特記事項

groups

list<group>

ビジターのグループ情報

ic_number

string

IC カード番号

id_number

string

IDカード番号(利用できません)

companyId

long

企業ID

reception_user_id

long

受付担当者ID

reception_user_name

string

受付担当者名

date_time_from

string

来訪時間(開始)

date_time_to

string

来訪時間(終了)

area_code

string

電場番号の国別コードおよび市外局番。例 : 86

guest_company

string

ビジターの企業名

position

string

役職

guest_purpose

string

ビジターの来訪目的

level

string

ビジターのレベル

mail

string

ビジターのメールアドレス

birthday

string

ビジターの誕生日。例 : 2019-06-17

prompt

string

カスタマイズプロンプト

gender

int

ビジターの性別。1:女性、2:男性

similar

boolean

よく似た人がいるかどうか

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

Code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

620

Record non-existent Error

受付担当者が存在しません

20002

Permission Denied

拒否されました。受付担当者が存在しません

30001

Param Invalid

パスコードを入力してください。4桁のパスコードが必要です

30001

Param Invalid

無効なパラメーターです。ビジター名の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジター名が空です

30001

Param Invalid

無効なパラメーターです。ビジターのID 番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジターの携帯電話番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジターのコメントの長さが無効です

30001

Param Invalid

無効なパラメーターです。来訪時間(開始)の形式が無効です

30001

Param Invalid

無効なパラメーターです。来訪時間(終了)の形式が無効です

30001

Param Invalid

無効なパラメーターです。guest.come-time-not-null

30001

Param Invalid

無効なパラメーターです。guest.leave-time-not-null

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

無効なパラメーターです。ビジターのメールが長すぎます

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

ビジターの認証用写真のサイズが大きすぎます

610

Similar record Exist

従業員携帯電話番号がすでに存在します

610

Similar record Exist

従業員ICカード番号がすでに存在します

610

Similar record Exist

従業員ID番号がすでに存在します

30004

Missing Param

パラメータが不足です

600

Sync Failed

顔を検出できませんでした

600

Sync Failed

複数の顔を検出しました

500

Internal Server Error

登録できませんでした

50501

The maximum number of persons in the group has been reached.

ユーザが最大数を超えています

2.4.9 ビジター情報の変更 (/api/v1/guest/update/{id})

概要

ビジター情報を変更します。

(すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。)

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

ビジターID

name

string

Yes

ビジター名。長さ制限は 45です

avatarFile

file

No

ビジターの認証用顔写真

mobile

string

No

携帯電話番号。長さ制限は 20です

remark

string

No

特記事項。空の string も指定可能。長さ制限は 255です

groups

list<long>

Yes

ビジターグループIDのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

force

int

No

強制追加するかどうか。デフォルトで0:強制ではない、1:強制

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

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です

mail

string

No

ビジターのメールアドレス。長さ制限は 45です

birthday

string

No

ビジターの誕生日。例 : 2019-06-17

prompt

string

No

個別化されたプロンプト。長さ制限は 45です

gender

int

No

ビジターの性別。1:女性、2:男性

icNumber

string

No

IC カード番号。長さ制限は 20です

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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": ""
 }
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

ビジターID

name

string

ビジター名

avatar

string

ビジターの認証用顔写真

mobile

string

電話番号

remark

string

特記事項

groups

list<group>

ビジターグループ情報

position

string

役職

level

string

ビジターのレベル

mail

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

ビジターの来訪目的

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

long

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

30001

Param Invalid

ビジターが存在しません

30001

Param Invalid

ビジターが企業に属していません

30001

Param Invalid

無効なパラメーターです。ビジター名の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジター名が空です

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 の呼び出しに失敗しました。顔の検知に失敗しました

2.4.10 ビジター情報の変更 (/api/v2/guest/update/{id})

概要

ビジター情報を変更します。

バージョン v1 をもとに、「similar」と「similarPin」、2つのパラメータが新規追加されました。従業員を管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。これらのパラメータは任意ですが、「similar」にtrueと指定された場合「similarPin」は必須となり、4桁のPinコードを指定する必要があります。

バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

(すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。)

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/guest/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

ビジターID

name

string

Yes

ビジター名。長さ制限は 45です

avatarFile

file

No

ビジターの認証用顔写真

mobile

string

No

携帯電話番号。長さ制限は 20です

remark

string

No

特記事項。空の string も指定可能。長さ制限は 255です

groups

list<long>

Yes

ビジターグループIDのリスト。デフォルト値はタイプで定義します。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

force

int

No

強制追加するかどうか。デフォルトで0:強制ではない、1:強制

idNumber

string

No

ID 番号。長さ制限は 6~30(利用できません)

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です

mail

string

No

ビジターのメールアドレス。長さ制限は 45です

birthday

string

No

ビジターの誕生日。例 : 2019-06-17

prompt

string

No

個別化されたプロンプト。長さ制限は 45です

gender

int

No

ビジターの性別。1:女性、2:男性

icNumber

string

No

IC カード番号。長さ制限は 20です

similar

boolean

No

よく似た人。デフォルトはfalseです

similarPin

string

No

よく似た人が存在する場合の当該登録者のパスコード。4桁の数字です。similarがtrueの場合、このパラメータは必須となります

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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=",
           "companyId": 12,
           "reception_user_id": 124794,
           "reception_user_name": "Jason",
           "date_time_from": "2018-07-20 12:30:45",
           "date_time_to": "2020-07-20 12:30:45",
           "area_code": "86",
           "guest_company": "",
           "guest_purpose": "",
           "similar": truegetId
    }
}

類似登録者が存在する場合のレスポンス

{
    "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"
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

ビジターID

name

string

ビジター名

avatar

string

ビジターの認証用顔写真

mobile

string

電話番号

remark

string

特記事項

groups

list<group>

ビジターのグループ情報

position

string

役職

level

string

ビジターのレベル

mail

string

ビジターのメールアドレス

birthday

string

ビジターの誕生日。例 : 2019-06-17

prompt

string

カスタマイズプロンプト

gender

int

ビジターの性別。

1:女性、2:男性

ic_number

string

IC カード番号

id_number

string

IDカード番号(利用できません)

companyId

long

企業ID

reception_user_id

long

受付担当者ID

reception_user_name

string

受付担当者名

date_time_from

string

来訪時間(開始)

date_time_to

string

来訪時間(終了)

area_code

string

電場番号の国別コードおよび市外局番。例 : 86

guest_company

string

ビジターの企業名

guest_purpose

string

ビジターの来訪目的

similar

boolean

類似する人の有無が

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

Code

メッセージ

説明

610

Similar User Exist

類似する従業員がすでに存在します

620

Record non-existent Error

受付担当者が存在しません

20002

Permission Denied

拒否されました。受付担当者が存在しません

30001

Param Invalid

パスコードを入力してください。4桁のパスコードが必要です

30001

Param Invalid

無効なパラメーターです。ビジター名の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジター名が空です

30001

Param Invalid

無効なパラメーターです。ビジターのID 番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジターの携帯電話番号の長さが無効です

30001

Param Invalid

無効なパラメーターです。ビジターのコメントの長さが無効です

30001

Param Invalid

無効なパラメーターです。来訪時間(開始)の形式が無効です

30001

Param Invalid

無効なパラメーターです。来訪時間(終了)の形式が無効です

30001

Param Invalid

無効なパラメーターです。guest.come-time-not-null

30001

Param Invalid

無効なパラメーターです。guest.leave-time-not-null

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

無効なパラメーターです。ビジターのメールが長すぎます

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

ビジターの認証用写真のサイズが大きすぎます

30001

ex.method-argument-type-mismatch:groups

グループが一致しません

30001

Param Invalid

ビジターが存在しません

610

Similar record Exist

従業員携帯電話番号がすでに存在します

610

Similar record Exist

従業員ICカード番号がすでに存在します

610

Similar record Exist

従業員ID番号がすでに存在します

30004

Missing Param

パラメータが不足です:groups

30004

Missing Param

パラメータが不足です

600

Sync Failed

顔を検出できませんでした

600

Sync Failed

複数の顔を検出しました

500

Internal Server Error

内部エラーです。従業員を登録できませんでした

50501

The maximum number of persons in the group: %group% has been reached

ユーザーが最大数を超えています

2.4.11 ビジターの削除 (/api/v1/guest/delete/{id})

概要

ビジターを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest/delete/{id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

ビジターID。タイプは path で、URL に記述されます

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

ビジターが存在しません

30001

Param Invalid

ビジターが企業に属していません

50001

RPC FAILED

ビジターを削除するためのRPCに失敗しました

2.4.12 拒否リストの追加 (/api/v2/black)

ご利用のプランによって登録人数の上限が異なります。詳しくはお客様のご契約内容をご確認ください。

概要

拒否リストを追加します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

avatarFile

file

No

認証用顔写真

name

string

Yes

名前。長さ制限は 45です

force

int

No

強制追加するかどうか。デフォルトで0です 0:強制ではない

1:強制

groups

list<long>

No

拒否リストグループIDのリストです。渡さない場合、または空は、どのグループにも追加しないことを示します

areaCode

string

No

国別コードおよび市外局番。長さ制限は 8です

mobile

string

No

携帯電話番号。長さ制限は20です

gender

int

No

性別。1:女性、2:男性

birthday

string

No

誕生日(日付形式 : 2019-06-15)

mail

string

No

メールアドレス。長さ制限は 45です

icNumber

string

No

IC カード番号。長さ制限は 20です

idNumber

string

No

ID カード番号。長さ制限は 6~30(利用できません)

prompt

string

No

カスタマイズプロンプト。長さ制限は 255です

remark

string

No

特記事項。長さ制限は 255です

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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"
    }
} 

レスポンスのフィールド

パラメーター名

型

説明

id

int

拒否リスト ID

name

string

拒否リスト名

avatar

string

認証用顔写真 ID

mobile

string

携帯電話番号

mail

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

作成時間

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

709

The maximum number of persons in the tenant has been reached.

利用プランの登録人数上限に達しました。

30001

Param Invalid

電話番号はシステム内に存在しています

30001

Param Invalid

ID カード番号はシステム内に存在しています

30001

Param Invalid

IC カード番号はシステム内に存在しています

30001

Param Invalid

従業員IDはシステム内に存在しています

30001

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に失敗しました

610

Similar User Exist

類似する登録者がすでに存在します

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

拒否リストの認証用顔写真ファイルが大きすぎます

2.4.13 拒否リストへの移動 (/api/v2/black/move/in)

概要

既存の従業員またはビジターを選択して拒否リストに移動(登録者タイプを変更)します。

拒否リストに移動した後、登録者タイプが拒否リスト(type = 5) に変更されます。元の登録者グループと部署情報はクリアされますが、他の情報は保持されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/move/in

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

userId

long

Yes

従業員またはビジターのID

groupIds

list<long>

Yes

拒否リストのグループID リスト。空の場合は拒否リストグループには追加されません

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

498

Param Invalid

拒否リストが存在しません

498

Param Invalid

無効な登録者タイプです(拒否リストに移動中で、従業員でもビジターでもありません)

30001

Param Invalid

グループが空になっています

700

Multi Request Error

拒否リストとグループの連携に失敗しました

700

Multi Request Error

拒否リストとグループの連携解除に失敗しました

2.4.14 拒否リストからの削除 (/api/v2/black/move/out)

概要

拒否リストを削除します。 拒否リストから外されると、登録者タイプは元の識別子に戻ります(タイプ 1 または 2)。他の情報は保持されます。 拒否リストの登録者自体を削除するには、「拒否リストの削除」の章を参照してください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/move/out

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

拒否リストのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

登録者タイプが正しくありません。拒否リストの元の識別子が従業員またはビジターではないため、拒否リストから外すことができません

30001

Param Invalid

登録者タイプが正しくありません。拒否リストには元の識別子が無いため、拒否リストから外すことができません

2.4.15 拒否リストの変更 (/api/v2/black/update)

概要

拒否リストの情報を変更します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/update

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

拒否リストのID

name

string

Yes

名前

force

int

No

強制追加するかどうか。 デフォルトで0:強制ではない、1:強制

areaCode

string

No

国別コードおよび市外局番

avatarFile

file

No

認証用顔写真

birthday

string

No

誕生日(日付形式 : 2019-06-15)

gender

int

No

性別。1:女性、2:男性

groups

list

No

拒否リストグループIDのリスト。渡さない場合、または空の場合は、どのグループにも追加しないことを示します

icNumber

string

No

IC カード番号。長さ制限は 20です

idNumber

string

No

ID カード番号。長さ制限は 6~30(利用できません)

mail

string

No

メールアドレス

mobile

string

No

携帯電話番号

prompt

string

No

カスタマイズプロンプト

remark

string

No

特記事項

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "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"
 }
}

レスポンスのフィールド

パラメーター名

型

説明

id

int

拒否リスト ID

name

string

従業員名

avatar

string

認証用顔写真 ID

mobile

string

携帯電話番号

mail

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

作成者

group フィールド

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

拒否リストID が存在しません

30001

Param Invalid

電話番号はシステム内に存在しています

30001

Param Invalid

ID カード番号はシステム内に存在しています

30001

Param Invalid

IC カード番号はシステム内に存在しています

30001

Param Invalid

従業員IDはシステム内に存在しています

30001

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に失敗しました

610

Similar User Exist

類似する登録者がすでに存在します

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

拒否リストの認証用顔写真ファイルが大きすぎます

2.4.16 拒否リストの削除 (/api/v2/black/delete/{id})

概要

拒否リストを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/delete/{id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

拒否リスト ID。タイプは path で、URL に記述されます

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

拒否リストID が存在しません

600

Sync Failed

リモート削除に失敗しました

700

Multi Request Error

拒否リストとグループの連携解除に失敗しました

50001

RPC FAILED

削除に失敗しました

2.4.17 登録者の参照 (/api/v1/user/list)

概要

従業員、ビジター、および拒否リストのすべての登録者の情報を取得します。特定のフィールドのフィルター検索が可能です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/user/list

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

type

int

No

登録者の識別子タイプ。 1:従業員、2:ビジター、5:拒否リスト 情報が渡されなかった場合、すべてのリストが返されます

name

string

No

登録者名

jobNumber

string

No

従業員ID

mobile

string

No

携帯電話番号

mail

string

No

メールアドレス

icNumber

string

No

IC カード番号

idNumber

string

No

ID カード番号(利用できません)

id

long

No

登録者ID

departmentID

long

No

部署ID

groups

array

No

グループIDのリスト

page

int

No

ページ番号(デフォルトは 1 )

size

int

No

1 ページあたりのデータの数(デフォルトは 20)。最大値は 100

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。の計算の項を参照してください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "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
        }
    ]
}

レスポンスのフィールド

パラメーター名

型

説明

id

long

登録者ID

type

int

識別子タイプ

1:従業員

2:ビジター

3:不明

4: 非生体

5:拒否リスト

last_type

int

元の識別子。拒否リストの登録者にのみ適用されます

1:従業員

2:ビジター

groupList

list<group>

グループ情報。 インターフェースから返された登録者数が 1 人のみの場合、グループ情報が含まれます。複数の登録者が返された場合、グループ情報は含まれません

name

string

登録者名

avatar

string

登録者の認証用顔写真

mobile

string

携帯電話番号

ic_number

string

IC カード番号

id_number

string

IDカード番号(利用できません)

job_number

string

従業員ID

birthday

string

誕生日

mail

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

更新時間

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

30001

Param Invalid

無効なパラメーターです

1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)
1.3.1 シグネチャ(sign)