1 / 16

APIマニュアル

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

本マニュアルでは、ビルディングアクセスソリューションおよびAI温度検知ソリューションの管理プラットフォームであるSenseLink GE Enterprise V2.2.0（以下SenseLink）が提供するAPIの利用方法や仕様について記載しています。

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

改訂履歴

1 利用方法

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

1.1 キーとシークレットの取得

SenseLinkにログインし、[System Management] > [Open Platform] へと移動してください。AppKeyとApp Secretが表示されます。

1.2 呼び出し方法

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

計算方法

sign=md5 (timestamp#app_secret)

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

例：

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

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

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

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

http://host:port/api/v1/device?typeId=10&size=100&sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

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

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

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

http://host:port/api/v3/device/update?sign=e5ef72ef839bdf5397b4906b199b9fbf&app_key=35uifanj8i30kdng&timestamp=1477881215000

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

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

1.3 API エラーコード

2 APIリファレンス

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

2.1 システムのAPI

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

概要

現在のシステムのバージョン番号を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/server/version

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "edition": "1.10.0",
        "date": "20190617"
    }
}

レスポンスのフィールド

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

概要

企業情報を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v1/company

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 58,
        "name": "日本コンピュータビジョン",
        "logo": "5b238d7ec6681b0001466d5e",
        "background": "5b238d7ec6681b0001466d5f",
        "welcome": "日本コンピュータビジョンへようこそ ",
        "introduction": "独創性をもち、AIに人類の進歩を牽引する企業",
        "contact": "太郎",
        "createAt": "2018-05-28 17:31:32.0",
        "updateAt": "2018-06-28 15:57:55.0",
        "validFrom": "2018-06-15 00:00:00.0",
        "validTo": "2018-07-31 00:00:00.0",
        "createBy": 17,
        "threshold": 0.85,
        "language": "zh",
        "serviceConfig": ""
    }
}

レスポンスのフィールド

dataフィールドの説明

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

2.2 デバイスの API

2.2.1 ゲートウェイの追加 (/api/v3/gateway/add) ※開発中機能のためご利用できません

概要

ゲートウェイデバイスを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/add

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"id": 1561,
		"name": "SNB",
		"location": "306",
		"direction": 0,
		"description":"",
		"ldid": "SNB-2ee63f9c699a7316a3e2a44646d0c844",
		"type_id": 10,
		"type_name": "SNB",
		"update_at": 1574854584,
		"create_at": 1574670842
	}
}

レスポンスのフィールド

dataフィールドの説明

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

2.2.2 カメラの追加 (/api/v3/camera/add) ※開発中機能のためご利用できません

概要

カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/add

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 1562,
 "name": "40F",
 "location": "40F",
 "description": "",
 "direction": 0,
 "ldid": "CAM-b054ac85cb84137b75abaa2bd7fc4a38",
 "type_id": 11,
 "type_name": "CAM",
 "update_at": 1574851340,
 "create_at": 1574851340
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/update

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

dataフィールドの説明

group フィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

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

2.2.5 サブカメラのリストの取得 (/api/v3/gateway/cameraList) ※開発中機能のためご利用できません

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/cameraList

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

dataフィールドの説明

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

2.2.6 親デバイスの取得 (/api/v3/camera/gatewayList) ※開発中機能のためご利用できません

概要

関連する親デバイスを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/gatewayList

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "id":1561,
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "name": "306",
        "location": "306",
        "host": "172.20.4.110",
        "port": 80,
        "cameras": [{
            "id":1562,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 1,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
            "camera_name": "1"
        }, {
            "id":1563,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 2,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
            "camera_name": "2"
        }]
    }
}

レスポンスのフィールド

dataフィールドの説明

cameraフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/device

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"total": 406,
		"pageNum": 1,
		"size": 20,
		"pageSize": 20,
		"totalPage": 21,
		"data": [{
			"device_type": {
			  "id": 2,
				"name": "SenseID",
				"identifier": "SID",
				"description": "SenseID",
				"create_at": "2018-08-15 10:08:12.0",
				"update_at": "2018-08-15 10:08:15.0"
			},
			"device": {
				"id": 31,
				"sn": "SID-5f51f769de2cdc8681e85ad590456516",
				"name": "306 試験機",
				"direction": 0,
				"location": "306",
				"ip": null,
				"status": 2,
				"groups": [{
					"id": 2,
					"name": "Default group",
					"type": 2
				}],
				"active": 1,
				"type_id": 2,
				"description": null,
				"software_version": null,
				"info": null,
				"company_id": 1,
				"group_count": 1,
				"create_at": "2019-03-20 09:50:08.0",
				"update_at": "2019-08-28 08:56:05.0"
			}
		}]
	}
}

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

