The Keyplan integration connects bookings from our booking system with Keyplan. This allows booking data to be used for facility management and operational tasks within Keyplan. This article explains how to set up the Keyplan integration, configure products and connect objects.
Set up the Keyplan integration
First, request an API user from Keyplan specifically for the integration with our booking system.
Click New configuration in the top-right corner.
Enter the details provided by Keyplan.
Under 'Create number of days before arrival within Keyplan', enter the desired number of days. A common setting is 30 days.
Leave 'Active' disabled until the integration has been fully configured.
Click Save changes.
After saving, you will return to the overview of your Keyplan configurations. Edit the configuration you just created, click Synchronize configuration and then click Save changes again.
Important: If you receive an error message, check that all details have been entered correctly and that the API user has the required permissions. Contact Keyplan if necessary.
Configure products for Keyplan
After setting up the integration, you can configure which Keyplan products should be linked to bookings. First, import the products from Keyplan.
Select Products for the relevant configuration.
Click Import products to retrieve the latest products from Keyplan.
You can then configure the products as required:
Click Edit next to the product you want to configure.
Choose how the product should be added:
Product is added based on options and surcharges: the product is only added when the linked options or surcharges have been booked.
Product is added for all reservations: the product is added to every booking.
Configure additional conditions if required:
'Only add to owner reservations': the product is only added to bookings made by an owner.
'Do not add to owner reservations': the product is not added to bookings made by an owner.
'Only add for reservations with specific accommodations': the product is only added to bookings for selected accommodations.
Repeat these steps for each Keyplan product you want to use.
Connect objects to Keyplan
You can create new objects in Keyplan or connect existing Keyplan objects. Connecting existing objects allows you to retain their existing history in Keyplan.
Create multiple new objects
Click Objects for the relevant configuration.
If required, filter by accommodation category and click View results.
Select the desired location(s) on the left.
Click Edit objects at the top.
Select Connect.
Select an object group and a location (park).
Click Save.
Create one new object
If you only want to create one object, you can do this directly from the relevant location.
Select Objects for the relevant configuration.
Click Connect next to the desired location.
Select Create a new Keyplan object.
If required, change the object's name, number and capacity.
Click Save changes.
Link an existing Keyplan object
Do you want to retain the existing history of an object in Keyplan? Connect the location to the existing Keyplan object.
Select Objects for the relevant configuration.
Click Connect next to the desired location.
Select Link existing Keyplan object.
Enter the object's external ID. You can find this ID in Keyplan.
Click Check. The system will verify whether the ID is valid.
Click Save changes.