SPLATS API

概要

このドキュメントではSPLATS APIの仕様について説明します。

データ形式

SPLATS APIでは、リクエストボディ、レスポンスともにJSONを利用します。

Content-Type:application/json; charset=utf-8

日時形式

SPLATS APIでは、日時を表現する場合にISO 8601 拡張形式の下記文字列を利用します。ただし、日本国内での利用のみを想定していますので、タイムゾーンは +09:00 固定で指定してください。

YYYY-MM-DDThh:mm:ss+09:00

APIのエラーレスポンスについて

エラーが発生した場合、エラーコード「error_code」と、その詳細「error_detail」を含むレスポンスを返します。

エラーレスポンスフォーマット

{
    "message": <エラーメッセージ>,
    "error_code": <エラーコード>,
    "error_detail": <エラー内容詳細>
}

エラーレスポンス例

{
    "message": "Bad Request",
    "error_code": "40002",
    "error_detail": "リクエストパラメーターが不正です。"
}

リクエスト制限

SPLATS APIは発行したアクセストークンに対して、60分間に受付可能なリクエスト回数を制限します。
この制限は、リクエスト種別ごとに異なります。

リクエスト種別	60分あたりのリクエスト回数
デバイス状態取得API	180
上記を除くその他API	720

リクエスト回数が上限を超えた場合、429（Too many requests）が返され、制限リセットまでリクエストを行うことができなくなります。
レスポンスには、リクエスト制限の情報を表す以下のヘッダーが含まれます。

ヘッダー名	説明
X-Rate-Limit-Limit	期間内(60分)でリクエストできる最大回数
X-Rate-Limit-Remaining	期間内(60分)でリクエストできる残り回数
X-Rate-Limit-Reset	制限がリセットされるまでの秒数（制限がかかっている場合のみ）

テナント

テナント名、休日設定の取得、webhook設定の取得/更新ができます。

テナント取得

リクエストするには「テナント」の「参照」権限が必要です。

テナント情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

Responses

Response samples

200

Content type

application/json

{"tenant_id": "string",
"tenant_name": "string",
"settings": {"holiday": {"is_include_public_holiday": true,
"public_holiday": {"yyyy-mm-dd": "string"
},
"include_date": {"yyyy-mm-dd": "string"
},
"exclude_date": {"yyyy-mm-dd": "string"
},
"weekly": ["Sunday"
]
},
"webhook": {"is_invalid": true,
"url": "string",
"secret_token": "string",
"trigger": {"history": {"category": ["normal"
]
}
}
}
}
}

Webhook設定更新

リクエストするには「テナント」の「更新」権限が必要です。

Webhook設定を更新します。
・リクエストで指定しなかったKEY（項目）は更新されません。

Authorizations:

SplatsApiAccessTokenAuthorizer

Request Body schema: application/json

is_invalid required	boolean 有効無効フラグ true:無効中(Webhookによる通知を一時的に無効にする) false:無効中でない
url required	string Webhookの通知先URL
secret_token	string or null <= 64 characters リクエストの署名を使用する場合に使用します。シークレットトークンと Webhook のリクエストボディを使って計算された HMAC-SHA256をリクエストヘッダーに付与します。
required	object 通知条件

Responses

Request samples

Payload

Content type

application/json

{"is_invalid": true,
"url": "string",
"secret_token": "string",
"trigger": {"history": {"category": ["normal"
]
}
}
}

Response samples

200

Content type

application/json

{ }

Webhook設定削除

リクエストするには「テナント」の「更新」権限が必要です。

Webhook設定を削除します。

Authorizations:

SplatsApiAccessTokenAuthorizer

Responses

Response samples

204

Content type

application/json

{ }

メンバー

メンバー情報を取得/更新できます。

メンバー取得(全体)

リクエストするには「メンバー」の「参照」権限が必要です。

テナント内の全メンバー情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

query Parameters

