1 / 15

APIマニュアル

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

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

改訂履歴

日付

改訂内容

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項設定項目の名称とコメントを訂正

1 製品概要と利用方法

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

1.1 製品概要

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

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

2 APIリファレンス

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

2.1 システムのAPI 2.2 デバイスの API 2.3 デバイスアラートの API 2.4 登録者のAPI 2.5 登録者グループの API 2.6 アクセスルールAPI 2.7 レコードの API 2.8 認証用顔写真の API 2.9 部署の API 2.10 イベントサブスクリプション API 2.11 認証レコード+API

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フィールドの説明

エラーレスポンスのフィールド

{
    "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": ""
    }
}

{
    "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": {
		"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" // デバイスの拡張情報
		}],
	}
}

{
    "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
    }
}

2.9 部署の API

2.9.1 部署リストの取得 (/api/v2/department)

概要

部署リストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

department フィールドの説明

2.9.2 部署コードでの部署の検索 (/api/v2/department/search/code)

概要

部署コードから部署情報を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/search/code

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.9.3 ID での部署の検索 (/api/v2/department/{id})

概要

部署 ID から部署情報を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/{id}

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.9.4 部署の作成 (/api/v2/department)

概要

部署作成のインターフェースです。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.9.5 部署の更新 (/api/v2/department/update)

概要

部署インターフェースを更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/update

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.9.6 部署の削除 (/api/v2/department/delete)

概要

部署を削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/department/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

{
    "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
            }
      ]
}

2.5 登録者グループの API

2.5.1 グループの追加 (/api/v1/group)

概要

グループを追加します。

リクエストアドレスの例

https://link.japancv.co.jpT/api/v1/group

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.5.2 登録者グループリストの表示 list (/api/v1/group)

概要

登録者グループのリストを表示します。デフォルトの順序はID の降順です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/group

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

エラーレスポンスのフィールド

2.5.3 グループの登録者リストの取得 (/api/v1/group/user)

概要

グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/group/user

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.5.4 登録者グループの更新 (/api/v3/group/update)

概要

登録者グループを更新します。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/group/update

リクエスト方法

POST application/json

リクエストパラメーター

※SenseLink Cloud V2.3.8では必須になっていましたが、V2.3.9以降は必須ではなくなっています。

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

device フィールドの説明

エラーレスポンスのフィールド

2.5.5 グループの削除 (/api/v1/group/delete/{id})

概要

グループを削除します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/group/delete/{id}

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.5.6 登録者のグループへの一括追加 (/api/v1/user/add/group)

概要

登録者を一括でグループに追加します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/user/add/group

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスフィールドの説明

エラーレスポンスのフィールド

2.5.7 登録者のグループからの一括削除 (/api/v1/user/remove/group)

概要

グループから一括で登録者を削除します。

リクエストアドレスの例

http://link.japancv.co.jp/api/v1/user/remove/group

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 616,
        "name": "太朗",
        "type": 1,
        "company_id": 58,
        "create_at": "2018-08-07 18:37:32",
        "update_at": "2018-08-07 18:37:32"
    }
}

{
    "code": 200,
    "message": "OK",
    "data": {
        "total": 5,
        "pageNum": 1,
        "size": 5,
        "pageSize": 20,
        "totalPage": 1,
        "data": [
            {
                "id": 214,
                "name": "Default group",
                "type": 1,
                "user_number": 1327,
                "company_id": 58,
                "create_at": "2018-05-28 17:31:32.0",
                "update_at": "2018-05-28 17:31:32.0"
            },
            {
                "id": 215,
                "name": " Default group",
                "type": 2,
                "user_number": 0,
                "company_id": 58,
                "create_at": "2018-05-28 17:31:32.0",
                "update_at": "2018-05-28 17:31:32.0"
            },
            {
                "id": 226,
                "name": "123",
                "type": 1,
                "user_number": 1543,
                "company_id": 58,
                "create_at": "2018-05-30 14:50:17.0",
                "update_at": "2018-05-30 14:50:17.0"
            },
            {
                "id": 231,
                "name": "ccc",
                "type": 1,
                "user_number": 4,
                "company_id": 58,
                "create_at": "2018-06-04 21:52:45.0",
                "update_at": "2018-06-04 21:52:53.0"
            },
            {
                "id": 517,
                "name": "Test",
                "type": 1,
                "user_number": 2,
                "company_id": 58,
                "create_at": "2018-07-02 21:14:41.0",
                "update_at": "2018-07-02 21:14:41.0"
            }
        ]
    }
}

