Difference between revisions of "Nuki.io"

From Beds24 Wiki
Jump to navigation Jump to search
Line 8: Line 8:
  
 
Contact us if you want to participate in the beta test.  
 
Contact us if you want to participate in the beta test.  
 
  
 
For Beds24 the normal channel manger fees apply.
 
For Beds24 the normal channel manger fees apply.
 
<div style="display:none">
 
  
 
== Capabilities ==
 
== Capabilities ==
*Beds24 can send booking data to Remotelock locks.
+
*Beds24 can send booking data to Nuki locks.
*Multiple rooms can connect to one lock.
 
 
*Auto-Check-in: when a lock is first opened by the guest the info code "CHECKIN" will be added to the booking.
 
*Auto-Check-in: when a lock is first opened by the guest the info code "CHECKIN" will be added to the booking.
*Support for Resortlocks.
 
 
Remotelock provides various regional servers, the main one we connect to is the US service, if you need to connect to a regional one (for example Japanese) please let us know and we can configure your account accordingly.
 
  
 
== Limitations ==
 
== Limitations ==
 +
*Currently only keypad authentication is supported.
  
 
== Set Up ==
 
== Set Up ==
*Click on "Connect to Lockstate".  
+
To use this service you will need:
*Authorize Beds24 to access your account
+
*A Nuki Smart Lock.
 +
*A Nuki Keypad.
 +
*A [https://nuki.io nuki.io] account.
 +
 
  
When successfully connected you will see the Remotelock account you are connected to.
+
*Click on "Connect to Nuki".
 +
*Sign in with your Nuki account if prompted.
 +
*Click "Allow" to let Beds24 view and manage your Nuki account and locks.
 +
 
 +
[[Image:nuki_auth.png|500px|link=]]
 +
[[Media:nuki_auth.png|view large]]
  
*The "Pin Strategy" defines how the access code is constructed.
 
 
*The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
 
*The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
 
*The "Days in Advance" sets the days before check-in that the booking is sent to the lock.
 
*The "Days in Advance" sets the days before check-in that the booking is sent to the lock.
 
*Click on "Get Codes"  
 
*Click on "Get Codes"  
You will see one serial number for each lock. Click on the serial number of the lock that is using the lock.
+
You will see one identifier and name for each lock. Click on the name of the lock that is associated with the room.
 
 
[[Image:agoda_room_mapping.png|500px|link=]]
 
[[Media:agoda_room_mapping.png|view large]]
 
 
 
 
 
If you have a common lock for multiple units you can enter the same lock serial number for each unit.
 
 
 
Note: Lockstate uses several servers. If you are not redirected back to Beds24 send us a support ticket via the SUPPORT button in the top left of your Beds24 control panel.
 
  
 +
[[Image:nuki_mapping.png|500px|link=]]
 +
[[Media:nuki_mapping.png|view large]]
  
 
== How it works ==
 
== How it works ==
Bookings get sent to the locks at the set time prior to check-in. A booking info code named LOCKSTATE_PIN is created which will show the pin number valid for the booking.  
+
Bookings are sent to locks "Days in Advance" prior to check-in.  
 
+
*An entry code/user named Booking:{booking number} is added to the lock, viewable at [https://web.nuki.io/#/pages/smartlocks web.nuki.io] or in the Nuki app.
You can change the pin manually in the LOCKSTATE_PIN booking info code and the new pin will be sent to the lock at the next update.
+
*A booking info code named NUKI_PIN is created which will show the pin number valid for the booking.
 
+
Updates are sent periodically. To instantly send updates, click "Send Bookings to Locks".
To force no pin to be sent for a booking, change the value of the LOCKSTATE_PIN booking info item to none, (i.e. the word "none")
+
If the keypad code, booking dates, or room changes, those details will be sent to locks.
 
 
Updates are sent multiple times per day and send bookings for the selected days in advance. To instantly push updates through click "Send Data to Lockstate".  
 
 
 
If the dates of the booking have been changed or the booking has been moved to a different room those details will be sent to the locks.  
 
 
 
If bookings are cancelled we delete the guest out of LOCKSTATE. This will remove the access.
 
 
 
The Email address of the guest is sent to Lockstate. You can set up Remotelock to automatically send Emails to the guest. Alternatively you can create an Auto Action in SETTINGS > GUEST MANAGEMENT > AUTO ACTIONS.
 
 
 
The template variable for the pin is [BOOKINGINFOCODETEXT:LOCKSTATE_PIN].
 
 
 
== Auto Check-in ==
 
Auto check-in will add a booking info item called CHECKIN to the booking when the guest first uses the lock.
 
To use auto check-in you must setup a webhook to send notifications from the lock to Beds24.
 
 
 
There are two steps to the webhook setup:
 
 
 
1) Add a Webhook Notification Contact in Remotelock
 
 
 
the URL of the webhook must contain your Beds24 ownerId number at the end like ?ownerid=12345
 
 
 
https://api.beds24.com/lockstate.com/notify.php?ownerid=<Your Beds24 owner ID>
 
 
 
The Content Type must be "JSON"
 
  
The secret can be left empty
+
If a booking is cancelled the associated entry code will be deleted from locks.
  
2) Add a Notification in Remotelock
+
Entry codes/users can only be used during the booking period, they will not provide access before or after.
  