limit	integer [ 1 .. 1000 ] Default: 100 １回のリクエストにて返されるデータ件数を指定する。
last_evaluated_key	string 取り切れない情報があった場合に続きのデータを取るためのID
fields	string Example: fields=card_data 指定した項目をレスポンスに追加する。以下の項目から指定可能。 member_code, card_data, qrcode,face_data,use_date_start,use_date_end

Responses

Response samples

200

Content type

application/json

{"last_evaluated_key": "string",
"members": [{"member_id": "string",
"member_name": "string",
"member_code": "string",
"card_data": "string",
"qrcode": {"data": "string",
"email": "string"
},
"face_data": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00"
}
]
}

メンバー登録

リクエストするには「メンバー」の「更新」権限が必要です。

メンバー新規登録します。

カードデータに英字を含める場合、必ず大文字にしてください。小文字が含まれる場合、エラーとなります。

Authorizations:

SplatsApiAccessTokenAuthorizer

Request Body schema: application/json

member_name required	string [ 1 .. 40 ] characters メンバー名（40文字以下）半角全角関わらず40文字まで設定できます
member_code	string <= 20 characters メンバーコード（半角英数20文字以下）
membergroup_id required	string メンバーグループID
card_data	string <= 16 characters カードデータ（0～9 A～Fのみ、16文字以下）
	object QRコード情報 ※ご利用にはQRオプションの契約が必要です。
use_date_start	string <date-time> 利用開始日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）指定がない場合は設定なしとします。指定した利用開始日時より前は認証操作やメンバーサイトの利用ができなくなります。メンバーサイトで時刻は表示されません。(メンバーサイトで設定した場合、時刻は00:00:00+09:00で設定されます。)
use_date_end	string <date-time> 利用終了日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）指定がない場合は設定なしとします。指定した利用終了日時より後は認証操作やメンバーサイトの利用ができなくなります。メンバーサイトで時刻は表示されません。(メンバーサイトで設定した場合、時刻は23:59:59+09:00で設定されます。)
	all_areas (object) or option (object) (DevicesPass) 入退室権限情報
	all_device (object) or option (object) (KeysPass) カギ利用権限情報

Responses

Request samples

Payload

Content type

application/json

{"member_name": "string",
"member_code": "string",
"membergroup_id": "string",
"card_data": "string",
"qrcode": {"data": "string",
"email": "string"
},
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"devices_pass": {"default_mode": "allow_all"
},
"keys_pass": {"default_mode": "allow_all"
}
}

Response samples

201

Content type

application/json

{"member_id": "string",
"member_name": "string"
}

メンバー取得(個別)

リクエストするには「メンバー」の「参照」権限が必要です。

指定したメンバーIDのメンバー情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Responses

Response samples

200

Content type

application/json

{"member_id": "string",
"member_name": "string",
"member_code": "string",
"profile_image_url": "string",
"membergroup_id": "string",
"account_type": "admin",
"card_data": "string",
"qrcode": {"data": "string",
"email": "string"
},
"face_data": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"devices_pass": {"default_mode": "allow_all"
},
"keys_pass": {"default_mode": "allow_all"
}
}

メンバー更新

リクエストするには「メンバー」の「更新」権限が必要です。

メンバー情報
・リクエストで指定しなかったKEY（項目）は更新されません。

カードデータに英字を含める場合、必ず大文字にしてください。小文字が含まれる場合、エラーとなります。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Request Body schema: application/json

member_name	string [ 1 .. 40 ] characters メンバー名（40文字以下）半角全角関わらず40文字まで設定できます
member_code	string <= 20 characters メンバーコード（半角英数20文字以下）
membergroup_id	string メンバーグループID
card_data	string <= 16 characters カードデータ（0～9 A～Fのみ、16文字以下）
	QRコード情報追加/更新 (object) or QRコード情報削除 (object) QRコード情報 ※ご利用にはQRオプションの契約が必要です。