2.10 イベントサブスクリプション API

2.10.1 概要

外部システムはSenseLinkのサブスクリプションサービスを利用することで、SenseLinkのイベントをサブスクライブすることができます。SenseLinkはデバイスの認証とアラート（以下、「イベント」）をPOSTリクエスト（以下、「Push」）することができます。

2.10.2 利用の開始

当節で記載される手順・設定の他にJCVサポート窓口へ以下の情報を申請してください。申請およびJCVサポート窓口の処理が完了するまで、イベントサブスクリプション機能は利用できません。

イベントを処理するAPIエンドポイント（アプリケーションのURL）
上記エンドポイントのIPアドレス

サブスクリプション申請時に提出する情報は以下のものです

固定IPアドレスとポート番号（必須）
URL（サブスクリプションを受け取るクライアント側URL）（必須）
※注：クライアント側URLとの通信に際し、BASIC認証などの認証技術は対応しておりません。

イベントをサブスクライブする外部システムのAPIエンドポイントは、SenseLinkのナビゲーションメニュー [ユーザー名]→[オープンプラットフォーム] 内のサブスクリプションサービスステータス欄のドメイン管理、もしくは本マニュアル内のAPIで設定および更新することができます。

サブスクリプションサービス設定を選択して表示されるイベント処理サーバーアドレスの欄に、連携する外部システムのサーバーアドレスを入力してください。プロトコルはhttp、httpsをサポートしています。https://またはhttps://から入力してください。複数のエンドポイントを設定することができますので、セミコロン（;）で区切ってください。

サブスクリプションイベントタイプ欄で「認証レコード」にチェックを入れ、サブスクライブするイベントのタイプを選んでください。

デバイスで認証が行われた際、認証レコードをPushで受け取るには認証レコード、デバイスアラートが発生した場合にPushで受け取るにはデバイスアラートを選択してください。なお、両方を選択することも可能です。

2.10.4 認証レコードタイプの種類

認証レコードタイプには、以下の種類があります。

サブスクリプションを更新した際に、再保存時に認証レコードタイプ/デバイスアラートタイプが「未選定」の状態になる場合があります。その場合は再設定してください。

設定が完了したら、保存ボタンをクリックしてください。オープンプラットフォーム画面に戻ります。サブスクリプションサービスステータスが「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の例

認証レコード

デバイスアラート

Pushするイベントのパラメーター

認証レコードデータの属性

group フィールドの説明

デバイスのアラートレコードのデータ属性

通常のレスポンス

レスポンスのフィールド

2.10.9 サブスクリプション更新API (/api/v4/event/updateSub)

概要

イベントのサブスクリプションを追加または更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/event/updateSub

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.10.10 サブスクリプション停止API (/api/v3/event/stopSub)

概要

イベントのサブスクリプションを停止します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/stopSub

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.10.11 サブスクリプション詳細表示API (/api/v4/event/viewSub)

概要

サブスクリプションの詳細を表示します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/event/viewSub

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.10.12 イベントPushログの表示 (/api/v3/event/viewLog)

概要

イベントのPushログを表示します。

サブスクリプションサービスが起動されなくても、該当するAPIを使って前に生成されたログを取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/viewLog

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.10.13 テストイベントの送信 (/api/v3/event/sendTest)

概要

テストイベントをPush送信します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/event/sendTest

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

{
    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
}

{
    "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": 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": 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"
        },
    ]
}

2.8 認証用顔写真の API

2.8.1 顔の数の検知 (/api/v1/recognition/check)

概要

認証用顔写真内の顔の数を特定します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/recognition/check

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.8.2 認証用顔写真品質の検出 (/api/v3/recognition/quality)

概要

選定した品質チェックレベルで、認証用顔写真の品質を検出します。写真に複数の顔がある場合、最大の顔の情報のみ表示されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

品質チェックレベル：