device_type フィールドの説明

device フィールドの説明

group フィールドの説明

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

2.2.8 リモート構成（一括複数アップデート）(/api/v2/device/update/config/batch)

概要

同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。

現在サポートされているデバイスタイプは、SensePass、SensePassProです。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/update/config/batch

リクエスト方法

POST application/json

リクエストパラメーター

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

リクエスト例

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

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/device/open

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

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

2.2.10 通知の送信 (/api/v3/device/notify) ※開発中機能のためご利用できません

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/notify

リクエスト方法

POST application/json

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

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

リクエスト例

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/ldid

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    " data": " SPS-c725f19ddf7d5d9fabee189c29f10b11"
}

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

レスポンスのフィールド

2.3 デバイスアラートの API

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

概要

デバイスアラートのリストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/alarm/list

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/device/alarm/disarm

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

2.4 登録者の API

2.4.1 従業員の追加 (/api/v1/user)

概要

従業員を追加します。

リクエストアドレスの例

https://HOST:PORT/api/v1/user

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

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

{
    "code": 30002,
    "message": "Similar User Exist",
    "data": {
        "similar_user_id": 65833,
        "similar_user_name": "11111111",
        "similar_user_avatar": "5cbe7dec35060d0001750f15",
        "can_force": 0
    },
    "desc": "ex.similar-user"
}

レスポンスのフィールド

group フィールドの説明

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

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

概要

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

バージョン v1 から、従業員ID、IC カード番号、および空の ID 番号の処理ロジックが改善されました。パラメーターが渡されなかった場合や、パラメーターが null の場合、変更は行われません。空の string (””）が渡された場合は、空として設定されます。バージョン v1 のインターフェースは、引き続きご利用いただくことができます。

リクエストアドレスの例

https://HOST:PORT/api/v2/user/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

group フィールドの説明

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

従業員を削除します。

リクエストアドレスの例

https://HOST:PORT/api/v1/user/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

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

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

概要

ビジターを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v1/guest

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v1/guest/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

ビジターを削除します。

リクエストアドレスの例

https://HOST:PORT/api/v1/guest/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

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

2.4.7 ブラックリストの追加 (/api/v2/black)

概要

ブラックリストを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 66865,
        "name": "張三",
        "avatar": "5d084f23b2814100015ad03c",
        "mobile": "13655588555",
        "mail": "1365558@mail.com",
        "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"
    }
}

レスポンスのフィールド

group フィールドの説明

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

2.4.8 ブラックリストへの移動 (/api/v2/black/move/in)

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v2/black/move/in

リクエスト方法

POST application/json

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

2.4.9 ブラックリストからの削除 (/api/v2/black/move/out)

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/black/move/out

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

2.4.10 ブラックリストの変更 (/api/v2/black/update)

概要

ブラックリストの情報を変更します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black/update

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールド

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

2.4.11 ブラックリストの削除 (/api/v2/black/delete/{id})

概要

ブラックリストを削除します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/user/list

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

2.5 登録者グループの API

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

概要

グループを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v1/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"
    }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/group

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/group/user

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": [
        1014,
        1241,
        2896,
        5124,
        5125,
        5126,
        5127
    ]
}

レスポンスのフィールド

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/group/update

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {
 "id": 253,
 "name": "zml2",
 "type": 1,
 "devices": [{
 "id": 268,
 "name": "q",
 "type": 0
 }],
 "is_default": 0
 }
}

レスポンスのフィールド

dataフィールドの説明

device フィールドの説明

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

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

概要

グループを削除します。

リクエストアドレスの例

http://HOST:PORT/api/v1/group/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

http://HOST:PORT/api/v1/user/add/group

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

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

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

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

概要

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

リクエストアドレスの例

http://HOST:PORT/api/v1/user/remove/group

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK"
}

レスポンスのフィールド

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

2.6 QRコードの API

2.6.1 QRコードコンテンツの生成 (/api/v3/qr/content)

概要

QR コードコンテンツを生成します。

※開発中の機能です。ご利用いただけません。

リクエストアドレスの例

https://HOST:PORT/api/v3/qr/content

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

2.7 アクセスルールAPI

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable

リクエスト方法

POST application/json

リクエストパラメーター

