Adapter - MIWA
This page describes version 2.0.3 of the adapter.
Overview
This page describes the usage of the MIWA adapter. This adapter can be used to create keycards for guests to use. The adapter requires the NEC MIWA proxy service to control the card key writer. The service must be installed separate from UIP.
Limitations
- It can be used with the hotel lock system "ALV2" provided by Miwa Lock. It cannot be used with "ALFH"/"ALVH"/"AL5H".
- The key card supports "MIFARE 1K". "Felica 4k"/"Mifare UL"/"Magnetic card" cannot be used.
- The key card writer supported by this service is "ACR122U".
- This service can create a "guest card". It is not possible to create a "maintenance card" or "master card" for use by hotel managers.
- Can set the information of "Second Room" to the key card created by this service. You can set up to one "Second Room" information for the entire hotel.
- This service cannot set the following information on the key card.
- Any app data information.
- Any special flag information.
- Daylight saving information.
- Shut out information.
- Buzzer notification information.
- Deadbolt override information.
- This service cannot print the room number or expiration date on the key card.
- Key card information cannot be deleted with this service.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| kioskRouterMode | Kiosk Router Mode | False | Enable or not the Kiosk Router mode. | boolean | true | ||||
| kioskUri | Kiosk URI/Kiosk Server URL | True | If Kiosk Router Mode is disable, set the URI of the Kiosk terminal. If mode is enable, set the URL to connect to the Kiosk Server (e.g https://address:8080). | string | |||||
| username | User Name/Kiosk Position | True | If Kiosk Router Mode is disable, set the user name for basic authentication. If mode is enable, set the kiosk position. | string | |||||
| password | Password/Router Token | True | If Kiosk Router Mode is disable, set a password for basic authentication. If mode is enable, set the router token. | string | |||||
| clientCertificate | Client Certificate | False | If Kiosk Router Mode is enable, set the adapter client certificate (PEM format). | string | |||||
| clientPrivateKey | Client Private Key | False | If Kiosk Router Mode is enable, set the private key for the adapter client certificate (PEM format). | string | |||||
| timeout | Timeout | False | Response Waiting timeout. | integer | 45 | 180 | 1 |
Commands
Create Key Card (createkeycard)
Send an additional keycard request to Miwa Proxy using the HTTP POST method.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| hotelCode | Hotel Code | Hotel code on the Miwa Lock API installation media | True | string |
| mainroom | Main Room | Room number booked by guest | True | string |
| secondroom | Second Room | Room number common to hotel | False | string |
| checkInDate | Check In Date | Check-in date and time for guest reservations | True | string |
| checkOutDate | Check Out Date | Check-out date and time for guest reservations | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Execution result ('success': success, 'failed': failure) | string |
Read Key Card (readkeycard)
Send a keycard read request to Miwa Proxy using the HTTP POST method.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| hotelCode | Hotel Code | Hotel code on the Miwa Lock API installation media | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Execution result ('success': success, 'failed': failure) | string |
| cardType | A value that indicates the type of card | string |
| cardNo | A value that indicates the branch number of the card | string |
| cardIssuedNo | A value that indicates the number of cards issued | string |
| checkInDate | Check-in date and time | string |
| checkOutDate | Check-out date and time | string |
| shutoutFlag | Enable/Disable the shut-out function | string |
| buzzerFlag | Enable/Disable the buzzer notification function | string |
| mainroom | Main room number (guest room number) | string |
| secondroom1 | Second room number1 | string |
| secondroom2 | Second room number2 | string |
| secondroom3 | Second room number3 | string |
| secondroom4 | Second room number4 | string |
| secondroom5 | Second room number5 | string |
| specialFlags | Flag area where arbitrary data can be written | string |
| summerTimeFlag | Enable/Disable the daylight saving function | string |
| deadboltFlag | Enable/Disable the deadbolt override function | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.2 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.3 | Feature | Support Kiosk Router mode. | KSK-15991 | 2024-08-14 |