低：写真のサイズ、ファイルのフォーマット、顔の数のみに基づく簡単な判断です。低品質の顔認証運用に適しています。
高：写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、鼻、口の遮蔽などの多要素に基づく包括的な判断です。高品質の顔認識が必要な運用に適しています。
厳格：パスポートの要件を参照し、写真のサイズ、ファイルのフォーマット、顔の数、顔のサイズ、顔の角度、明るさ、ぼやけさ、口の開き状況、目、眉毛、顔の輪郭、鼻、口の遮蔽などの多要素に基づく包括的な判断です。厳格な顔認証が必要な運用に適しています。

認証パラメーター

通常のレスポンス（qa_level='1'）

通常のレスポンス（qa_level='2'）

通常のレスポンス（qa_level='3'）

レスポンスのフィールド

face項目の説明（qa_level='2'）

face項目の説明（qa_level='3'）

qa_code の説明（qa_level='1'）

qa_code の説明（qa_level='2'）

qa_code の説明（qa_level='3'）

エラーレスポンスのフィールド

2.8.3 認証用顔写真品質の検出 (/api/v2/recognition/quality)

概要

「厳格」の品質チェックレベルで、認証用顔写真の品質を検出します。写真に複数の顔がある場合、最大の顔の情報のみ表示されます。

品質チェックレベルを指定したい場合、をご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

face項目の説明

qa_code の説明

エラーレスポンスのフィールド

2.8.4 認証用顔写真品質の検出 (/api/v1/recognition/quality)

概要

認証用顔写真の品質を検出します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

qa_code の説明

エラーレスポンスのフィールド

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

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

data フィールドの説明

エラーレスポンスのフィールド

2.8.6 顔写真の取得（/v1/image/{type}/{image_id}）

概要

登録者のタイプと写真のIDを指定し、該当する写真（圧縮後）が返されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/image/{type}/{image_id}

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

認証パラメーター

パラメーター名

型

必須

説明

通常のレスポンス

エラーレスポンスのフィールド

コード

メッセージ

説明

{
    "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"
    }
}

{
    "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"
    }
}

{
    "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"
    }
}

{
    "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"
    }
}

{
 "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"
    }
  ]
}

2.6 アクセスルールAPI

2.6.1 タイムテーブルの追加 (/api/v3/pass/timetable)

概要

タイムテーブルを追加します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable

リクエスト方法

POST application/json

リクエストパラメーター

Time フィールドの説明

Special_day フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.6.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

概要

タイムテーブルを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.6.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

概要

タイムテーブルを更新します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/update

リクエスト方法

POST application/json

リクエストパラメーター

time フィールドの説明

special_day フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.6.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

概要

タイムテーブルリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.6.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

概要

タイムテーブルの詳細を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/timetable

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.6.6 アクセスルールの追加 (/api/v3/pass/rule)

概要

アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule

リクエスト方法

POST application/json

リクエストパラメーター

passRule フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.6.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

概要

アクセスルールを削除します。一括削除が可能です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.6.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

概要

構成されているアクセスルールのリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/rule/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.6.9 デバイスおよびグループの連携情報の取得（アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

概要

すべてのデバイスおよびグループの連携関係（アクセスルール情報を含む）を取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/pass/devices/passrules

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

timetableGroup フィールドの説明

エラーレスポンスのフィールド

