Adapter - Salto Hospitality

This page describes version 2.0.9 of the adapter.

Overview

This adapter is used to connect to a Salto Door Key system and executes Salto Industry Standard PMS Protocol commands. The adapter can be used to program a room key card on guest check in, create room key card copies, and unassigned any previously programmed room key on guest check out.

One of its typical use cases is to provide room key programming support for the Kiosk Client application.

Installation

The adapter can be installed by selecting the adapter card named Salto Hospitality from the Adapter Store page of the UIP -> Adapter Types location of the UIP Administration Web pages.

Configuration

The Salto Hospitality Adapter can be run as an internal adapter on the UIP system or an external adapter installed on an Adapter Hub. Refer to the Adapter Hub documentation for more detailed information regarding Adapter Hub configuration. If the Salto Adapter is configured to include the Salto Connection Multiplexer, ports in the Adapter Hub will need to be mapped to reflect the port used by the multiplexer. This will allow other applications that need a connection to the Salto Server to connect to the Multiplexer using the FQDN or IP Address of the UIP and the configured multiplexer port for a shared connection to the Salto Server. The Multiplexer will then act as a go between that will send information back and forth between the Salto server and that application as well as the commands sent to and from the Salto Hospitality Adapter itself allowing a single connection to the Salto Server.

• After you have added the Salto Hospitality Adapter Type, navigate to the Adapters page.
• Click Add Adapter.
• Select Salto Hospitality as type
• Give it a meaningful name
• If using an Adapter Hub, check the External checkbox and select the name given to the Adapter Hub from the drop down provided below the Adapter Hub title. Enter a value for the External Token or accept the default value provided. It will not be required or used in this configuration.
• Click Save when done. If installed as an External Adapter, your adapter will appear as enabled but it will be unable to enter the Started state until the Adapter Hub is up and running.



Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
hostname	Salto Server host name	True	Salto Server host name or IP address	string	127.0.0.1			1024
port	Salto Server Port	True	The port where the Salto Server accepts incoming connections	integer	8888	65535	1
activateMultiplexer	Activate the Salto Connection Multiplexer	True	Activate the Salto Connection Multiplexer and allow multiple applications to share the same connection to the Salto Server	boolean	false
multiplexerPort	Multiplexer Port	True	The port where the Salto Connection Multiplexer accepts incoming connections	integer	8888	65535	1



Commands

Check In (checkin)

Encode a new guest card and return a serial number

Request Properties

Name	Display	Description	Is Required	Type
encoder	Encoder	Encoder Number in which the requested card will be encoded	True	string
mode	Mode (E -Ejection, R-Retention)	Indicate whether to wait on card removal from motorised encoders (E) or not (R - most common)	True	string
room	Room	Room to grant guest access	True	string
checkInDate	Check In Time (yyyy-MM-DD hh:mm)	The date/time when the guest is checking in.	True	string
expirationTime	Expiration Time (yyyy-MM-DD hh:mm)	The date/time when the card access is expected to expire.	True	string
room2	Room 2	2nd room to grant guest access	False	string
room3	Room 3	3rd room to grant guest access	False	string
room4	Room 4	4th room to grant guest access to	False	string
grant	Grant Authorization Access	List of Authorizations granted to the guest corresponding to the Salto database configuration and separated by commas. ie 1,5,60. (1-62)	False	string
deny	Deny Authorization Access	List of Authorizations denied to the guest corresponding to the Salto database configuration and separated by commas. ie 1,5,60. (1-62)	False	string
operator	Operator	Operator making request	False	string
track1	Track 1 Information	Additional information written to track 1	False	string
track2	Track 2 Information	Additional information written to track 2	False	string
track3	Track 3 Information	Additional information written to track 3	False	string
authCode	Authorization Code	Authorization code assigned to the guest	False	string

Response Properties

Name	Description	Type
status	Status of the command - true/false	string
error	Error code (if any)	string
errorMessage	Error message (if any)	string
card	Card serial number	string

Copy Card (copycard)

Encode a new guest card, after the original one was already encoded and return a serial number

Request Properties

Name	Display	Description	Is Required	Type
encoder	Encoder	Encoder Number in which the requested card will be encoded	True	string
mode	Mode (E -Ejection, R-Retention)	Indicate whether to wait on card removal from motorised encoders (E) or not (R - most common)	True	string
room	Room	Room to be opened by the card	True	string
checkInDate	Check In Time (yyyy-MM-DD hh:mm)	The date/time when the guest is checking in.	True	string
expirationTime	Expiration Time (yyyy-MM-DD hh:mm)	The date/time when the card access is expected to expire.	True	string
room2	Room 2	2nd room to grant guest access	False	string
room3	Room 3	3rd room to grant guest access	False	string
room4	Room 4	4th room to grant guest access to	False	string
grant	Grant Authorization Access	Authorizations granted to guest	False	string
deny	Deny Authorization Access	Authorizations denied to guest	False	string
operator	Operator	Operator making request	False	string
track1	Track 1 Information	Additional information written to track 1	False	string
track2	Track 2 Information	Additional information written to track 2	False	string
track3	Track 3 Information	Additional information written to track 3	False	string
authCode	Authorization Code	Authorization code assigned to the guest	False	string

Response Properties

Name	Description	Type
status	Status of the command - true/false	string
error	Error code (if any)	string
errorMessage	Error message (if any)	string
card	Card serial number	string

Check Out (checkout)