The notification type is "Webhook"
+
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>  If a Nuki lock is offline when an update is sent, the entry code will not be added until the lock comes online again.
  
The Webhook Notification Contact is the contact you created in step 1)
+
== Manually changing pins ==
 +
# Navigate to Account, Preferences, Bookings, and add "NUKI_PIN" to your Booking Info Code Values.
 +
# You can now manually add a NUKI_PIN info code to your bookings.
 +
[[Image:nuki_set_pin.png|x300px|link=]]
 +
[[Media:nuki_set_pin.png|view large]]
 +
=== Nuki pin limitations ===
 +
Nuki keypad codes must:
 +
# Be exactly six digits long.
 +
# Not contain the number zero.
 +
# Not start with "12".
  
The source should be "Account"
+
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>  If you manually set an invalid NUKI_PIN, it will be overwritten with a randomly generated pin the next time bookings are sent to locks.
  
The Events must be "Access Granted" and "First Access Only"
+
== Information sent to guests ==
 +
=== Keypad codes ===
 +
* For keypad entry code bookings, Nuki does not send any information to guests.
 +
=== App access ===
 +
(not currently supported)
 +
* For app access bookings, Nuki will automatically send an email to guests that provides access via the Nuki app.
 +
* Guests have 48 hours to accept the invitation.
 +
* There is no way to resend a Nuki app invitation if a guest does not accept it in time. However, you may go to [https://web.nuki.io/#/pages/smartlocks web.nuki.io], select Devices, click the desired smartlock, go to the Users tab, then find the booking and click delete. You can then visit the [https://beds24.com/control2.php?pagetype=syncronisernukiio Beds24 Nuki integration tool] and click "Send bookings to Locks" to make Nuki send a new invitation to the guest.
  
== Common Problems ==
+
[[Image:nuki_delete_user.png|900px|link=]]
Lockstate have two types of access: users and guests. Bookings from Beds24 create guests.  
+
[[Media:nuki_delete_user.png|view large]]
  
 
== Disconnect==
 
== Disconnect==
 
Click on "Disconnect" to terminate the connection.
 
Click on "Disconnect" to terminate the connection.

Revision as of 18:16, 15 July 2020

Nuki COMING SOON
 This page is about the menu  (SETTINGS) APPS & INTEGRATIONS > NUKI

To use this service you will need an account with https://nuki.io/

Contact us if you want to participate in the beta test.

For Beds24 the normal channel manger fees apply.

1 Capabilities

  • Beds24 can send booking data to Nuki locks.
  • Auto-Check-in: when a lock is first opened by the guest the info code "CHECKIN" will be added to the booking.

2 Limitations

  • Currently only keypad authentication is supported.

3 Set Up

To use this service you will need:

  • A Nuki Smart Lock.
  • A Nuki Keypad.
  • A nuki.io account.


  • Click on "Connect to Nuki".
  • Sign in with your Nuki account if prompted.
  • Click "Allow" to let Beds24 view and manage your Nuki account and locks.

Nuki auth.png view large

  • The "Start Time" and "End Time" define the earliest Check-in time and latest Check-out time.
  • The "Days in Advance" sets the days before check-in that the booking is sent to the lock.
  • Click on "Get Codes"

You will see one identifier and name for each lock. Click on the name of the lock that is associated with the room.

Nuki mapping.png view large

4 How it works

Bookings are sent to locks "Days in Advance" prior to check-in.

  • An entry code/user named Booking:{booking number} is added to the lock, viewable at web.nuki.io or in the Nuki app.
  • A booking info code named NUKI_PIN is created which will show the pin number valid for the booking.

Updates are sent periodically. To instantly send updates, click "Send Bookings to Locks". If the keypad code, booking dates, or room changes, those details will be sent to locks.

If a booking is cancelled the associated entry code will be deleted from locks.

Entry codes/users can only be used during the booking period, they will not provide access before or after.

If a Nuki lock is offline when an update is sent, the entry code will not be added until the lock comes online again.

5 Manually changing pins

  1. Navigate to Account, Preferences, Bookings, and add "NUKI_PIN" to your Booking Info Code Values.
  2. You can now manually add a NUKI_PIN info code to your bookings.

Nuki set pin.png view large

5.1 Nuki pin limitations

Nuki keypad codes must:

  1. Be exactly six digits long.
  2. Not contain the number zero.
  3. Not start with "12".

If you manually set an invalid NUKI_PIN, it will be overwritten with a randomly generated pin the next time bookings are sent to locks.

6 Information sent to guests

6.1 Keypad codes

  • For keypad entry code bookings, Nuki does not send any information to guests.

6.2 App access

(not currently supported)

  • For app access bookings, Nuki will automatically send an email to guests that provides access via the Nuki app.
  • Guests have 48 hours to accept the invitation.
  • There is no way to resend a Nuki app invitation if a guest does not accept it in time. However, you may go to web.nuki.io, select Devices, click the desired smartlock, go to the Users tab, then find the booking and click delete. You can then visit the Beds24 Nuki integration tool and click "Send bookings to Locks" to make Nuki send a new invitation to the guest.

Nuki delete user.png view large

7 Disconnect

Click on "Disconnect" to terminate the connection.