1 / 1

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の例

認証レコード :

{
 
    "data": {
        "companyId": 1,
        "deviceName": "device2",
        "deviceSN": "SPS-23da60ccda8f91a865a7472c1c5d9df5",
        "direction": 1,
        "groupId": 0,
        "groupName": "",
        "id": 2,
        "originAvatar": "",
        "receptionUserId": 0,
        "receptionUserName": "",
        "signAvatar": "5c80cb55bac9be0001d4e93a",
        "signBgAvatar": "5c80cb55bac9be0001d4e93b",
        "signTime": 1551944533,
        "userId": 0,
        "userName": "",
        "userType": 3,
        "verifyScore": 0.0
    },
    "messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
    "eventType": 30100,
    "sendTime": 1569575298240
}

デバイスアラート :

{
    "data": {
        "id": 100,
        "level": 0, 
        "code": 0,
        "description": "",
        "status": 0, 
        "traceId": "", 
        "deviceId": 0, 
        "deviceName": "", 
        "deviceSn": "", 
        "deviceLocation": "", 
        "alarmTime": "", 
        "releaseTime": "", 
        "alarmPhoto": "", 
        "resloveOption": 0
    },
    "messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
    "eventType": 30100,
    "sendTime": 1569575298240
}

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

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

group フィールドの説明

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

通常のレスポンス

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

レスポンスのフィールド

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {
 "event_type_ids": [
 30000,
 30100
 ],
 "event_dest": "https://ip:port/eventRcv",
 "sub_status": 1
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {
 "pushTime": "2019-10-11 00:00:00",
 "status": 200,
 "eventTypeId": 30000,
 "eventMessage": {}
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

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

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

概要

再Push方法

受信タイプ

POST application/json

イベントPushの例

認証レコード :

{
 
    "data": {
        "companyId": 1,
        "deviceName": "device2",
        "deviceSN": "SPS-23da60ccda8f91a865a7472c1c5d9df5",
        "direction": 1,
        "groupId": 0,
        "groupName": "",
        "id": 2,
        "originAvatar": "",
        "receptionUserId": 0,
        "receptionUserName": "",
        "signAvatar": "5c80cb55bac9be0001d4e93a",
        "signBgAvatar": "5c80cb55bac9be0001d4e93b",
        "signTime": 1551944533,
        "userId": 0,
        "userName": "",
        "userType": 3,
        "verifyScore": 0.0
    },
    "messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
    "eventType": 30100,
    "sendTime": 1569575298240
}

デバイスアラート :

{
    "data": {
        "id": 100,
        "level": 0, 
        "code": 0,
        "description": "",
        "status": 0, 
        "traceId": "", 
        "deviceId": 0, 
        "deviceName": "", 
        "deviceSn": "", 
        "deviceLocation": "", 
        "alarmTime": "", 
        "releaseTime": "", 
        "alarmPhoto": "", 
        "resloveOption": 0
    },
    "messageId": "681EC005-B522-4BCF-9C16-75A74307A7B5",
    "eventType": 30100,
    "sendTime": 1569575298240
}

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

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

group フィールドの説明

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

通常のレスポンス

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

レスポンスのフィールド

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST application/json

リクエストパラメーター

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {
 "event_type_ids": [
 30000,
 30100
 ],
 "event_dest": "https://ip:port/eventRcv",
 "sub_status": 1
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "success",
 "desc": "",
 "data": {
 "pushTime": "2019-10-11 00:00:00",
 "status": 200,
 "eventTypeId": 30000,
 "eventMessage": {}
 }
}

レスポンスのフィールド

dataフィールドの説明

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

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

通常のレスポンス

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

レスポンスのフィールド

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