{
 "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": 200,
 "message": "OK",
 "data": {
 "id": 28,
 "name": "test,
 "monday": "010000000000000000000000000000000000000000000000",
 "tuesday": "010000000000000000000000000000000000000000000000",
 "wednesday": "010000000000000000000000000000000000000000000000",
 "thursday": "010000000000000000000000000000000000000000000000",
 "friday": "010000000000000000000000000000000000000000000000",
 "saturday": "010000000000000000000000000000000000000000000000",
 "sunday": "010000000000000000000000000000000000000000000000",
 "holiday": "010000000000000000000000000000000000000000000000",
 "special_days": [{
 "id": 59,
 "date": "2019-10-07",
 "remark": null,
 "timetable_id": 28
 }, {
 "id": 60,
 "date": "0000-10-22",
 "remark": null,
 "timetable_id": 28
 }],
 "monday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "tuesday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "wednesday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "thursday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "friday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "saturday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "sunday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "holiday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "start_timestamp": 1546275661000,
 "end_timestamp": 1546275661000
 }
}

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 28,
 "name": "liufan1131",
 "monday": "010000000000000000000000000000000000000000000000",
 "tuesday": "010000000000000000000000000000000000000000000000",
 "wednesday": "010000000000000000000000000000000000000000000000",
 "thursday": "010000000000000000000000000000000000000000000000",
 "friday": "010000000000000000000000000000000000000000000000",
 "saturday": "010000000000000000000000000000000000000000000000",
 "sunday": "010000000000000000000000000000000000000000000000",
 "holiday": "010000000000000000000000000000000000000000000000",
 "special_days": [{
 "id": 59,
 "date": "2019-10-07",
 "remark": null,
 "timetable_id": 28
 }, {
 "id": 60,
 "date": "0000-10-22",
 "remark": null,
 "timetable_id": 28
 }],
 "monday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "tuesday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "wednesday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "thursday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "friday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "saturday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "sunday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "holiday_period": [{
 "start_time": "0:30:00",
 "end_time": "0:59:00"
 }],
 "start_timestamp": 1546275661000,
 "end_timestamp": 1546275661000
 }
}

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": [{
        "id": 141,
        "device_id": 314,
        "device_name": "v2.1.0-test4444",
        "group_id": 2,
        "group_name": "Default group",
        "timetable_id": 35,
        "timetable_name": "test-0713",
        "group_type": 2
    }]
}

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": [{
 "id": 141,
 "device_id": 314,
 "device_name": "v2.1.0-test4444",
 "group_id": 2,
 "group_name": "Default group",
 "timetable_id": 35,
 "timetable_name": "test-0713",
 "group_type": 2
 }]
}

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": [{
 "device_id": 9,
 "device_name": "device6",
 "timetable_groups": [{
 "group_id": 476,
 "group_name": "bbb",
 "group_type": 2,
 "timetable_id": 0,
 "timetable_name": ""
 }]
 }]
}

2.7 レコードの API

2.7.1 認証レコードの表示 (/api/v6/record/list)

概要

認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v6/record/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

id_info フィールドの説明

パラメータ名

型

説明

ext_infoフィールドの説明

ext_infoには、以下のThunderデバイス用アプリケーションが出力する情報が格納されます。

Thunder Attendance

パラメータ名

説明

エラーレスポンスのフィールド

2.7.2 認証レコードの表示 (/api/v5/record/list)

概要

認証レコードを表示します。指定期間内のレコードを最大100万件取得できます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v5/record/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

id_info フィールドの説明

パラメータ名

型

説明

エラーレスポンスのフィールド

2.7.3 認証レコードの表示 (/api/v4/record/list)

概要

認証レコードを表示します。

v3のインターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v4/record/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

エラーレスポンスのフィールド

2.7.4 認証レコードの表示 (/api/v3/record/list)

概要

認証レコードを表示します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/record/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

エラーレスポンスのフィールド

{
	"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": 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": 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": 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
    }
}

2.2 デバイスの API

2.2.1 デバイスの更新 (/api/v3/device/update)

概要

デバイス情報を更新します（ゲートウェイデバイスはグループに連携できません）。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/update

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

group フィールドの説明

エラーレスポンスのフィールド

2.2.2 デバイスの削除 (/api/v3/device/delete)

概要

デバイス（ゲートウェイまたはカメラデバイス）を削除します。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.2.3 サブカメラのリストの取得 (/api/v3/gateway/cameraList)

開発中のため、当APIは現在利用できません

概要

カメラのリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/gateway/cameraList

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

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

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

device_type フィールドの説明

device フィールドの説明

group フィールドの説明

エラーレスポンスのフィールド

2.2.5 デバイスリストの表示 (/api/v1/device)

概要

デバイスリストを表示します。デフォルトの順序は ID の降順です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/device

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

device_type フィールドの説明

device フィールドの説明

group フィールドの説明

エラーレスポンスのフィールド

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

リクエストパラメーター

デバイス型番識別子

構成項目とパラメーターの説明

認証パラメーター

リクエスト例

通常のレスポンス

エラーレスポンスのフィールド

2.2.7 リモートドアオープン (/api/v2/device/open)