use_date_start	string or null <date-time> 利用開始日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"） nullを指定した場合は設定なしにします。指定した利用開始日時より前は認証操作やメンバーサイトの利用ができなくなります。メンバーサイトで時刻は表示されません。(メンバーサイトで設定した場合、時刻は00:00:00+09:00で設定されます。)
use_date_end	string or null <date-time> 利用終了日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"） nullを指定した場合は設定なしにします。指定した利用終了日時より後は認証操作やメンバーサイトの利用ができなくなります。メンバーサイトで時刻は表示されません。(メンバーサイトで設定した場合、時刻は23:59:59+09:00で設定されます。)
	all_areas (object) or option (object) (DevicesPass) 入退室権限情報
	all_device (object) or option (object) (KeysPass) カギ利用権限情報

Responses

Request samples

Payload

Content type

application/json

{"member_name": "string",
"member_code": "string",
"membergroup_id": "string",
"card_data": "string",
"qrcode": {"data": "string",
"email": "string"
},
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"devices_pass": {"default_mode": "allow_all"
},
"keys_pass": {"default_mode": "allow_all"
}
}

Response samples

200

Content type

application/json

{"member_id": "string",
"member_name": "string"
}

メンバー削除

リクエストするには「メンバー」の「更新」権限が必要です。

メンバー情報を削除します。

アカウントタイプが「管理者」のメンバーは削除できません。
※ アカウントタイプは「メンバー取得(個別)」で確認できます。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Responses

Response samples

204

Content type

application/json

{ }

メンバープロフィール画像登録

リクエストするには「メンバー」の「更新」権限が必要です。

指定したメンバーIDのプロフィール画像を登録します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Request Body schema:
image/jpeg

画像ファイル

ファイルサイズは最大300KBです。

画像サイズは300×300ピクセル程度を推奨します。

画像の縦横比が1:1でない場合、メンバーサイトで表示する際正しく表示されない場合があります。

Request Body が空の場合、登録済みのプロフィール画像を削除します。

string <binary>

Responses

Response samples

200

Content type

application/json

{"member_id": "string",
"profile_image_url": "string"
}

メンバー顔認証用顔画像登録

リクエストするには「メンバー」の「更新」権限が必要です。

顔認証用顔画像を登録します。登録結果は「リクエスト結果取得」で取得してください。
※ご利用には顔認証オプションの契約が必要です。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Request Body schema: image/jpeg

顔画像について

顔画像は縦長の写真を推奨しています。顔画像を1200×1600にリサイズして送信してください。

リサイズする前の顔画像が高解像度なほど認証精度が高くなります。

顔画像の最大サイズは2MBです。

string <binary>

Responses

Response samples

202

Content type

application/json

{"request_id": "string",
"request_type": "string"
}

メンバー顔認証用顔画像削除

リクエストするには「メンバー」の「更新」権限が必要です。

顔認証用顔画像を削除します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Responses

Response samples

204

Content type

application/json

{ }

一時利用許可

リクエストするには「メンバー」の「更新」権限が必要です。
SPLATS KEYでのみご利用いただけます。

指定したメンバーが、利用制限のあるデバイスを一時的に利用できるようになります。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

member_id

required

string

メンバーID

Request Body schema: application/json

target required	string Value: "key" 一時利用を行う対象のタイプ key：カギ
timer required	integer [ 0 .. 86400 ] 一時的に利用できる時間[秒] APIを受け取ってから指定した時間だけ一時的に利用できるようになります。
	Array of objects <= 100 items 一時利用許可を行うデバイスのリスト ※ 未指定の場合は、targetで指定したタイプの全てのデバイスを対象とします。
device_action	boolean 情報が反映されたときにデバイスから音とLEDで知らせるかを指定します。 true：通知音が鳴り、LEDが１回点灯します false / 未指定：なし
info	string <= 100 characters ログに残す補足情報（全角100文字以下）任意の文字列を加えてログに残すことができます。「メンバー設定　{メンバー名}に一時利用許可({補足情報})」

