Download OpenAPI specification:Download
KEYVOXアクセス管理サービスは、対応するロックやロッカーを導入することで、 宿泊施設、レンタルスペースやコワーキングスペース等の空間管理ビジネスを簡単に始められるソリューションです (サービスサイト https://keyvox.co)。KEYVOX APIはそのような空間管理ビジネスに必要な業務をAPIとして外部に提供することで、ユーザーの予約システム、管理システム、モバイルアプリなどに簡単に接続することを可能にします。 またWebhookを利用することで自社サービス等への解錠/施錠に関する通知も行えます。KEYVOX APIを利用してKEYVOXサービスを更に活用しましょう。
ご質問はDiscordコミュニティまでお寄せください。
※APIコール数には制限があります。
サンプルソースとして、Java、 PHP、JS(Postman用)を提供しています。
Parameter | Description | Example |
x-target-host | default.pms固定 | "default.pms" |
date | Client time. A difference of 5 seconds or more from the server time will deny access | Mon, 29 Oct 2018 13:16:39 GMT |
digest | Sha256 summary of the body part (base64 encoding) | SHA-256=2LJ53DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU= |
authorization | Hmac256 authentication header. Contains 5 parts. | hmac username="an9y4AidwJ3hsxfltlX7XXXXXXfGh", algorithm="hmac-sha256", headers="date request-line digest", signature="Mk0EOHf2ljFkltwPJBBvj5XXXXXNnCBnHs=" |
Authentication header type | "hmac" | |
username | Issued apikey | |
algorithm | Signature method. Fixed to "HMAC-SHA256" | |
headers | The data to be signed is composed. Fixed as "date request-line digest" | |
signature | The value obtained by concatenating the data to be signed into a string in a specific way and then signing the string with apisecret.※ |
WEB管理画面「BACS」で設定したドア(部屋)、ドアに紐づいているスマートロックまたはスマートロッカーの情報を取得します。カギの発行はドア(部屋)に対して行います。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "unitId": "5de092a8ef16f9512c1f1fff",
- "unitName": "1101室",
- "lockIds": "5bdfdd421bca968a774ec18a,5bd80fcd31bca24fc30e1eab",
- "placeName": "内幸町ホテル",
- "unitState": "I",
- "unitType": "シングル",
- "placeType": "facility"
}
]
}
WEB管理画面「BACS」で設定したドア(部屋)に発行されている暗証番号を取得します。
デバイスに対し、未発行(利用開始から72時間以上前)の暗証番号も取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
unitId required | string ドア(部屋)を識別するユニークID |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
position | string 取得レコードの位置を示すポインタID |
records | string 取得レコード数、未指定の場合50 |
{- "unitId": "000D6F0014A6F0B2",
- "sTime": "1633359600",
- "eTime": "1633532340",
- "position": "11256",
- "records": "10"
}
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "position": "11256",
- "records": "5",
- "pinList": [
- {
- "id": "100001",
- "pinId": "c62325518edc528e24492ee8",
- "pinCode": "123456",
- "qrCode": "MK614190B455C75B4CC53AAB4A0F1E562B",
- "category": "access",
- "sTime": "1633305600",
- "eTime": "1633532340"
}
]
}
]
}
ドア(部屋)に対し暗証番号を新規発行します。発行された暗証番号は、ドア(部屋)に紐づけられたすべてのスマートロックに対して配信されます。スマートロックによって仕様が異なるため、異なる機種のスマートロックには同じドア(部屋)からの暗証番号発行ができません。詳細はgetLockStatusのレスポンスを参照してください。
スマートロックの機種によって、発行できる暗証番号の桁数やタイミングが異なります。ご利用になるスマートロックの機種が特定できない場合、あらかじめgetLockStatusでスマートロックの種別を確認したうえで処理を変えていただくか、一律以下の処理を行うことを推奨します。
・クライアント側での暗証番号の指定は行わず、自動発行とする
・暗証番号の桁数をクライアント側で指定しない(スマートロック機種によって異なります)。
・createLockPinのおよそ5分後以降に、getLockPinStatusで暗証番号を取得する。
※getLockPinStatusのstatusに3X(30,31,32)が返却されるまで、定期的に取得を繰り返してください。
※暗証番号の発行は利用開始日時の72時間前から、となります。getLockPinStatusでの結果取得も「利用開始日時の72時間前」を過ぎてから行ってください。
QR1が発行するQRコードに関して
QR1が発行するQRコードには「オンラインQRコード」と「オフラインQRコード」の2種類があります。
オンラインQRコード:
サーバ側で発行したQRコードをQR1デバイスに配信します。配信後解錠できるまで数分の時間がかかります。
オフラインQRコード:
サーバ側のアルゴリズムで作成したQRコードを、QR1デバイスと通信することなく発行されたQRコードで即時に解錠できます。
/createLockPinにて「オンラインQRコード」もしくは「オフラインQRコード」のどちらを受け取るかは、KEYVOX管理画面、BACSの 設定>デバイス>デバイス詳細 で指定できます。
https://keyvox.notion.site/0834db2a7e6b4b19809448112ef68fa3?pvs=4
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
unitId required | string WEB管理画面「BACS」で設定したドア(部屋)ごとに割り当てられるユニークIDです。getUnitsで取得可能です。 |
pinCode | string スマートロックに配信する暗証番号に任意の数字を指定する場合に使用します。 |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "unitId": "5de092a8ef16f9512c1f1fff",
- "pinCode": "123456",
- "sTime": "1633305600",
- "eTime": "1633316400",
- "targetName": "BCL 太郎"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "pinId": "c62325518edc528e24492ee8",
- "pinCode": "123456",
- "qrCode": "MK614190B455C75B4CC53AAB4A0F1E562B"
}
}
発行した暗証番号を変更します。変更を行う際には、createLockPinのレスポンスに含まれるpinIdを指定する必要があります。一部のスマートロックは仕様が異なるため、変更、削除ができません。(※)
※スマートロック igloohome、OPELO をご利用されている場合、発行済みの暗証番号を変更、削除することはできません。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
pinId required | string 暗証番号を識別するユニークID |
pinCode | string スマートロックに配信する暗証番号に任意の数字を指定する場合に使用します。 |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "pinId": "c62325518edc528e24492ee8",
- "pinCode": "123456",
- "sTime": "1633305600",
- "eTime": "1633316400",
- "targetName": "XXXで利用"
}
{- "code": "0",
- "msg": "success"
}
発行した暗証番号を削除します。削除を行う際には、createLockPinのレスポンスに含まれるpinIdを指定する必要があります。一部のスマートロックは仕様が異なるため、変更、削除ができません。(※)
※スマートロック igloohome、OPELO をご利用されている場合、発行済みの暗証番号を変更、削除することはできません。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
pinId required | string 暗証番号を識別するユニークID |
{- "pinId": "c62325518edc528e24492ee8"
}
{- "code": "0",
- "msg": "success"
}
pinIdを指定して、発行した暗証番号のスマートロックへの配信状況を確認します。スマートロックが複数ある場合、最も遅いステータスが返却されます。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
pinId required | string 暗証番号を識別するユニークID |
{- "pinId": "c62325518edc528e24492ee8"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "pinCode": "123456",
- "status": "10"
}
}
lockIdを指定して、スマートロックごとに発行済みの暗証番号を取得します。取得できるのはデバイスに配信済みの暗証番号のみです。
未来の暗証番号について、利用開始予定時間が72時間以内であれば、すぐ配信しますが、72間後以降の場合、72時間以内になってから配信を行います。
このAPIで取得できるのは配信済(利用開始予定時間が72時間以内)の暗証番号だけであり、それ以降のものについては取得できません。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
lockId required | string スマートロックを識別するユニークID |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
position | string 取得レコードが全体で何番目かの位置を示す情報 |
records | string 取得レコード数、未指定の場合50 |
{- "lockId": "000D6F0014A6F0B2",
- "sTime": "1633359600",
- "eTime": "1633532340",
- "position": "200",
- "records": "10"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "position": "467",
- "records": "5",
- "pinList": [
- {
- "id": "100001",
- "pinId": "c62325518edc528e24492ee8",
- "pinCode": "123456",
- "qrCode": "MK614190B455C75B4CC53AAB4A0F1E562B",
- "sTime": "1633305600",
- "eTime": "1633532340"
}
]
}
}
lockIdを指定して、ロックの開閉状態、バッテリー残量、Wi-Fi接続状況を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
lockId required | string スマートロックを識別するユニークID |
{- "lockId": "000D6F0014A6F0B2"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "pinType": "1",
- "relateBattery": "84%",
- "relateType": "PiACK II",
- "battery": "90%",
- "wifi": "1",
- "status": "1",
- "reportTime": "1691406002",
- "moduleId": "1000"
}
}
lockIdを指定して、ロックの開閉履歴を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
lockId required | string スマートロックを識別するユニークID |
position | string 取得レコードの位置を示すポインタID |
records | string 取得レコード数、未指定の場合50 |
{- "lockId": "000D6F0014A6F0B2",
- "position": "62fbba54a5ec72404000c962",
- "records": "10"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "position": "5be1403031bca94e4cf46d57",
- "records": "5",
- "history": [
- {
- "etime": "1633532340",
- "etype": "1",
- "userName": "山田太郎",
- "value": "123456"
}
]
}
}
lockIdを指定して、直接解錠、施錠を行います。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
lockId required | string スマートロックを識別するユニークID |
flag required | string Enum: "0" "1" 鍵の開閉操作、0:施錠,1:解錠 |
{- "lockId": "000D6F0014A6F0B2",
- "flag": "0"
}
{- "code": "0",
- "msg": "success"
}
ドアに対しICカードを新規発行
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
unitId required | string WEB管理画面「BACS」で設定したドア(部屋)ごとに割り当てられるユニークIDです。getUnitsで取得可能です。 |
cardCode required | string Mifereの場合は、UIDを、Felicaの場合はIDmの値を指定します。 |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "unitId": "5de092a8ef16f9512c1f1fff",
- "cardCode": "C3AD47FC",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "targetName": "XXXで利用"
}
{- "code": "0",
- "msg": "success"
}
発行したICカードの利用期間、名前を変更します。変更を行う際には、setCardのレスポンスに含まれるcardIdを指定する必要があります。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
cardId required | string カードを識別するユニークID |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "cardId": "c62325518edc5224492ee8",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "targetName": "XXXで利用"
}
{- "code": "0",
- "msg": "success"
}
発行したICカードを削除します。削除を行う際には、setCardのレスポンスに含まれるcardIdを指定する必要があります。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
cardId required | string カードを識別するユニークID |
{- "cardId": "c62325518edc5224492ee8"
}
{- "code": "0",
- "msg": "success"
}
accessIdを指定して、発行したICカードのスマートロックへの配信状況を確認します。スマートロックが複数ある場合、最も遅いステータスが返却されます。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
cardId | string setLockerCardでアクセス権を設定した際に返却される、アクセス権ごとのユニークIDです。アクセス権を更新する際に指定します。 |
{- "cardId": "5f7e9dba0cc45444a0b3a895"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "status": "10"
}
}
lockIdを指定して、スマートロックごとに発行済みのICカード情報を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
lockId required | string スマートロックを識別するユニークID |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
position | string 取得レコードが全体で何番目かの位置を示す情報 |
records | string 取得レコード数、未指定の場合50 |
{- "lockId": "000D6F0014A6F0B2",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "position": "200",
- "records": "10"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "position": "467",
- "records": "5",
- "cardList": [
- {
- "id": "1446",
- "cardId": "5dc8c7c74cda067bd5b6232f",
- "cardCode": "C3AD47FC",
- "cardName": "XXXX用カード",
- "cardDesc": "XXXXで利用",
- "sTime": "1574160027",
- "eTime": "1633532340"
}
]
}
}
WEB管理画面「BACS」で設定したドア(部屋)、ドアに紐づいているスマートロックまたはスマートロッカーの情報を取得します。カギの発行はドア(部屋)に対して行います。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "unitId": "5de092a8ef16f9512c1f1fff",
- "unitName": "1101室",
- "lockIds": "5bdfdd421bca968a774ec18a,5bd80fcd31bca24fc30e1eab",
- "placeName": "内幸町ホテル",
- "unitState": "I",
- "unitType": "シングル",
- "placeType": "facility"
}
]
}
WEB管理画面「BACS」に登録されているロッカー本体の情報を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "deviceId": "5bceb8e2076d20135c307916",
- "deviceName": "XXXXエリアロッカー"
}
]
}
deviceIdを指定し、ロッカー本体ごとの各ボックスの利用状況を取得します。ボックス番号(boxNum)はWEB管理画面「BACS」にて確認できます。
※boxNumが00-01の形で、00は副キャビネット番号、01はBOX番号です。BACSの設定>ロッカー>ボックス設定画面で確認できます。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxNum | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
{- "deviceId": "5bceb8e2076d20135c307916",
- "boxNum": "00-01"
}
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01",
- "boxName": "01",
- "status": "0",
- "boxSize": "1"
}
]
}
deviceIdを指定し、ロッカー本体ごとの各ボックスの状況を設定します。ボックス番号(boxNum)はWEB管理画面「BACS」にて確認できます。
※boxNumが00-01の形で、00は副キャビネット番号、01はBOX番号です。BACSの設定>ロッカー>ボックス設定画面で確認できます。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxNum required | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
status required | string Enum: "0" "3" ステータス。0:未使用, 3:故障。 |
{- "deviceId": "5bceb8e2076d20135c307916",
- "boxNum": "00-01",
- "status": "0"
}
{- "code": "0",
- "msg": "success"
}
deviceId、boxNumを指定して、ロッカーの特定のボックスを直接解錠します。
※boxNumが00-01の形で、00は副キャビネット番号、01はBOX番号です。getLockerStatusのレスポンスで確認できます。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxNum required | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
{- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01"
}
{- "code": "0",
- "msg": "success"
}
ロッカーの特定のボックスに対し、ICカードの利用権限を発行します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId | string スマートロッカーを識別するユニークID |
boxNum | string ボックスの番号情報が"00-01"のような書式で返却されます。00は副キャビネット番号、01はBOX番号を表します。 |
cardCode | string Mifereの場合は、UIDを、Felicaの場合はIDmの値を指定します。 |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01",
- "cardCode": "C3AD47FC",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "targetName": "XXX用ロッカーのカード"
}
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "accessId": "5f7e9dba0cc45444a0b3a895"
}
]
}
発行したICカードの利用期間、名前を変更します。変更を行う際には、setLockerCardのレスポンスに含まれるaccessIdを指定する必要があります。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
accessId required | string setLockerCardでアクセス権を設定した際に返却される、アクセス権ごとのユニークIDです。 |
sTime required | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime required | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "accessId": "string",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "targetName": "XXXロッカーのカード"
}
{- "code": "0",
- "msg": "success"
}
ロッカーの特定のボックスに対し、暗証番号を発行します。 暗証番号の他に、レスポンスとしてQRコード生成用URLも取得することができます。 暗証番号の扱いについてはいくつかのオプションがあります。 詳細はインターフェース内容の説明をご確認ください。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string ロッカーを識別するユニークID |
boxNum | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
checkin | string Enum: "0" "1" ボックスのステータスを指定します。 |
mode | string Enum: "0" "1" "2" 0:once(一度のみ利用可能なモードです。利用開始後、返却したら再度利用開始することはできません。また、利用中のままeTimeを過ぎても自動的に返却扱いとはなりません。) |
reassign | string Enum: "0" "1" Reassign. 0:false(指定したボックスが利用中の場合、空きがないエラーをロッカー端末に表示します。) |
pinCode | string スマートロッカーに配信する暗証番号に任意の数字を指定する場合に使用します。(6桁) |
sTime | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01",
- "checkin": "1",
- "mode": "0",
- "reassign": "0",
- "pinCode": "123456",
- "sTime": "1633305600",
- "eTime": "1633532340",
- "targetName": "XXX用のロッカー暗証番号"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "pinId": "ABACCD0G1",
- "pinCode": "123456",
- "qrCode": "MK614190B455C75B4CC53AAB4A0F1E562B"
}
}
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
pinId required | string 暗証番号を識別するユニークID |
pinCode | string スマートロッカーに配信する暗証番号に任意の数字を指定する場合に使用します。(6桁) |
sTime required | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime required | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
targetName | string カギを利用する利用者名を指定します。WEB管理画面「BACS」の履歴などに表示されます。 |
{- "pinId": "ABACCD0G1",
- "pinCode": "123456",
- "sTime": "1633359600",
- "eTime": "1633532340",
- "targetName": "XXX用のロッカー"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "pinId": "ABACCD0G1",
- "pinCode": "123456",
- "qrCode": "MK614190B455C75B4CC53AAB4A0F1E562B"
}
}
発行した暗証番号を削除します。削除を行う際には、createLockerPinのレスポンスに含まれるpinIdを指定する必要があります。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
pinId required | string 暗証番号を識別するユニークID |
{- "pinId": "ABACCD0G1"
}
{- "code": "0",
- "msg": "success"
}
ロッカーの特定のボックスに対し、登録済みのカギ情報を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxNum | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
sTime required | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime required | string (getLockerOrdersIn) 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
{- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01",
- "sTime": "1633359600",
- "eTime": "1633532340"
}
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "deviceName": "XXXXエリアロッカー",
- "boxNum": "00-01",
- "boxName": "01",
- "boxSize": "1",
- "pinId": "ABACCD0G1",
- "pinCode": "123456",
- "sTime": "1633359600",
- "eTime": "1633532340"
}
]
}
ロッカー本体ごとに、空いているボックスを取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxSize | string WEB管理画面「BACS」で設定したスマートロッカーのサイズ情報を指定するサイズ番号が返却されます。 |
sTime required | string 利用開始日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
eTime required | string 利用終了日時、1970/01/01からの秒数(UNIX時間)で指定します。 |
{- "deviceId": "5bceb8e2076d20135c307916",
- "boxSize": "1",
- "sTime": "1633359600",
- "eTime": "1633532340"
}
{- "code": "0",
- "msg": "success",
- "data": [
- {
- "boxNum": "00-01",
- "boxName": "01"
}
]
}
ロッカーボックス毎のLED状態を指定します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
deviceId required | string スマートロッカーを識別するユニークID |
boxNum required | string ボックスの番号情報を"00-01"のような書式で指定します。00は副キャビネット番号、01はBOX番号を表します。 |
boxColor required | integer ボックスの色を指定します。 |
{- "deviceId": "A5C8A98B35260000",
- "boxNum": "00-01",
- "boxColor": 0
}
{- "code": "0",
- "msg": "success"
}
WEB管理画面「BACS」に対し、ICカードの情報を登録します。あらかじめICカードのIDm/UIDをご用意いただく必要があります。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
cardCode required | string Mifereの場合は、UIDを、Felicaの場合はIDmの値を指定します。 |
cardName required | string カード名 |
cardDesc | string カード備考 |
{- "cardCode": "C3AD47FC",
- "cardName": "XXXX用カード",
- "cardDesc": "XXXXで利用"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "cardId": "c62325518edc5224492ee8"
}
}
WEB管理画面「BACS」に対し、登録したICカードの情報を削除します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
Array of objects (delCard) |
{- "cardList": [
- {
- "cardId": "c62325518edc5224492ee8"
}
]
}
{- "code": "0",
- "msg": "success"
}
WEB管理画面「BACS」で設定したドア(部屋)に紐づいている、未チェックインの予約情報一覧を取得します。
x-target-host required | string default.pms |
date required | string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT |
digest required | string Sha256 summary of the body part (base64 encoding) |
authorization required | string Hmac256 authentication header. |
入力パラメータ
unitId required | string WEB管理画面「BACS」で設定したドア(部屋)ごとに割り当てられるユニークIDです。getUnitsで取得可能です。 |
{- "unitId": "5de092a8ef16f9512c1f1fff"
}
{- "code": "0",
- "msg": "success",
- "data": {
- "orderId": "HEN39BYIK",
- "checkIn": "1633305600",
- "checkOut": "1633305600",
- "pinCode": "123456"
}
}