概要

オンラインデバイスにドアオープンコマンドを送信します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/device/open

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

2.2.8 通知の送信 (/api/v3/device/notify)

開発中のため当APIは現在利用できません

概要

オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/notify

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

リクエスト例

2.2.9 デバイスLDIDの取得（/api/v3/device/ldid）

概要

デバイスのシリアル番号でデバイスのLDIDを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v3/device/ldid

リクエスト方法

GET

リクエストパラメーター

デバイス型番識別子

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

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

リクエストパラメーター

認証パラメーター

リクエスト例

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "id": 2,
        "name": "勤務グループ ",
        "location": "日本東京都千代田区",
        "state": 0,
        "description": "",
        "direction": 1,
        "ip": "",
        "ldid": "SHL-3931ff3bd1fd7157866c4d22858c533c",
        "type_id": 1,
        "type_name": "SenseHello",
        "user_group": [{
            "id": 1,
            "name": "Default group",
            "type": 1,
            "devices": [],
            "is_default": 1,
            "person_count": 19988
        }],
        "guest_group": [ {
            "id": 105,
            "name": "test",
            "type": 2,
            "devices": [],
            "is_default": 0,
            "person_count": 5
        }],
        "blacklist_group": [ {
            "id": 148,
            "name": "User_1560842344639",
            "type": 5,
            "devices": [],
            "is_default": 0,
            "person_count": 23
        }],
        "update_at": 0,
        "create_at": 0,
        "last_offline_time":0
    }
}

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": [{
        "id":1562
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "channel": 2,
        "position": "",
        "url": "172.20.4.110",
        "state": 1,
        "camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
        "camera_name": "2"
    }, {
        "id":1563
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "channel": 1,
        "position": "",
        "url": "172.20.4.110",
        "state": 1,
        "camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
        "camera_name": "1"
    }]
}

{
    "code": 200,
    "message": "OK",
    "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": 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
                  }
           }]
    }
}

{
    "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",
    "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": ""
      }
    }
}

{
 "settings":{
        "device_run_type": 1,
        "use_mode": 1,
        "mode": 1,
        "welcome_tip": "welcomeTip",
        "verify_success_tip": "verifySuccessTip",
        "verify_fault_tip": "verifyFaultTip",
 }
}

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

リクエストパラメーター

認証パラメーター

通常のレスポンス

類似登録者が存在する場合のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.2 従業員の追加 (/api/v2/user)

概要

従業員を追加します。「similar」と「similarPin」、2つのパラメータが新規追加されました。従業員を管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。この2パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、４桁4Pinコードを指定する必要があります。

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

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/user

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

類似登録者が存在する場合のレスポンス

レスポンスのフィールド

group フィールドの説明

device フィールドの説明

エラーレスポンスのフィールド

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

リクエストパラメーター

group フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.4 従業員情報の変更 (/api/v3/user/update/{id})

概要

従業員情報を変更します。

バージョン v2 をもとに、「similar」と「similarPin」、２つのパラメータが新規追加されました。従業員を管理する場合、双子など似ている人が存在するときに、この２つのパラメータを利用することにより、区別して顔認識することができます。この２パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、４桁のPinコードを指定する必要があります。

バージョン v2 のインターフェースは、引き続きご利用いただくことができます。

リクエストアドレスの例

リクエスト方法

リクエストパラメーター

groupフィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

device フィールドの説明

エラーレスポンスのフィールド

2.4.5 従業員の削除 (/api/v1/user/delete/{id})

概要

従業員を削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/user/delete/{id}

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.4.6 指定された日付（日）に追加、または更新された従業員アバターの取得（/api/v2/staff/image_updated）

概要

指定された日付（日）に追加、または更新された従業員アバターリストを取得します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/staff/image_updated

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.4.7 ビジターの追加 (/api/v1/guest)

概要

ビジターを追加します。

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

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.8 ビジターの追加 (/api/v2/guest)

概要

ビジターを追加します。

バージョン v1 をもとに、「similar」と「similarPin」、2つのパラメータが新規追加されました。ゲストを管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。この2パラメータは非必須ですが、「similar」にtrueと指定されたときに、「similarPin」は必須になり、4桁のPinコードを指定する必要があります。また、認証用顔写真「avatarFile」が非必須となります。

バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

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

リクエストアドレスの例

リクエスト方法

リクエストパラメーター

認証パラメーター

通常のレスポンス

類似登録者が存在する場合のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.9 ビジター情報の変更 (/api/v1/guest/update/{id})

概要

ビジター情報を変更します。

（すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。）

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.10 ビジター情報の変更 (/api/v2/guest/update/{id})

概要

ビジター情報を変更します。

バージョン v1 をもとに、「similar」と「similarPin」、2つのパラメータが新規追加されました。従業員を管理する場合、双子など似ている人が存在するときに、この2つのパラメータを利用することにより、区別して顔認識することができます。これらのパラメータは任意ですが、「similar」にtrueと指定された場合「similarPin」は必須となり、4桁のPinコードを指定する必要があります。

バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

（すでに登録済みの他者の写真を利用して更新する場合、ビジター情報の変更や顔認証が正常に登録や正常に行われません。ご注意ください。）

リクエストアドレスの例

リクエスト方法

リクエストパラメーター

認証パラメーター

通常のレスポンス

類似登録者が存在する場合のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.11 ビジターの削除 (/api/v1/guest/delete/{id})

概要

ビジターを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/guest/delete/{id}

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

エラーレスポンスのフィールド

2.4.12 拒否リストの追加 (/api/v2/black)

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

概要

拒否リストを追加します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

2.4.13 拒否リストへの移動 (/api/v2/black/move/in)

概要

既存の従業員またはビジターを選択して拒否リストに移動（登録者タイプを変更）します。

拒否リストに移動した後、登録者タイプが拒否リスト（type = 5）に変更されます。元の登録者グループと部署情報はクリアされますが、他の情報は保持されます。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/move/in

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

2.4.14 拒否リストからの削除 (/api/v2/black/move/out)

概要

拒否リストを削除します。拒否リストから外されると、登録者タイプは元の識別子に戻ります（タイプ 1 または 2）。他の情報は保持されます。拒否リストの登録者自体を削除するには、「拒否リストの削除」の章を参照してください。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/move/out

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

2.4.15 拒否リストの変更 (/api/v2/black/update)

概要

拒否リストの情報を変更します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/update

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールド

エラーレスポンスのフィールド

2.4.16 拒否リストの削除 (/api/v2/black/delete/{id})

概要

拒否リストを削除します。

リクエストアドレスの例

https://link.japancv.co.jp/api/v2/black/delete/{id}

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

エラーレスポンスのフィールド

2.4.17 登録者の参照 (/api/v1/user/list)

概要

従業員、ビジター、および拒否リストのすべての登録者の情報を取得します。特定のフィールドのフィルター検索が可能です。

リクエストアドレスの例

https://link.japancv.co.jp/api/v1/user/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

group フィールドの説明

エラーレスポンスのフィールド

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 65838,
        "name": "1312313123123122",
        "avatar": "5cbe78b135060d0001750ef5",
        "mobile": "",
        "remark": "",
        "type": 1,
        "birthday": "",
        "mail": null,
        "position": null,
        "location": null,
        "groupList": [
            {
                "id": 1,
                "name": "Default group",
                "type": 1
            }
        ],
        "gender": 1,
        "prompt": "",
        "ic_number": "",
        "id_number": "te9+d6aXoDe5zTCUywgn9+zmx4HElB4W",
        "job_number": "",
        "company_id": 1,
        "create_at": "2019-04-23 10:30:08",
        "update_at": "2019-04-23 10:30:08",
        "department_id": 0,
        "area_code": null,
        "entry_time": "2018-9-10"
    }
}

{
    "code": 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"
}

{
	"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"
}

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 79653,
 "name": "1312313123123122",
 "avatar": "",
 "mobile": "123",
 "remark": "",
 "type": 1,
 "birthday": null,
 "mail": null,
 "position": null,
 "location": null,
 "groupList": [{
 "id": 1,
 "name": "Default group",
 "type": 1
 }],
 "gender": null,
 "prompt": null,
 "ic_number": "1234000",
 "id_number": null,
 "job_number": "120003",
 "company_id": 1,
 "create_at": null,
 "update_at": "2019-08-22 11:03:18",
 "department_id": null,
 "area_code": null,
 "entry_time": null,
 }
}

