Configurator

Get started

Follow this guide to get a basic setup of Bookzo Elements running on your website.

1
Request API key

Contact customer support to request an API key.

Provide the following information:

  • Which Bookzo customer are you requesting the API key for?
  • At which domain name(s) will you be hosting the website?
    For example: mycustomer.com, subdomain.mycustomer.com, etc.
2
Add the script

Enable Bookzo Elements by adding this code:

<script src="https://cdn.bookzoapi.nl/bookzo-elements/bookzo-elements.js" async defer></script>
3
Add the home element

Decide which page on your website you want to use as your Bookzo home .

The Bookzo home is the page where you want to show:

  • All accommodations before the user has searched
  • Search results
  • Accommodation information after clicking on an accommodation/search result
  • The booking/reservation form
  • The thank you/error page after the booking

Add this code to the page where you want to show the home element:

<bookzo-home apikey='xxxxxxxxxxxxxxxxx'></bookzo-home>

Where xxxxxxxxxxxxxxxxx is your API key requested in step 1

4
Add the search element

When you have the home element working, it only shows all accommodations. You can go to the accommodation information page and book from there. But in most cases you will want some search functionality. To achieve this, you can add the search element.

When the search element is placed on the same page as the home element, adding this code will be enough:

<bookzo-search></bookzo-search>

When you place the search element on another page than the home element, you will need to include the API key and an URL to indicate where to go after submitting the search: the location of the home element. To generate the correct code for this scenarion, you can go to the configuration page for the search element .

How to continue?

That's it! You should now have Bookzo Elements running. Of course there's a lot more to discover and finetune. Explore all the elements and instructions by navigating this website.

Good luck & have fun!

Notes

SSL

To protect sensitive data being sent to and from the user, Bookzo Elements only works when running on SSL. In other words: your website should start with https:// for Bookzo Elements to work. This also applies to your local development server running on localhost.

Local development

On your local development server, hosted specifically on localhost, every API key will work. When deploying to an online server, the API key will only work when it is registered for the domain name(s) of the server. See step 1.