Developer
Instruction
Difficulty level: Intermediate

A Salto KS integration involves three parties: the customer (owner of the venue and the i-Reserve licence), the Salto installer (installs and manages the locks and the Salto KS site) and i-Reserve (sets up the integration). This page lists who does what and which details and rights are needed. You can send the link to this page straight to the Salto installer.

In short: what i-Reserve needs

DetailWhat it isSupplied by
EnvironmentFor a real customer always Production (app.saltoks.com). Acceptance is for testing only.Installer
Site UIDThe readable code of the site, for example NL6254340082. i-Reserve fetches the internal Site ID itself.Installer
IQ IDThe ID of the IQ gateway on site. The IQ must be linked to the site and online.Installer
Salto KS accountUsername and password of a separate account for i-Reserve, with admin rights on the site (see below).Installer or customer
Current IQ PINThe 4-digit PIN of this account on the IQ. i-Reserve can also fetch it and set a new one.Installer (or i-Reserve)
List of locksWhich lock belongs to which room or product, and which locks have a keypad.Customer + installer

Do not send the password in a plain e-mail. Use a secure channel, for example a one-time sharing link.

Tasks of the Salto installer

  1. Set up the site in Salto KS (production) and note the Site UID.
  2. Install the IQ gateway, link it to the site and make sure it is online. Note the IQ ID.
  3. Register the locks in the site, reachable via the IQ. Give them recognisable names (for example “Main entrance”, “Room 1”): the customer sees these names when mapping them in i-Reserve.
  4. Create a separate Salto KS account for i-Reserve (for example ireserve@<customer domain>) and give it access to the site with an administrator role (see “Required rights”).
  5. Hand the details from the table above to the customer or i-Reserve.
  6. Be available during the first test, in case a lock or the IQ does not respond.

Required rights of the i-Reserve account

The account handles everything related to bookings on behalf of the customer. On the site it must be able to:

Right in Salto KSWhat i-Reserve uses it for
View sites and locksFetch the Site ID, the list of locks for the mapping, and see which locks have a keypad.
Manage IQsActivate the IQ for this account (get and set the IQ PIN). Without an active IQ no door opens.
Open locks remotelyOpen the door when the guest presses the open link.
Manage users (create, change, delete)Only with PIN codes: a temporary user per booking with the standard site user role and a PIN code, removed again afterwards.
Manage access groups and time schedulesOnly with PIN codes: make the PIN code valid only on the right lock and within the booking’s time window.

In practice: give the account an administrator role on the site (the standard site admin role, or a custom role under Roles with at least the rights above). A regular user role is not enough: the connection test or the IQ activation will fail.

Why a separate account?

  • The IQ is activated per account with a PIN. If someone changes that PIN outside i-Reserve, or a personal account is removed or its password changed, the integration stops.
  • The Salto activity log then shows at once which actions come from i-Reserve.

What the installer will see in Salto

  • Open actions on locks by the i-Reserve account.
  • With PIN codes: temporary users named i-Reserve <booking number>, each with its own access group. i-Reserve removes them itself, one day after the booking ends. Do not delete or change them by hand.

Tasks of the customer

  1. Instruct the Salto installer and forward this page.
  2. Decide which rooms or products open which lock.
  3. Choose from which booking status the door may open, how many minutes in advance, and whether guests get a PIN code (only for locks with a keypad).
  4. Include the open link ({OPENLOCKLINK}) and, if used, the PIN code ({LOCKPIN}) in the confirmation e-mail or SMS.
  5. Join the on-site test: make a test booking and open the door via the link.

Tasks of i-Reserve

  1. Create the integration with the supplied details and test the connection.
  2. Activate the IQ (IQ OTP setup) until the status reads IQ is activated.
  3. Map the locks to rooms or products together with the customer and set the details.
  4. Check the first live opening. See the implementation checklist and Setting up the Salto KS integration.