Time フィールドの説明

Special_day フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/update

リクエスト方法

POST application/json

リクエストパラメーター

time フィールドの説明

special_day フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/devices/passrules

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

timetableGroup フィールドの説明

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

2.8 レコードの API

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/record/list

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

2.9 認証用顔写真の API

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/recognition/check

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "face_number": 4
}

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/recognition/quality

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "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 の説明

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

2.10 部署の API

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

department フィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/department/search/code

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/department/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/department

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/department/update

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

部署を削除します。

リクエストアドレスの例

https://HOST:PORT/api/v2/department/delete

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

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

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

2.11.1 イベントサブスクリプションPushプロトコル

概要

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

イベントをサブスクライブする外部システムのサーバーアドレスは、SenseLinkのWeb UIのナビゲーションメニュー[System Management]>[Open Platform] 内の Subscription Services Status欄か、本マニュアル内のAPIで設定および更新することができます。

再Push方法

イベントがされてから 5 秒以内にサードパーティーからの応答が受信されなかった場合、または 200 以外のリターンコードが返ってきた場合、Pushに失敗したと見なされ、SenseLink はPushを再試行します。

Pushに失敗すると、サードパーティーサービスは異常と見なされ、イベントサブスクリプションサービスのステータスは「異常」に設定され、その後のPushはすべて停止します。

最近のイベントのPush結果はSenseLinkのWeb UIのナビゲーションメニュー[System Management]>[Open Platform] 内の Subscription Services Status欄にあるDetailで表示できます。

受信タイプ

POST application/json

イベントPushの例

認証レコード :

デバイスアラート :

受信するイベントパラメーター

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

group フィールドの説明

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

通常のレスポンス

レスポンスのフィールド

2.11.2 サブスクリプションの更新 (/api/v3/event/updateSub)

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/event/updateSub

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/event/stopSub

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

2.11.4 サブスクリプションの詳細表示 (/api/v3/event/viewSub)

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/event/viewSub

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/event/viewLog

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/event/sendTest

リクエスト方法

GET

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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

3 Push通知

Websocketプロトコルを利用したPush通知機能について記載されています。

デバイスの認証レコードやデバイスのアラートをPushするには、websocket プロトコルを利用します。

注記 :本Push通知はSenseLink GE V1.10.7を利用していたユーザー向けの機能です。 SenseLink GE V2.2.0以降では標準としてイベントサブスクリプションがサポート、利用が推奨されています。

接続アドレス :

ws://HOST:9000/websocket/record/{app_key}/{timestamp}/{sign}

接続パラメーター :

メッセージ本体 :

code:30000 認証レコード

code:30100 アラートレコード

3.1.1 認証レコードのPush

概要

すべてのデバイスの認証レコードPushをリアルタイムで受信します (WebSocket)。

code=30000

メッセージ本体データ

group フィールドの説明

例

接続成功 :

接続失敗 :

ハートビート検知 :

メッセージPush本体 :

3.1.2 アラートレコードのPush

概要

すべてのデバイスのアラートレコードのPush (WebSocket) を受信します。

code=30100

メッセージ本体データ

例

接続成功 :

接続失敗 :

ハートビート検知 :

メッセージPush本体 :

2.2 デバイスの API

2.2.1 ゲートウェイの追加 (/api/v3/gateway/add) ※開発中機能のためご利用できません

概要

ゲートウェイデバイスを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/add

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"id": 1561,
		"name": "SNB",
		"location": "306",
		"direction": 0,
		"description":"",
		"ldid": "SNB-2ee63f9c699a7316a3e2a44646d0c844",
		"type_id": 10,
		"type_name": "SNB",
		"update_at": 1574854584,
		"create_at": 1574670842
	}
}

レスポンスのフィールド

dataフィールドの説明

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

2.2.2 カメラの追加 (/api/v3/camera/add) ※開発中機能のためご利用できません

概要

カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/add

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 1562,
 "name": "40F",
 "location": "40F",
 "description": "",
 "direction": 0,
 "ldid": "CAM-b054ac85cb84137b75abaa2bd7fc4a38",
 "type_id": 11,
 "type_name": "CAM",
 "update_at": 1574851340,
 "create_at": 1574851340
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/update

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

dataフィールドの説明

group フィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

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

2.2.5 サブカメラのリストの取得 (/api/v3/gateway/cameraList) ※開発中機能のためご利用できません

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/cameraList

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

dataフィールドの説明

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