{
    "code": 200,
    "message": "OK",
    "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,
    }
}

{
  "code": 200,
  "message": "OK",
	"data": [
        {
             "employee_id":"001"
             "image_URL": "xxx",
             "remark": 0
         },
         {
             "employee_id":"002"
             "image_URL": "xxx",
             "remark": 1
         }
    ]
}

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 79661,
 "name": "zml",
 "avatar": "5d5e36e4f684640001b34027",
 "mobile": "123",
 "remark": "",
 "groups": [],
 "position": null,
 "level": null,
 "mail": null,
 "birthday": null,
 "prompt": null,
 "gender": null,
 "ic_number": "",
 "id_number": "kBDHQ/IUQtY=",
 "company_id": 1,
 "reception_user_id": 4567,
 "reception_user_name": "太朗",
 "group_count": 0,
 "date_time": "2018-07-20 12:30:45.0",
 "date_time_from": "2018-07-20 12:30:45.0",
 "date_time_to": "2020-07-20 12:30:45.0",
 "create_at": "2019-08-22 14:32:04.0",
 "update_at": "2019-08-22 6:32:04.0",
 "area_code": null,
 "guest_company": null,
 "guest_purpose": null
 }
}

{
    "code": 200,
    "message": "OK",
    "data": {
           "id": 124379,
           "name": "zml",
           "avatar": "5dad624c199e160001c45e8f",
           "mobile": "123",
           "remark": "",
           "groups": [{
                  "id": 14,
                  "name": "Default group",
                  "type": 2
           }],
           "position": "",
           "level": "",
           "mail": "",
           "birthday": null,
           "prompt": "",
           "gender": 2,
           "ic_number": "",
           "id_number": "kBDHQ/IUQtY=",
           "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"
}

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 124379,
 "name": "zml",
 "avatar": "5dad624c199e160001c45e8f",
 "mobile": "123",
 "remark": "",
 "groups": [{
 "id": 14,
 "name": "Default group",
 "type": 2
 }],
 "position": "",
 "level": "",
 "mail": "",
 "birthday": null,
 "prompt": "",
 "gender": 2,
 "ic_number": "",
 "id_number": "kBDHQ/IUQtY=",
 "company_id": 12,
 "reception_user_id": 124794,
 "reception_user_name": "太朗",
 "group_count": 1,
 "date_time": "2018-07-20 12:30:45",
 "date_time_from": "2018-07-20 12:30:45",
 "date_time_to": "2020-07-20 12:30:45",
 "create_at": "2019-10-21 15:51:28",
 "update_at": "2019-10-30 20:45:05",
 "area_code": "86",
 "guest_company": "",
 "guest_purpose": ""
 }
}

{
    "code": 200,
    "message": "OK",
    "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"
}

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 66865,
        "name": "山田",
        "avatar": "5d084f23b2814100015ad03c",
        "mobile": "13655588555",
        "mail": "[email protected]",
        "birthday": "2019-06-11",
        "remark": "demo",
        "groups": [
            {
                "id": 126,
                "name": "デフォルト拒否リスト",
                "type": 3
            },
            {
                "id": 127,
                "name": "2",
                "type": 3
            }
        ],
        "prompt": "ようこそ",
        "gender": 0,
        "createBy": "OPEN API",
        "avatar_show": "",
        "ic_number": "",
        "id_number": "1545557788555",
        "area_code": "86",
        "last_type": 0,
        "create_at": "2019-06-18 02:40:35.0"
    }
}

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {
 "id": 124759,
 "name": "668089",
 "avatar": "5dba86ff7bf01300010b02c9",
 "mobile": "",
 "mail": "",
 "birthday": "",
 "remark": "",
 "groups": [{
 "id": 15,
 "name": "Blacklist default group",
 "type": 5
 }],
 "prompt": "",
 "gender": 2,
 "avatar_show": "",
 "ic_number": "",
 "id_number": "3O8bqu0sRiKA7+LVRzE3eQ==",
 "area_code": "86",
 "last_type": 0,
 "create_by": "admin1234",
 "create_at": "2019-10-23 17:28:19"
 }
}