Responses

Request samples

Payload

Content type

application/json

{"target": "key",
"timer": 0,
"targets_list": [{"device_id": "string",
"unit_no_list": ["01",
"02",
"03"
]
}
],
"device_action": true,
"info": "string"
}

Response samples

200

Content type

application/json

{"sent_device_id_list": ["string"
]
}

メンバーグループ

メンバーグループ情報を取得/更新できます。

メンバーグループ取得(全体)

リクエストするには「メンバーグループ」の「参照」権限が必要です。

テナント内の全メンバーグループ情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

query Parameters

limit	integer [ 1 .. 1000 ] Default: 100 １回のリクエストで取得できるデータ件数を指定する。
last_evaluated_key	string 取り切れない情報があった場合に続きのデータを取るためのID

Responses

Response samples

200

Content type

application/json

{"last_evaluated_key": "string",
"membergroups": [{"membergroup_id": "string",
"membergroup_name": "string",
"member_count": 0
}
]
}

メンバーグループ登録

リクエストするには「メンバーグループ」の「更新」権限が必要です。

メンバーグループの新規登録を行います。

Authorizations:

SplatsApiAccessTokenAuthorizer

Request Body schema: application/json

membergroup_name

required

string [ 1 .. 40 ] characters

メンバーグループ名（40文字以下）
半角全角関わらず40文字まで設定できます

Responses

Request samples

Payload

Content type

application/json

{"membergroup_name": "string"
}

Response samples

201

Content type

application/json

{"membergroup_id": "string",
"membergroup_name": "string"
}

メンバーグループ取得(個別)

リクエストするには「メンバーグループ」の「参照」権限が必要です。

メンバーグループIDで指定したメンバーグループ情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

membergroup_id

required

string

メンバーグループID

Responses

Response samples

200

Content type

application/json

{"membergroup_id": "string",
"membergroup_name": "string"
}

メンバーグループ更新

リクエストするには「メンバーグループ」の「更新」権限が必要です。

メンバーグループ情報を更新します。
・リクエストで指定しなかったKEY（項目）は更新されません。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

membergroup_id

required

string

メンバーグループID

Request Body schema: application/json

membergroup_name

required

string [ 1 .. 40 ] characters

メンバーグループ名（40文字以下）
半角全角関わらず40文字まで設定できます

Responses

Request samples

Payload

Content type

application/json

{"membergroup_name": "string"
}

Response samples

200

Content type

application/json

{"membergroup_id": "string",
"membergroup_name": "string"
}

メンバーグループ削除

リクエストするには「メンバーグループ」の「更新」権限が必要です。

メンバーグループ情報を削除します。
※ メンバーグループにメンバーが所属している場合や、メンバーグループが1つの場合、削除に失敗します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

membergroup_id

required

string

メンバーグループID

Responses

Response samples

204

Content type

application/json

{ }

ゲスト

ゲスト情報を取得/更新できます。
利用するにはQRオプションの契約が必要です。

ゲスト取得(全体)

リクエストするには「ゲスト」の「参照」権限が必要です。

テナント内の全ゲスト情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

query Parameters

limit	integer [ 1 .. 1000 ] Default: 100 １回のリクエストで取得できるデータ件数を指定する。
last_evaluated_key	string 取り切れない情報があった場合に続きのデータを取るためのID
fields	string Default: "guest_id, guest_name" Example: fields=use_date_start, use_date_end 指定した項目をレスポンスに追加する。以下の項目から指定可能。 email, use_date_start, use_date_end, key_return_date_end, is_for_reserve

Responses

Response samples

200

Content type

application/json

{"last_evaluated_key": "string",
"guests": [{"guest_id": "string",
"guest_name": "string",
"email": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"key_return_date_end": "2019-08-24T14:15:22+09:00",
"is_for_reserve": true
}
]
}

