Category:Developers: Difference between revisions

Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(24 intermediate revisions by 4 users not shown)
Line 8: Line 8:
  This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE  >  PROPERTY BOOKING PAGE > DEVELOPERS
  This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE  >  PROPERTY BOOKING PAGE > DEVELOPERS


The booking page can be embedded in a page using an Iframe or opened with a link or form.  It can be fully customised in  This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE. This  [[Customise_Booking_Page|page]] gives an overview. Additional options for developers are:
The booking page can be embedded in a page using an Iframe or opened with a link or form.  It can be fully customised.
This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE. This  [[Customise_Booking_Page|page]] gives an overview. Additional options for developers are:


== Custom Text ==
== Custom Text ==
Line 31: Line 32:
https://yoursite/path/your.css
https://yoursite/path/your.css


Goto this site and encode it:
Go to this site and encode it:
http://meyerweb.com/eric/tools/dencoder/
http://meyerweb.com/eric/tools/dencoder/


Line 50: Line 51:
For example: this would cause property 1234 to open in the parent window (frame busting) when it's book button is clicked on the multiple property page
For example: this would cause property 1234 to open in the parent window (frame busting) when it's book button is clicked on the multiple property page


<script>
<code><script>
$(document).ready(function(){
$(document).ready(function(){
$('#propid1234 a').attr('target', '_parent');
$('#propid1234 a').attr('target', '_parent');
});
});
</script>
</script></code>