2.2.6 親デバイスの取得 (/api/v3/camera/gatewayList) ※開発中機能のためご利用できません

概要

関連する親デバイスを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/gatewayList

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "id":1561,
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "name": "306",
        "location": "306",
        "host": "172.20.4.110",
        "port": 80,
        "cameras": [{
            "id":1562,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 1,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
            "camera_name": "1"
        }, {
            "id":1563,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 2,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
            "camera_name": "2"
        }]
    }
}

レスポンスのフィールド

dataフィールドの説明

cameraフィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/device

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"total": 406,
		"pageNum": 1,
		"size": 20,
		"pageSize": 20,
		"totalPage": 21,
		"data": [{
			"device_type": {
			  "id": 2,
				"name": "SenseID",
				"identifier": "SID",
				"description": "SenseID",
				"create_at": "2018-08-15 10:08:12.0",
				"update_at": "2018-08-15 10:08:15.0"
			},
			"device": {
				"id": 31,
				"sn": "SID-5f51f769de2cdc8681e85ad590456516",
				"name": "306 試験機",
				"direction": 0,
				"location": "306",
				"ip": null,
				"status": 2,
				"groups": [{
					"id": 2,
					"name": "Default group",
					"type": 2
				}],
				"active": 1,
				"type_id": 2,
				"description": null,
				"software_version": null,
				"info": null,
				"company_id": 1,
				"group_count": 1,
				"create_at": "2019-03-20 09:50:08.0",
				"update_at": "2019-08-28 08:56:05.0"
			}
		}]
	}
}

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

device_type フィールドの説明

device フィールドの説明

group フィールドの説明

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

2.2.8 リモート構成（一括複数アップデート）(/api/v2/device/update/config/batch)

概要

同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。

現在サポートされているデバイスタイプは、SensePass、SensePassProです。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/update/config/batch

リクエスト方法

POST application/json

リクエストパラメーター

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

リクエスト例

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

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/device/open

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

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

2.2.10 通知の送信 (/api/v3/device/notify) ※開発中機能のためご利用できません

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/notify

リクエスト方法

POST application/json

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

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

リクエスト例

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v3/device/ldid

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    " data": " SPS-c725f19ddf7d5d9fabee189c29f10b11"
}

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

レスポンスのフィールド

2.4 登録者の API

2.4.1 従業員の追加 (/api/v1/user)

概要

従業員を追加します。

リクエストアドレスの例

https://HOST:PORT/api/v1/user

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

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

{
    "code": 30002,
    "message": "Similar User Exist",
    "data": {
        "similar_user_id": 65833,
        "similar_user_name": "11111111",
        "similar_user_avatar": "5cbe7dec35060d0001750f15",
        "can_force": 0
    },
    "desc": "ex.similar-user"
}

レスポンスのフィールド

group フィールドの説明

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/user/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

group フィールドの説明

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

従業員を削除します。

リクエストアドレスの例

https://HOST:PORT/api/v1/user/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

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

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

概要

ビジターを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v1/guest

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

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

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

リクエストアドレスの例

https://HOST:PORT/api/v1/guest/update/{id}

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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

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

概要

ビジターを削除します。

リクエストアドレスの例

https://HOST:PORT/api/v1/guest/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

レスポンスのフィールド

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

2.4.7 ブラックリストの追加 (/api/v2/black)

概要

ブラックリストを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "data": {
        "id": 66865,
        "name": "張三",
        "avatar": "5d084f23b2814100015ad03c",
        "mobile": "13655588555",
        "mail": "1365558@mail.com",
        "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"
    }
}

レスポンスのフィールド

group フィールドの説明

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

2.4.8 ブラックリストへの移動 (/api/v2/black/move/in)

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/black/move/in

リクエスト方法

POST application/json

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

2.4.9 ブラックリストからの削除 (/api/v2/black/move/out)

概要

リクエストアドレスの例

https://HOST:PORT/api/v2/black/move/out

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

2.4.10 ブラックリストの変更 (/api/v2/black/update)

概要

ブラックリストの情報を変更します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black/update

リクエスト方法

POST: form-data

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールド

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

2.4.11 ブラックリストの削除 (/api/v2/black/delete/{id})

概要

ブラックリストを削除します。

リクエストアドレスの例

https://HOST:PORT/api/v2/black/delete/{id}

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
}

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

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

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v1/user/list

リクエスト方法

GET

リクエストパラメーター

通常のレスポンス

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

レスポンスのフィールド

group フィールドの説明

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