Difference between revisions of "Nuki.io"

From Beds24 Wiki
Jump to navigation Jump to search
(29 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
[[Category:Self-Check-in]]
 
[[Category:Self-Check-in]]
 
[[Category:Lock Systems]]
 
[[Category:Lock Systems]]
<div class="heading">Nuki COMING SOON</div>
+
[[Category:Automation]]
 +
<div class="heading">Nuki</div>
 
   This page is about the menu {{#fas:cog}} (SETTINGS) APPS & INTEGRATIONS > NUKI
 
   This page is about the menu {{#fas:cog}} (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.
 
 
<div style="display:none">
 
  
 
For Beds24 the normal channel manger fees apply.
 
For Beds24 the normal channel manger fees apply.
  
== 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 =
 +
* Nuki smartlocks can store a maximum of 100 entry codes at a time.
 +
* Booking names in Nuki smartlocks have a maximum length of 20 characters and guest names may be cut off. This will not be visible to guests, only users with access to Nuki web will be able to view booking names.
  
== Limitations ==
+
= What you need =
 +
To use this service you will need:
 +
*At least one Nuki Smart Lock.
 +
*A [https://nuki.io nuki.io] account.
  
== Set Up ==
+
Using keypad codes requires a Nuki keypad to be setup.
*Click on "Connect to Lockstate".  
 
*Authorize Beds24 to access your account
 
  
When successfully connected you will see the Remotelock account you are connected to.
+
= Set Up =
 +
'''Step 1:  Connect your Nuki 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.
  
*The "Pin Strategy" defines how the access code is constructed.  
+
[[Image:nuki_auth.png|500px|link=]]
 +
[[Media:nuki_auth.png|view large]]
 +
 
 +
'''Step 2: Set when bookings should send to locks'''
 
*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"
 
You will see one serial number for each lock. Click on  the serial number of the lock that is using the lock.
 
  
[[Image:agoda_room_mapping.png|500px|link=]]
+
'''Step 3: Map your locks to your rooms'''
[[Media:agoda_room_mapping.png|view large]]
 
  
 +
Bookings will be sent to the lock mapped to the room assigned to the booking, if there is no lock mapped for the room the booking will be sent to the common lock (if one is mapped).
 +
If both a room lock and a common lock are mapped, the booking will be sent to both.
 +
The room lock and the common lock will use the same PIN.
 +
Multiple common locks can be specified with a space between each of the lock mapping codes.
  
If you have a common lock for multiple units you can enter the same lock serial number for each unit.
+
*Click on "Get Codes"
 +
You will see one identifier and name for each lock.
 +
Select the correct lock and save.
  
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_mapping1.png|500px|link=]]
 +
[[Media:nuki_mapping1.png|view large]]
  
== 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.
 
  
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.
+
For each room/unit click on the name of the lock that is associated with the room.
  
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")
+
[[Image:nuki_mapping.png|500px|link=]]
 +
[[Media:nuki_mapping.png|view large]]
  
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".
+
'''Step 4: Set up an Auto Action Email  to send the PIN to guests'''
  
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.  
+
*Go to  {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS.
 +
*Create an Auto Action Email which includes the template variable for the pin which is [BOOKINGINFOCODETEXT:NUKI_PIN].
  
If bookings are cancelled we delete the guest out of LOCKSTATE. This will remove the access.
+
'''Step 5: Activation'''
 +
*Tick "Code" if you grant access via keypad
 +
*Tick "App" if you grand access via the Nuki app
 +
*Tick "Code" and "App" if you grant access both via keypad and via the Nuki app
  
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.
+
= How it works =
 +
== Syncing ==
 +
Bookings are automatically sent to locks  the number of "Days in Advance" prior to check-in which you have selected.  
  
The template variable for the pin is [BOOKINGINFOCODETEXT:LOCKSTATE_PIN].
+
Entry codes/users can only be used during the booking period, they will not provide access before or after.
  
== Auto Check-in ==
+
*Updates to locks are sent periodically. To instantly send updates, click "Send Bookings to Locks".
Auto check-in will add a booking info item called CHECKIN to the booking when the guest first uses the lock.
+
*An entry code/user named Booking:{booking number} is added to the lock. Click on the "View Bookings in Locks" button to check which bookings have already been sent. You can also see bookings on [https://web.nuki.io/#/pages/smartlocks web.nuki.io] or in the Nuki app.
To use auto check-in you must setup a webhook to send notifications from the lock to Beds24.
+
*A booking info code named NUKI_PIN is created on the "Info" tab of the booking, this will show the access code for the booking.
 +
*If a keypad code, booking date, or room changes, those details will be sent to locks.
 +
*If a booking is cancelled, the associated entry code or user will be deleted from locks.
 +
*The associated entry code or user of a booking sent from Beds24 will be removed one day after check-out.  
  
There are two steps to the webhook setup:
+
<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.
  
1) Add a Webhook Notification Contact in Remotelock
+
== App and code entry methods ==
 +
There are two ways bookings can be sent to locks: app and code. You can select one or both methods.
  
the URL of the webhook must contain your Beds24 ownerId number at the end like ?ownerid=12345
+
=== App entry ===
 +
If the "App' tickbox is selected, bookings will be sent to locks as users.
  
https://api.beds24.com/lockstate.com/notify.php?ownerid=<Your Beds24 owner ID>
+
*Nuki will send guests an email containing an invitation, guests who accept this invitation will be able to unlock the Nuki lock using 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  Beds24 Nuki integration at  {{#fas:cog}} (SETTINGS) APPS & INTEGRATIONS > NUKI and click "Send bookings to Locks". This will cause Nuki to create a new user and send a new invitation to the guest.
 +
*When the user is deleted from the lock, Nuki will send an email to the guest informing them that they no longer have access to the lock.
  
The Content Type must be "JSON"
+
[[Image:nuki_delete_user.png|900px|link=]]
 +
[[Media:nuki_delete_user.png|view large]]
  
The secret can be left empty
+
=== Code entry ===
 +
If the "Code" tickbox is selected, bookings will be sent to locks as entry codes.
  
2) Add a Notification in Remotelock
+
Guests will need to enter these codes on a Nuki keypad to unlock the associated Nuki lock.
  
The notification type is "Webhook"
+
=== Manually changing codes ===
 +
# Navigate to  {{#fas:cog}} (SETTINGS) 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]]
  
The Webhook Notification Contact is the contact you created in step 1)
+
Nuki keypad codes must:
 +
# Be exactly six digits long.
 +
# Not contain the number zero.
 +
# Not start with "12".
 +
# Be unique to the lock.
  
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. Each code can only be used once per lock. Before you can reuse a code it has to be removed from the lock.
  
The Events must be "Access Granted" and "First Access Only"
+
= Troubleshooting =
  
== Common Problems ==
+
'''Bookings are not being sent to locks and cannot be viewed by clicking the view bookings in locks button'''
Lockstate have two types of access: users and guests. Bookings from Beds24 create guests.  
+
Your account may not be properly authenticated.
 +
1. Click "Disconnect"
 +
2. Click "Connect to Nuki"
 +
3. Sign in to your Nuki account if prompted and allow Beds24 access.
  
== Disconnect==
+
= Disconnect=
 
Click on "Disconnect" to terminate the connection.
 
Click on "Disconnect" to terminate the connection.
 
</div ">
 

Revision as of 08:52, 8 August 2021

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

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

  • Nuki smartlocks can store a maximum of 100 entry codes at a time.
  • Booking names in Nuki smartlocks have a maximum length of 20 characters and guest names may be cut off. This will not be visible to guests, only users with access to Nuki web will be able to view booking names.

3 What you need

To use this service you will need:

  • At least one Nuki Smart Lock.
  • A nuki.io account.

Using keypad codes requires a Nuki keypad to be setup.

4 Set Up

Step 1: Connect your Nuki 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

Step 2: Set when bookings should send to locks

  • 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.

Step 3: Map your locks to your rooms

Bookings will be sent to the lock mapped to the room assigned to the booking, if there is no lock mapped for the room the booking will be sent to the common lock (if one is mapped). If both a room lock and a common lock are mapped, the booking will be sent to both. The room lock and the common lock will use the same PIN. Multiple common locks can be specified with a space between each of the lock mapping codes.

  • Click on "Get Codes"

You will see one identifier and name for each lock. Select the correct lock and save.


Nuki mapping1.png view large


For each room/unit click on the name of the lock that is associated with the room.

Nuki mapping.png view large

Step 4: Set up an Auto Action Email to send the PIN to guests

  • Go to (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS.
  • Create an Auto Action Email which includes the template variable for the pin which is [BOOKINGINFOCODETEXT:NUKI_PIN].

Step 5: Activation

  • Tick "Code" if you grant access via keypad
  • Tick "App" if you grand access via the Nuki app
  • Tick "Code" and "App" if you grant access both via keypad and via the Nuki app

5 How it works

5.1 Syncing

Bookings are automatically sent to locks the number of "Days in Advance" prior to check-in which you have selected.

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

  • Updates to locks are sent periodically. To instantly send updates, click "Send Bookings to Locks".
  • An entry code/user named Booking:{booking number} is added to the lock. Click on the "View Bookings in Locks" button to check which bookings have already been sent. You can also see bookings on web.nuki.io or in the Nuki app.
  • A booking info code named NUKI_PIN is created on the "Info" tab of the booking, this will show the access code for the booking.
  • If a keypad code, booking date, or room changes, those details will be sent to locks.
  • If a booking is cancelled, the associated entry code or user will be deleted from locks.
  • The associated entry code or user of a booking sent from Beds24 will be removed one day after check-out.

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.2 App and code entry methods

There are two ways bookings can be sent to locks: app and code. You can select one or both methods.

5.2.1 App entry

If the "App' tickbox is selected, bookings will be sent to locks as users.

  • Nuki will send guests an email containing an invitation, guests who accept this invitation will be able to unlock the Nuki lock using 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 at (SETTINGS) APPS & INTEGRATIONS > NUKI and click "Send bookings to Locks". This will cause Nuki to create a new user and send a new invitation to the guest.
  • When the user is deleted from the lock, Nuki will send an email to the guest informing them that they no longer have access to the lock.

Nuki delete user.png view large

5.2.2 Code entry

If the "Code" tickbox is selected, bookings will be sent to locks as entry codes.

Guests will need to enter these codes on a Nuki keypad to unlock the associated Nuki lock.

5.2.3 Manually changing codes

  1. Navigate to (SETTINGS) 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

Nuki keypad codes must:

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

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. Each code can only be used once per lock. Before you can reuse a code it has to be removed from the lock.

6 Troubleshooting

Bookings are not being sent to locks and cannot be viewed by clicking the view bookings in locks button
Your account may not be properly authenticated.
1. Click "Disconnect"
2. Click "Connect to Nuki"
3. Sign in to your Nuki account if prompted and allow Beds24 access.

7 Disconnect

Click on "Disconnect" to terminate the connection.