<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Check the settings under  {{#fas:cog}} (SETTINGS) >BOOKING ENGINE  >  PROPERTY BOOKING PAGE > BEHAVIOUR before you add such a script.
<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Check the settings under  {{#fas:cog}} (SETTINGS) >BOOKING ENGINE  >  PROPERTY BOOKING PAGE > BEHAVIOUR before you add such a script.


=== Change the title text ===
=== Change the title text ===
javascript to change the titletext
Javascript to change the titletext.


<code> <script>document.title='your title';</script></code>
<code><script>document.title='your title';</script></code>


== Booking Page Parameters ==
=== Change date format  ===
Javascript to change the date format.
 
 
<code><script>
$(document).ready(function(){
 
$('#inputcheckin').data('date-format','MMMM DD, YYYY');
$('#inputcheckout').data('date-format','MMMM DD, YYYY');
})
</script></code>
 
<code><script>
window.onload = function() {
$("[id^='ptdate']").text(function(i, t) {
return t.split(' ').reverse().join(' ');
})
};


*The behavior of the booking page can be controlled with the following parameters passed in the URL or form. URL Parameters are always added in the format name=value. To separate them, the first parameter must have a ? before it and all following parameters must have an & before them. For example if you want to change the default for the numbers of night selector to 7 nights you change the link to your booking page from
window.onunload = function(){};
</script></code>


https://beds24.com/booking2.php?propid=2047
=== Change the first day of the week in the datepicker===
The start day of the week in the checkin and checkout selectors is set automatically based on the language selected by the guest, different languages have different standards for this.
It is possible to override it on a per language basis.


to
This example changes English to start on Monday, The value of dow can be from 0 to 6 where 0 is Sunday.
If you want to change multiple languages you would need to include a script for each language.


https://beds24.com/booking2.php?propid=2047&numnight=7
<code><script>
moment.updateLocale("en", { week: {
dow: 1
}});
</script></code>


== Booking Page Parameters ==


'''Example: hide header'''
The behavior of the booking page can be controlled with the following parameters passed in the URL or form. URL Parameters are always added in the format name=value. To separate them, the first parameter must have a ? before it and all following parameters must have an & before them. For example if you want to change the default for the numbers of night selector to 7 nights you change the link to your booking page from


https://beds24.com/booking2.php?propid=2047
https://beds24.com/booking2.php?propid=2047
Line 80: Line 107:
to
to


https://beds24.com/booking2.php?propid=2047&hideheader=yes
https://beds24.com/booking2.php?propid=2047&numnight=7
 


Example: Make a booking page for selected rooms only
Example: Make a booking page for selected rooms only
Line 144: Line 172:


|-
|-
| roomid || id number of room. || The page will open showing this room.  
| advancedays  || number of days  || This will set the initial date to this many days in advance of today. Only applies the first time the page is opened. If advancedays is not used the initial date will be the current date. The first date with availability can be specified by setting advancedays to the value -1.


|-
|-
| propid || id number of property. || The page will open showing this property.
| checkin || check-in full date || The page will open at this check-in date
 


|-
|-
| ownerid || id number of owner.  || The page will open showing all properties and rooms for this owner
| cssfile  ||encoded url || External css file for inclusion in booking page, the file must be available via a secure url (https) and the url must be url encoded. (http://meyerweb.com/eric/tools/dencoder/)


|-
|-
| checkin || check-in full date || The page will open at this check-in date
| cur  ||AUD, CAD, EUR, GBP, NZD, USD, BGN, BRL, CHF, CNY, CZK, DKK, EEK, HKD, HRK, HUF, IDR, INR, JPY, KRW, MXN, MYR, NOK, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, VND, ZAR|| Opens the page showing the currency converted. (responsive booking page only)
 
|-
| mobile=0  || desktop view  || Display the booking page in desktop view
 


|-
|-
Line 171: Line 194:
|-
|-
| fdate_year || check-in year || The page will open at this check-in date, must be used with fdate_date and fdate_month and be in the format YYYY
| fdate_year || check-in year || The page will open at this check-in date, must be used with fdate_date and fdate_month and be in the format YYYY


|-
|-
| mobile=1 || mobile view  || Display the booking page in mobile view
| group  || keyword || Show only properties that have this group keyword


|-
|-
| numnight || number of nights || Initial value for the number of nights selector
| hidefooter ||yes, no || Do not show the property information at the bottom of the page


|-
|-
| numadult || number of adults || Initial value for the number of adults selector
| hideheader ||yes, no || Do not show the property information at the top of the page. Do not use this option when using a "Full Width Slider".


|-
| numchild  || number of children  || Initial value for the number of children selector


|-
|-
| width || page width in px || Useful for embedding the booking page in an Iframe of fixed size
| hideoffer  ||1,2,3,4 || Do not show this offer on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
| numdisplayed || number of nights with prices displayed || Only applies to price table pages, use this to reduce the number of nights for narrow designs
| hideprop ||property id || Do not show this property on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
| referer || text ||This text will be recorded with any bookings originating from this widget allowing tracking of booking sources
| hideroom ||room id || Do not show this room on the booking page, multiple id's can be specified with a comma separating them.


|-
|-
Line 197: Line 219:


|-
|-
| advancedays || number of days || This will set the initial date to this many days in advance of today. Only applies the first time the page is opened. If advancedays is not used the initial date will be the current date. The first date with availability can be specified by setting advancedays to the value -1.
| lang ||en (English), ar (Arabic), bg (Bulgarian), ca (Catalan), hr (Croatian), cs (Czech), da (Danish), de (German),  el (Greek),  es (Spanish), et (Estonian),  fi (Finnish),  fr (French),  he (Hebrew), hu (Hungarian), hy (Armenian), id (Indonesian - Bahasa Indonesia), is (Icelandic), it (Italian), ja (Japanese), ko (Korean), lt (Lithuanian), lv (Latvian) mn (Mongolian), my (Burmese), nl (Dutch), no (Norwegian), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian),  sk (Slovak), sl (Slovenian), sr (Serbian), sv (Swedish), th (Thai), tr (Turkish), vi (Vietnamese),  zh (Chinese simplified),  zt (Chinese traditional) || Sets the default language to open the booking page. (2013 new style booking pages only)


|-
|-
| layout  ||1, 2, 3, 4, 5, 6,  || Opens the responsive version of the booking page in this layout.
| layout  ||1, 2, 3, 4, 5, 6,  || Opens the responsive version of the booking page in this layout.


|-
|-
| hideheader ||yes, no  || Do not show the property information at the top of the page
| maxprop ||number of properties || Show a maximum of this many properties based on the sort order. Additional properties are hidden.
 


|-
|-
| hidefooter ||yes, no  || Do not show the property information at the bottom of the page
| maxroom ||number of rooms || Only show a maximum of this many rooms based on the sort order. Additional rooms are hidden.
 
|-
| mobile=1 || mobile view  || Display the booking page in mobile view
 
|-
| mobile=0  || desktop view  || Display the booking page in desktop view


|-
|-
Line 212: Line 242:


|-
|-
| lang ||en (English), ar (Arabic), bg (Bulgarian), ca (Catalan), hr (Croatian), cs (Czech), da (Danish), de (German),  el (Greek),  es (Spanish), et (Estonian),  fi (Finnish),  fr (French),  he (Hebrew), hu (Hungarian), id (Indonesian - Bahasa Indonesia), is (Icelandic), it (Italian), ja (Japanese), ko (Korean), lt (Lithuanian), mn (Mongolian), my (Burmese), nl (Dutch), no (Norwegian), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian),  sk (Slovak), sl (Slovenian), sr (Serbian), sv (Swedish), th (Thai), tr (Turkish), vi (Vietnamese),  zh (Chinese simplified),  zt (Chinese traditional) || Sets the default language to open the booking page. (2013 new style booking pages only)
| numnight || number of nights || Initial value for the number of nights selector


|-
|-
| hideprop ||property id || Do not show this property on the booking page, multiple id's can be specified with a comma separating them.
| numadult || number of adults || Initial value for the number of adults selector
 
|-
| numchild  || number of children  || Initial value for the number of children selector
 
 
|-
| numdisplayed  || number of nights with prices displayed  || Only applies to price table pages, use this to reduce the number of nights for narrow designs


|-
|-
| maxprop ||number of properties || Show a maximum of this many properties based on the sort order. Additional properties are hidden.
| nogroup || keyword || Exclude properties that have this group keyword
 


|-
|-
| hideroom  ||room id  || Do not show this room on the booking page, multiple id's can be specified with a comma separating them.
| ownerid || id number of owner. || The page will open showing all properties and rooms for this owner


|-
|-
| maxroom  ||number of rooms || Only show a maximum of this many rooms based on the sort order. Additional rooms are hidden.  
| propid || id number of property. || The page will open showing this property.  


|-
|-
| hideoffer ||1,2,3,4  || Do not show this offer on the booking page, multiple id's can be specified with a comma separating them.
| redirect ||encoded url || Redirect to this url, must start with http:// or https:// and be url encoded with a tool like http://meyerweb.com/eric/tools/dencoder/. The booking details are stored in session variables and will be available available to a booking page in an Iframe at your redirect URL as long as the Iframe is not overriding them in it's src url.


|-
|-
| group || keyword || Show only properties that have this group keyword
| referer || text  ||This text will be recorded with any bookings originating from this widget allowing tracking of booking sources


|-
|-
| nogroup  || keyword || Exclude properties that have this group keyword
| roomid || id number of room. || The page will open showing this room.


|-
|-
| cssfile  ||encoded url || External css file for inclusion in booking page, the file must be available via a secure url (https) and the url must be url encoded. (http://meyerweb.com/eric/tools/dencoder/)
| toproom || room always shown on the top of the bookingpage  || you can add mulitpel room IDs separated by a comma (resposive booking page only)  


|-
|-
| cur  ||AUD, CAD, EUR, GBP, NZD, USD, BGN, BRL, CHF, CNY, CZK, DKK, EEK, HKD, HRK, HUF, IDR, INR, JPY, KRW, MXN, MYR, NOK, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, VND, ZAR|| Opens the page showing the currency converted. (responsive booking page only)
| voucher || voucher code  || Pre populates the discount voucher code


|-
|-
| redirect  ||encoded url || Redirect to this url, must start with http:// or https:// and be url encoded with a tool like http://meyerweb.com/eric/tools/dencoder/. The booking details are stored in session variables and will be available available to a booking page in an Iframe at your redirect URL as long as the Iframe is not overriding them in it's src url.
| width || page width in px  || Useful for embedding the booking page in an Iframe of fixed size


|}
|}
Line 275: Line 313:


To use the API you need to allow API access. Go to  This page is about the menu {{#fas:cog}} (SETTINGS) > ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com. The XML functions can be accessed with your Beds24 username and password. The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel  This page is about the menu {{#fas:cog}} (SETTINGS) > ACCOUNT and  This page is about the menu {{#fas:cog}} (SETTINGS) > PROPERTIES > ACCESS
To use the API you need to allow API access. Go to  This page is about the menu {{#fas:cog}} (SETTINGS) > ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com. The XML functions can be accessed with your Beds24 username and password. The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel  This page is about the menu {{#fas:cog}} (SETTINGS) > ACCOUNT and  This page is about the menu {{#fas:cog}} (SETTINGS) > PROPERTIES > ACCESS
==Skip to Checkout Page from Beds24 Plugin Widget==
You can  bypass the booking page and redirect the widget directly to the checkout page by adding this parameter
<code>customParameter:'br1-xxxx=book'</code>
to the widget.
Replace xxxx with the room ID of the room you want to populate.
== Create a website with the content in your Beds24 account ==
We have an integration with Rezintel which allows users/developers to create a website with the data you have in Beds24.
Go to [https://wiki.beds24.com/index.php/Rezintel_Website_Builder Website builder] for more details.
== Suppress Google Translate==
Add the following in the "Head" section:
<code><meta name=“google” content=“notranslate”>
<html translate=“no”></code>
Retrieved from "https://wiki.beds24.com/index.php/Category:Developers"