ゲスト登録

リクエストするには「ゲスト」の「更新」権限が必要です。

ゲストの新規登録を行います。

使用できるメールアドレスでも、SPLATS APIでは登録できない場合があります。
この場合、お手数ですがSPLATSメンバーサイトをご利用ください。

Authorizations:

SplatsApiAccessTokenAuthorizer

Request Body schema: application/json

guest_name required	string [ 1 .. 40 ] characters ゲスト名（40文字以下）半角全角関わらず40文字まで設定できます
use_date_start required	string <date-time> 利用開始日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）
use_date_end required	string <date-time> 利用終了日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）・利用終了日時の１週間後にゲストは自動で削除されます・利用開始日時より後の日時を指定してください。
return_grace_period	integer [ 0 .. 10080 ] カギの返却猶予時間（分）・利用終了日時から指定した時間までカギの返却ができます・猶予時間の間はカギの取り出しはできません・未指定の場合は利用終了日時と同じ日時になります
required	自動発行 (object) or 直接入力 (object) QRコード発行方法
area_id_list	Array of strings <= 100 items unique 入室できるエリア(エリアIDのリスト)
	Array of objects <= 100 items 利用できるカギ(キーボックス情報のリスト)

Responses

Request samples

Payload

Content type

application/json

{"guest_name": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"return_grace_period": 0,
"qrcode_issuing_method": {"email": "string",
"remarks": "string"
},
"area_id_list": ["string"
],
"key_devices_list": [{"key_device_id": "string",
"units_no_list": ["st"
]
}
]
}

Response samples

201

Content type

application/json

{"guest_id": "string",
"guest_name": "string"
}

ゲスト取得(個別)

リクエストするには「ゲスト」の「参照」権限が必要です。

指定したゲストIDのゲスト情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

guest_id

required

string

ゲストID

Responses

Response samples

200

Content type

application/json

{"guest_id": "string",
"guest_name": "string",
"email": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"key_return_date_end": "2019-08-24T14:15:22+09:00",
"qrcode_data": "string",
"devices_pass": {"default_mode": "allow_all"
},
"keys_pass": {"default_mode": "allow_all"
},
"remarks": "string",
"is_for_reserve": true
}

ゲスト更新

リクエストするには「ゲスト」の「更新」権限が必要です。

ゲスト情報を更新します。

リクエストで指定しなかったKEY（項目）は更新されません。
使用できるメールアドレスでも、SPLATS APIでは登録できない場合があります。
この場合、お手数ですがSPLATSメンバーサイトをご利用ください。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

guest_id

required

string

ゲストID

Request Body schema: application/json

guest_name	string [ 1 .. 40 ] characters ゲスト名（40文字以下）半角全角関わらず40文字まで設定できます
email	string <= 254 characters メールアドレス
use_date_start	string <date-time> 利用開始日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）
use_date_end	string <date-time> 利用終了日時（ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"）・利用終了日時の１週間後にゲストは自動で削除されます・利用開始日時より後の日時を指定してください。
return_grace_period	integer [ 0 .. 10080 ] カギの返却猶予時間（分）・利用終了日時から指定した時間までカギの返却ができます・猶予時間の間はカギの取り出しはできません・未指定の場合は利用終了日時と同じ日時になります
qrcode_data	string <= 557 characters QRコードデータ（半角557文字、または全角235文字以下）
area_id_list	Array of strings <= 100 items unique 入室できるエリア(エリアIDのリスト)
	Array of objects <= 100 items 利用できるカギ(キーボックス情報のリスト)
remarks	string <= 200 characters SPLATSからメールを送信する際に、メールに追記するメッセージ

Responses

Request samples

Payload

Content type

application/json

