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

レスポンスのフィールド

dataフィールドの説明

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

​

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

概要

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

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": "slqr-614yJpzW8bbvc27UySglfHwpbvG3WQNO"
}

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": {
 "total": 639,
 "data": [{
 "traceId": "SGBD1566376557396gpknft",
 "alarmPhoto": "5d5d026df684640001b260f0",
 "code": 20002,
 "releaseTime": "",
 "level": 2,
 "resloveOption": 0,
 "alarmTime": "2019-08-21 16:35:57",
 "deviceId": 283,
 "deviceName": "SensePassTest",
 "deviceSn": "SGBD-b8b2201baea00d3918c49989838d81c0",
 "alarmTimeL": 1566376557395,
 "id": 378018,
 "deviceLocation": "306.Michael",
 "status": 0
 }],
 "size": 20,
 "totalPage": 32,
 "pageSize": 20,
 "pageNum": 1
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

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

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.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/v2/staff/image_updated）

概要

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

リクエストアドレスの例

https://HOST:PORT/api/v2/staff/image_updated

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

2.4.5 ビジターの追加 (/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.6 ビジター情報の変更 (/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.7 ビジターの削除 (/api/v1/guest/delete/{id})

概要

ビジターを削除します。

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

2.4.8 ブラックリストの追加 (/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.9 ブラックリストへの移動 (/api/v2/black/move/in)

概要

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

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

リクエストアドレスの例

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

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

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

2.4.11 ブラックリストの変更 (/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.12 ブラックリストの削除 (/api/v2/black/delete/{id})

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

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

2.4.13 登録者の参照 (/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.9.1 顔の数の検知 (/api/v1/recognition/check)

概要

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

リクエストアドレスの例

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

リクエスト方法

POST: form-data

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": 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.8.1 認証レコードの表示 (/api/v3/record/list)

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

レスポンスのフィールド

dataフィールドの説明

data.dataフィールドの説明

recordItem フィールドの説明

group フィールドの説明

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

リクエストパラメーター

passRule フィールドの説明

認証パラメーター

通常のレスポンス

レスポンスのフィールド

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.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.1 概要

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

2.11.2 利用の開始

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

サブスクリプションサービス設定画面が表示されます。

イベント処理サーバーアドレスの欄に、連携する外部システムのサーバーアドレスを入力してください。http、httpsをサポートしています。https://またはhttps://から入力してください。

サブスクリプションイベントタイプ欄では、サブスクライブするイベントのタイプを選んでください。デバイスで認証が行われた際に認証レコードをPushで受け取るには認証レコードを、デバイスアラートが発生した場合にPushで受け取るにはデバイスアラートを選択してください。両方を選択することも可能です。

設定が完了したら、保存ボタンをクリックしてください。Open Platform画面に戻ります。 サブスクリプションサービスステータスがNormalと表示されていれば、イベントがサブスクライブされています。

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

サブスクリプションサービスの設定を変更するにはサブスクリプションサービス欄の詳細ボタンをクリックしてください。

サブスクリプションサービスを停止するにはサブスクリプション停止ボタンをクリックしてください。サービスが停止され、外部システムにイベントがPushされなくなります。

サブスクリプションサービスの設定を修正するには、サブスクリプション更新ボタンをクリックしてください。設定内容を変更できます。変更内容を入力後、保存してください。

2.11.4 イベントの再Push

イベントのPush後、外部システムは100秒以内にレスポンスを返却するか、リターンコード200を返却する必要があります。

レスポンスが100秒以内に返却されない場合、またはリターンコードが200以外の場合はエラーとみなされ、SenseLinkはそのイベントを再Pushしません。その後SenseLinkは外部システムのサブスクリプションステータスを「異常」に変更し、エラーログとして保存されます。ただし、その後発生した新しいイベントのPushには影響はありません。

なお、レスポンスが100秒以内に返却された、かつリターンコードが200になった場合、サブスクリプションステータスは「正常」に戻ります。

2.11.5 イベントPushログ

Open Platform画面のサブスクリプションサービスステータス欄の詳細をクリックし、サブスクリプションサービスの設定画面にあるログボタンをクリックすると、最新のイベントPushの結果（以下、「ログ」）を確認することができます。

ログは最大100件まで保存され、100を越えると古いものから順に削除されます。各ログの詳細ボタンをクリックすると認証レコードページまたはデバイスアラートページに遷移し、イベントの詳細を確認することができます。 イベントタイプまたはステータスで、ログを検索することができます。リセットボタンをクリックすると検索による絞り込みがリセットされ、すべてのログが表示されます。

テストイベント送信ボタンをクリックすると、テストイベントを連携中の外部システムにPush することができます。 認証レコードとデバイスアラートが選択されている場合、または認証レコードのみが選択されている場合は認証レコードのテストイベントが送信されます。 デバイスアラートのみが選択されている場合、デバイスアラートのテストイベントが送信されます。

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

リクエスト方法

POST application/json

イベントPushの例

認証レコード :

デバイスアラート :

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

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

group フィールドの説明

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

通常のレスポンス

レスポンスのフィールド

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