{
    "code": 200,
    "message": "OK",
    "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
        }
    ]
}

APIマニュアル

改訂履歴

1 製品概要と利用方法

1.1 製品概要

2 APIリファレンス

2.1 システムのAPI

2.1.1 バージョン番号の取得 (/api/v3/server/version)

2.1.2 企業情報の取得 (/api/v1/company)

APIマニュアル

改訂履歴

2 APIリファレンス

2.1 システムのAPI

2.1.1 バージョン番号の取得 (/api/v3/server/version)

2.1.2 企業情報の取得 (/api/v1/company)

1 製品概要と利用方法

1.1 製品概要

1.2.1 Appキーの確認

1.2.2 特記事項” 列の追加

1.2.3 Appキーの管理

1.3 呼び出し方法

1.3.1 シグネチャ（sign）の計算

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

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

1.4 API エラーコード

2.11 認証レコード+API

2.11.1 顔認証&認証レコード+の生成 (api/v1/plus/record)

2.11.2 認証レコード+ の取得 (/api/v1/plus/record)

2.11.3 認証レコード+ スナップショット取得 (/api/v1/plus/image/{image_id})

2.3 デバイスアラートの API

2.3.1 デバイスアラートの取得 (/api/v2/device/alarm/list)

2.3.2 デバイスアラートの解除 (/api/v2/device/alarm/disarm)

2.9 部署の API

2.9.1 部署リストの取得 (/api/v2/department)

2.9.2 部署コードでの部署の検索 (/api/v2/department/search/code)

2.9.3 ID での部署の検索 (/api/v2/department/{id})

2.9.4 部署の作成 (/api/v2/department)

2.9.5 部署の更新 (/api/v2/department/update)

2.9.6 部署の削除 (/api/v2/department/delete)

2.5 登録者グループの API

2.5.1 グループの追加 (/api/v1/group)

2.5.2 登録者グループリストの表示 list (/api/v1/group)

2.5.3 グループの登録者リストの取得 (/api/v1/group/user)

2.5.4 登録者グループの更新 (/api/v3/group/update)

2.5.5 グループの削除 (/api/v1/group/delete/{id})

2.5.6 登録者のグループへの一括追加 (/api/v1/user/add/group)

2.5.7 登録者のグループからの一括削除 (/api/v1/user/remove/group)

2.10 イベントサブスクリプション API

2.10.1 概要

2.10.2 利用の開始

2.10.4 認証レコードタイプの種類

2.10.5 サブスクリプションサービスの設定の変更と停止

2.10.6 Push失敗の場合

2.10.7 イベントPushログ

2.10.8 イベントPushのプロトコル

2.10.9 サブスクリプション更新API (/api/v4/event/updateSub)

2.10.10 サブスクリプション停止API (/api/v3/event/stopSub)

2.10.11 サブスクリプション詳細表示API (/api/v4/event/viewSub)

2.10.12 イベントPushログの表示 (/api/v3/event/viewLog)

2.10.13 テストイベントの送信 (/api/v3/event/sendTest)

2.8 認証用顔写真の API

2.8.1 顔の数の検知 (/api/v1/recognition/check)

2.8.2 認証用顔写真品質の検出 (/api/v3/recognition/quality)

2.8.3 認証用顔写真品質の検出 (/api/v2/recognition/quality)

2.8.4 認証用顔写真品質の検出 (/api/v1/recognition/quality)

2.8.5 顔検索 (/api/v1/image/search)

2.8.6 顔写真の取得（/v1/image/{type}/{image_id}）

2.6 アクセスルールAPI

2.6.1 タイムテーブルの追加 (/api/v3/pass/timetable)

2.6.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

2.6.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

2.6.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

2.6.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

2.6.6 アクセスルールの追加 (/api/v3/pass/rule)

2.6.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

2.6.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

2.6.9 デバイスおよびグループの連携情報の取得 （アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

2.7 レコードの API

2.7.1 認証レコードの表示 (/api/v6/record/list)

2.7.2 認証レコードの表示 (/api/v5/record/list)

2.7.3 認証レコードの表示 (/api/v4/record/list)

2.6.9 デバイスおよびグループの連携情報の取得（アクセスルール情報を含む） (/api/v3/pass/devices/passrules)