{"guest_name": "string",
"email": "string",
"use_date_start": "2019-08-24T14:15:22+09:00",
"use_date_end": "2019-08-24T14:15:22+09:00",
"return_grace_period": 0,
"qrcode_data": "string",
"area_id_list": ["string"
],
"key_devices_list": [{"key_device_id": "string",
"units_no_list": ["st"
]
}
],
"remarks": "string"
}

Response samples

200

Content type

application/json

{"guest_id": "string",
"guest_name": "string"
}

ゲスト削除

リクエストするには「ゲスト」の「更新」権限が必要です。

ゲスト情報を削除します。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

guest_id

required

string

ゲストID

Responses

Response samples

204

Content type

application/json

{ }

QRコード再発行

リクエストするには「ゲスト」の「更新」権限が必要です。

新しいQRコードを、登録されているメールアドレスに送信します。

指定したゲストにメールアドレスが設定されていない場合、エラーになります。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

guest_id

required

string

ゲストID

Responses

ログ

ログ情報を取得できます。

ログ取得(１年以内の全ログ)

リクエストするには「ログ」の「参照」権限が必要です。

テナント内のログ情報を取得します。1年前までの全ログ情報を取得できます。

Authorizations:

SplatsApiAccessTokenAuthorizer

query Parameters

limit	integer [ 1 .. 1000 ] Default: 100 １回のリクエストで取得できるデータ件数を指定する。
offset	integer [ 0 .. 1000 ] Default: 0 取得したデータの中で、先頭から「offset」で指定された件数のデータは返さない。
since	string 指定された日時以降のデータを取得する。 ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"
until	string 指定された日時以前のデータを取得する。 ISO 8601 拡張形式 "YYYY-MM-DDThh:mm:ss+09:00"
sort	string Default: "desc" Enum: "asc" "desc" asc:日時を昇順で並び変え　desc:日時を降順で並び変え
fields	string Default: "history_id,datetime,status,category,_content,member,device" 指定した項目のみを取得する。以下の項目から指定可能。 history_id,datetime,status,category,_content,member,device,video

Responses

Response samples

200

Content type

application/json

{"histories": [{"datetime": "2019-08-24T14:15:22+09:00",
"status": "string",
"category": "string",
"_content": "string",
"member": {"id": "string",
"name": "string",
"_type": "string",
"data": "string",
"label": "string",
"attribute": "string"
},
"device": {"id": "string",
"name": "string",
"module": "string",
"units": [{"unit_no": "string",
"unit_name": "string"
}
]
}
}
]
}

エリア

エリア情報を取得できます。

エリア取得(全体)

リクエストするには「エリア」の「参照」権限が必要です。

テナント内の全エリア情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

Responses

Response samples

200

Content type

application/json

{"areas": [{"area_id": "string",
"area_name": "string",
"is_outside": true,
"is_management": true,
"devices_list": [{"device_id": "string",
"in_out": "in"
}
]
}
]
}

デバイス

デバイス情報、デバイス状態を取得できます。

パスコントローラー情報取得(全体)

リクエストするには「デバイス」の「参照」権限が必要です。

テナント内の全パスコントローラー情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

Responses

Response samples

200

Content type

application/json

{"devices": [{"device_id": "string",
"device_name": "string"
}
]
}

パスコントローラー状態取得

リクエストするには「デバイス」の「参照」権限が必要です。

指定したパスコントローラーの状態を取得します。

60分間に受付可能なリクエストが180回となっています。
詳細はリクエスト制限をご確認ください。
対象パスコントローラーの電源がONでデバイス-クラウド間が接続中の場合にドア状態をレスポンスします。
デバイス-クラウド間の接続状態にて、接続が切れてから未接続と判定されるまでに5分程度の差が生じます。
その間はドア状態/電源状態が更新されません。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

device_id

required

string

パスコントローラーのデバイスID

Responses

Response samples

200

Content type

application/json

{"device_id": "string",
"device_name": "string",
"door_status": {"door": "open",
"lock": "unlock",
"errors": ["unlock_error"
]
},
"power_status": "running",
"cloud_com_status": "connected",
"sync_status": "string"
}