Performs the checkout of the specified room

Request Properties

Name	Display	Description	Is Required	Type
room	Room	Room to check out	True	string

Response Properties

Name	Description	Type
status	Status of the command - true/false	string
error	Error code (if any)	string
errorMessage	Error message (if any)	string

Check In 3rd Party (checkin3rdparty)

Check in command that produces card data when using a 3rd party encoder.

Request Properties

Name	Display	Description	Is Required	Type
serialNumber	Serial Number	Serial number of the card to be encoded	True	string
cardType	Card Type	The type of card used for guest access. Available options are 1= Mifare Classic, 2 = HIDiCLASS, 3 = Mifare Desfire, 4 = TagIt	True	string
room	Room	Room to grant guest access	True	string
checkInDate	Check In Time (yyyy-MM-DD hh:mm)	The date/time when the guest is checking in.	True	string
expirationTime	Expiration Time (yyyy-MM-DD hh:mm)	The date/time when the card access is expected to expire.	True	string
sectors	Mifare Sectors	Required for Mifare Classic Card Type. The list of Mifare card sectors assigned for use by Salto separated by commas. ie 4,6,8	False	string
pages	HIDiCLASS Pages and Sizes	Required for HIDiCLASS Card Type. The list of HIDiCLASS card pages (ID) and page sizes (0 = 2Kbits or 1 = 16Kbits) assigned for use by Salto separated by commas. for 4(page 4),0(size 2Kbits),6(page 6),0(size 2Kbits),8(page 8),1(size 16Kbits) input = 4,0,6,0,8,1	False	string
files	Desfire Files and File Sizes	Required for Mifare Desfire Card Type. The list of Desfire card files and file sizes assigned for use by Salto separated by commas in file then size order. ie 1, 1024, 2, 560	False	string
memory	TagIt Memory Size	Required for TagIt Card Type. The memory size in bytes allocated on the TagIt card for use by Salto. ie 128	False	string
room2	Room 2	2nd room to grant guest access	False	string
room3	Room 3	3rd room to grant guest access	False	string
room4	Room 4	4th room to grant guest access to	False	string
grant	Grant Authorization Access	Authorizations granted to guest	False	string
deny	Deny Authorization Access	Authorizations denied to guest	False	string
operator	Operator	Operator making request	False	string
track1	Track 1 Information	Additional information written to track 1	False	string
track2	Track 2 Information	Additional information written to track 2	False	string
track3	Track 3 Information	Additional information written to track 3	False	string
authCode	Authoraization Code	Authorization code assigned to the guest	False	string

Response Properties

Name	Description	Type
status	Status of the command - true/false	string
error	Error code (if any)	string
errorMessage	Error message (if any)	string
cardData	Binary card data returned for 3rd party card encoder.	string

Copy Card 3rd Party (copycard3rdparty)

Copy card command that produces card data when using a 3rd party encoder.

Request Properties

Name	Display	Description	Is Required	Type
serialNumber	Serial Number	Serial number of the card to be encoded	True	string
cardType	Card Type	The type of card used for guest access. Available options are 1= Mifare Classic, 2 = HIDiCLASS, 3 = Mifare Desfire, 4 = TagIt	True	string
room	Room	Room to grant guest access	True	string
checkInDate	Check In Time (yyyy-MM-DD hh:mm)	The date/time when the guest is checking in.	True	string
expirationTime	Expiration Time (yyyy-MM-DD hh:mm)	The date/time when the card access is expected to expire.	True	string
sectors	Mifare Sectors	The list of Mifare card sectors assigned for use by Salto separated by commas. ie 4,6,8	False	string
pages	HIDiCLASS Pages and Sizes	The list of HIDiCLASS card pages (ID) and page sizes (0 = 2Kbits or 1 = 16Kbits) assigned for use by Salto separated by commas. for 4(page 4),0(size 2Kbits),6(page 6),0(size 2Kbits),8(page 8),1(size 16Kbits) input = 4,0,6,0,8,1	False	string
files	Desfire Files and File Sizes	The list of Desfire card files and file sizes assigned for use by Salto separated by commas in file then size order. ie 1, 1024, 2, 560	False	string
memory	TagIt Memory Size	The memory size in bytes allocated on the TagIt card for use by Salto. ie 128	False	string
room2	Room 2	2nd room to grant guest access	False	string
room3	Room 3	3rd room to grant guest access	False	string
room4	Room 4	4th room to grant guest access to	False	string
grant	Grant Authorization Access	Authorizations granted to guest	False	string
deny	Deny Authorization Access	Authorizations denied to guest	False	string
operator	Operator	Operator making request	False	string
track1	Track 1 Information	Additional information written to track 1	False	string
track2	Track 2 Information	Additional information written to track 2	False	string
track3	Track 3 Information	Additional information written to track 3	False	string
authCode	Authoraization Code	Authorization code assigned to the guest	False	string

Response Properties

Name	Description	Type
status	Status of the command - true/false	string
error	Error code (if any)	string
errorMessage	Error message (if any)	string
cardData	Binary card data returned for 3rd party card encoder.	string

Release History

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.
2.0.7	Maintenance	Updated third-party components and improved maintainability.	NAP-11518
2.0.8	Maintenance	Updated third-party components and improved maintainability.	NAP-23945	2023-01-06
2.0.9	Maintenance	Updated third-party components and improved maintainability.	NAP-27635	2024-07-31

Categories

• Access Control
• Smart Check-In