キーボックス情報取得(全体)

リクエストするには「デバイス」の「参照」権限が必要です。

テナント内の全キーボックス情報を取得します。

Authorizations:

SplatsApiAccessTokenAuthorizer

Responses

Response samples

200

Content type

application/json

{"key_devices": [{"key_device_id": "string",
"key_device_name": "string",
"product_type": "SL-KB",
"number_of_management": 0,
"units": [{"unit_no": "string",
"unit_name": "string",
"restriction": true
}
]
}
]
}

キーボックス状態取得

リクエストするには「デバイス」の「参照」権限が必要です。

指定したキーボックスの状態を取得します。

60分間に受付可能なリクエストが180回となっています。
詳細はリクエスト制限をご確認ください。
対象キーボックスの電源がONでデバイス-クラウド間が接続中の場合に扉状態/カギ状態をレスポンスします。
デバイス-クラウド間の接続状態にて、接続が切れてから未接続と判定されるまでに5分程度の差が生じます。
その間は扉状態/カギ状態/電源状態が更新されません。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

key_device_id

required

string

キーボックスのデバイスID

Responses

Response samples

200

Content type

application/json

{"key_device_id": "string",
"key_device_name": "string",
"product_type": "SL-KB",
"door_status": {"door": "open",
"lock": "unlock",
"errors": ["door_unlock_error"
]
},
"units_status": [{"unit_no": "string",
"door": "open",
"key": "return",
"lock": "unlock",
"errors": ["key_unlock_error"
]
}
],
"power_status": "running",
"cloud_com_status": "connected",
"sync_status": "string"
}

カメラ

ログ発生時の映像を取得できます。
利用するにはカメラオプションの契約が必要です。

ログ発生時の映像取得

リクエストするには「カメラ」の「参照」権限が必要です。

指定されたログに関連する映像のダウンロード用URLを作成します。
※90日より前に発生したログの映像は取得できません。
※ログが発生してから映像が取得できるまでに時間がかかる場合があります。
　その場合は時間をあけてもう一度実行してください。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

history_id

required

string

ログID

Responses

Response samples

200

Content type

application/json

{"camera_name": "string",
"video_url": "string"
}

リクエスト

リクエスト状態を取得できます。

リクエスト結果取得

リクエストするための権限は必要ありません。

指定したリクエストIDのリクエスト情報を取得します。
メンバー顔認証用顔画像登録APIなど非同期で処理するAPIリクエスト時に発行されたリクエストIDを指定してください。

Authorizations:

SplatsApiAccessTokenAuthorizer

path Parameters

request_id

required

string

リクエストID

Responses

Response samples

200

Content type

application/json

{"request_id": "string",
"request_type": "string",
"status": "string"
}

SPLATS API

概要

データ形式

日時形式

APIのエラーレスポンスについて

リクエスト制限

テナント

テナント取得

Authorizations:

Responses

Response samples

Webhook設定更新

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Webhook設定削除

Authorizations:

Responses

Response samples

メンバー

メンバー取得(全体)

Authorizations:

query Parameters

Responses

Response samples

メンバー登録

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

メンバー取得(個別)

Authorizations:

path Parameters

Responses

Response samples

メンバー更新

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

メンバー削除

Authorizations:

path Parameters

Responses

Response samples

メンバープロフィール画像登録

Authorizations:

path Parameters

Request Body schema: image/jpegimage/pngimage/gifimage/jpeg

Responses

Response samples

メンバー顔認証用顔画像登録

Authorizations:

path Parameters

Request Body schema: image/jpeg

Responses

Response samples

メンバー顔認証用顔画像削除

Authorizations:

path Parameters

Responses

Response samples

一時利用許可

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

メンバーグループ

メンバーグループ取得(全体)

Authorizations:

query Parameters

Responses

Response samples

Request Body schema:
image/jpeg