Difference between revisions of "Category:Developers"

From Beds24 Wiki
Jump to navigation Jump to search
m (1版 をインポートしました)
Beds24>Annette
Line 4: Line 4:
 
[[Category:Widgets]]
 
[[Category:Widgets]]
 
[[Category:Booking Page]]
 
[[Category:Booking Page]]
−
  ''This page is about the menu SETTINGS -> BOOKING PAGE -> DEVELOPERS''
+
[[Category:Booking_Engine]]
−
Code snippets for the booking page are available in SETTINGS->BOOKING PAGE.
+
<div class="heading">Developer Options</div>
 +
  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 SETTINGS->BOOKING PAGE. 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 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:
  
 
== Custom Text ==
 
== Custom Text ==
−
Any fixed text on the booking page can be exchanged in SETTINGS->BOOKING PAGE ->DEVELOPERS "Custom Text"
+
Any fixed text on the booking page can be exchanged in This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE  >  PROPERTY BOOKING PAGE > DEVELOPER > "Custom Text"
 +
 
 +
For more information please read the context help (?).
  
 
== Custom CSS ==
 
== Custom CSS ==
  
−
  Custom CSS can be added in SETTINGS > BOOKING PAGE > DEVELOPERS > "Custom CSS"
+
<span class="" style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Custom CSS can be added in This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE  > PROPERTY BOOKING PAGE > DEVELOPERS > "Custom CSS"
  
 
To see a list of CSS examples look into this document: [[Custom_CSS|Custom CSS]]
 
To see a list of CSS examples look into this document: [[Custom_CSS|Custom CSS]]
Line 21: Line 24:
 
It is possible to make the booking page use a CSS file that you supply, you must host the CSS file on a secure web server (using https:).
 
It is possible to make the booking page use a CSS file that you supply, you must host the CSS file on a secure web server (using https:).
  
−
To do this you need to add the &cssfile parameter to the URL for the booking page, or for example the iframe SRC.
+
To do this you need to add the &cssfile parameter to the URL for the booking page, or for example the Iframe SRC.
  
 
You could do this to use different styling per page or site.
 
You could do this to use different styling per page or site.
Line 35: Line 38:
  
 
Your CSS file will be included.
 
Your CSS file will be included.
−
Note:
+
 
−
  The external stylesheet needs to be hosted on a secure site (https) to be accepted by the secure Beds24 booking page.
+
<span class="" style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> The external stylesheet needs to be hosted on a secure site (https) to be accepted by the secure Beds24 booking page.
  
  
Line 42: Line 45:
  
 
== Javascript ==
 
== Javascript ==
−
Javascript can be entered in SETTINGS->BOOKING PAGE ->DEVELOPERS"Advanced HTML Settings"
+
Javascript can be entered in This page is about the menu {{#fas:cog}} (SETTINGS)> BOOKING ENGINE  > PROPERTY BOOKING PAGE > DEVELOPERS or in {{#fas:cog}} (SETTINGS) >BOOKING ENGINE > MULTI BOOKING PAGE> DEVELOPER "Advanced HTML Settings"
 +
 
 +
=== Redirects ===
 +
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>
 +
$(document).ready(function(){
 +
$('#propid1234 a').attr('target', '_parent');
 +
});
 +
</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
−
<script>document.title='your title';</script>
+
 
 +
<code> <script>document.title='your title';</script></code>
  
 
== Booking Page Parameters ==
 
== Booking Page Parameters ==
Line 52: Line 67:
 
*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  
 
*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://www.beds24.com/booking2.php?propid=2047
+
https://beds24.com/booking2.php?propid=2047
  
 
to
 
to
  
−
https://www.beds24.com/booking2.php?propid=2047&numnight=7
+
https://beds24.com/booking2.php?propid=2047&numnight=7
  
  
 
'''Example: hide header'''
 
'''Example: hide header'''
  
−
https://www.beds24.com/booking2.php?propid=2047
+
https://beds24.com/booking2.php?propid=2047
  
 
to
 
to
  
−
https://www.beds24.com/booking2.php?propid=2047&hideheader=yes
+
https://beds24.com/booking2.php?propid=2047&hideheader=yes
  
 
Example: Make a booking page for selected rooms only
 
Example: Make a booking page for selected rooms only
Line 71: Line 86:
 
Use the propid to open the page and add &hideroom=22543 to hide a room. You can hide multiple rooms by comma separating them.
 
Use the propid to open the page and add &hideroom=22543 to hide a room. You can hide multiple rooms by comma separating them.
  
−
https://www.beds24.com/booking2.php?propid=2048&hideroom=3589,3588
+
https://beds24.com/booking2.php?propid=2048&hideroom=3589,3588
  
  
 
'''Example: link to the booking page with dates pre populated:'''
 
'''Example: link to the booking page with dates pre populated:'''
  
−
https://www.beds24.com/booking2.php?propid=13437&checkin=2017-8-24&numnight=3
+
https://beds24.com/booking2.php?propid=13437&checkin=2017-8-24&numnight=3
  
 
exchange these values with your data:
 
exchange these values with your data:
Line 87: Line 102:
 
'''Example: Link to a booking form with dates and room pre populated:'''
 
'''Example: Link to a booking form with dates and room pre populated:'''
  
−
https://www.beds24.com/booking2.php?checkin=2017-8-24&numnight=3&numadult=2&numchild=0&br1-32919=Book&roomid=32919
+
https://beds24.com/booking2.php?checkin=2017-8-24&numnight=3&numadult=2&numchild=0&br1-32919=Book&roomid=32919
  
 
exchange these values with your data:
 
exchange these values with your data:
Line 107: Line 122:
 
Create a URL like this:
 
Create a URL like this:
  
−
https://www.beds24.com/booking2.php?propid=13434&checkin_hide=2016-11-24&numnight=2&numadult=1&br1-32906=Book
+
https://beds24.com/booking2.php?propid=13434&checkin_hide=2016-11-24&numnight=2&numadult=1&br1-32906=Book
  
 
You need to define:
 
You need to define:
Line 126: Line 141:
 
| '''Parameter''' || '''Value'''    ||'''Description'''
 
| '''Parameter''' || '''Value'''    ||'''Description'''
 
|-
 
|-
−
| https://www.beds24.com/booking.php  || Path to booking page        ||At the very minimum there must also be one of propid, roomid or ownerid parameter
+
| https://beds24.com/booking.php  || Path to booking page        ||At the very minimum there must also be one of propid, roomid or ownerid parameter
  
 
|-
 
|-
Line 170: Line 185:
  
 
|-
 
|-
−
| width || page width in px  || Useful for embedding the booking page in an iframe of fixed size  
+
| width || page width in px  || Useful for embedding the booking page in an Iframe of fixed size  
  
 
|-
 
|-
Line 179: Line 194:
  
 
|-
 
|-
−
| invoicee  || text ||Charges and payments will be assigned to this invoicee.
+
| invoicee  || integer ||Charges and payments will be assigned to this invoicee ID.
  
 
|-
 
|-
Line 197: Line 212:
  
 
|-
 
|-
−
| 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), it (Italian), ja (Japanese), 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), zh (Chinese simplified),  zt (Chinese traditional) || Sets the default language to open the booking page. (2013 new style booking pages only)
+
| 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)
  
 
|-
 
|-
Line 227: Line 242:
  
 
|-
 
|-
−
| 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.
+
| 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.
  
 
|}
 
|}
  
 
== Customise Booking Widgets ==
 
== Customise Booking Widgets ==
−
Code snippets for booking widgets are available in SETTINGS->BOOKING PAGE->BOOKING WIDGETS.
+
Code snippets for booking widgets are available in {{#fas:cog}} (SETTINGS)  BOOKING ENGINE > BOOKING WIDGETS.
  
 
You can use HTML and CSS to create custom solutions.  
 
You can use HTML and CSS to create custom solutions.  
Line 259: Line 274:
 
The documentation is directly in the API.  
 
The documentation is directly in the API.  
  
−
To use the API you need to allow API ACCES. Go to 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 SETTINGS->ACCOUNT and SETTINGS->PROPERTIES->LINK
+
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

Revision as of 10:51, 9 September 2020

Developer Options
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 page gives an overview. Additional options for developers are:

Custom Text

Any fixed text on the booking page can be exchanged in This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE > PROPERTY BOOKING PAGE > DEVELOPER > "Custom Text"

For more information please read the context help (?).

Custom CSS

{{#fas:lightbulb}} Custom CSS can be added in This page is about the menu {{#fas:cog}} (SETTINGS) > BOOKING ENGINE > PROPERTY BOOKING PAGE > DEVELOPERS > "Custom CSS"

To see a list of CSS examples look into this document: Custom CSS

External CSS file

It is possible to make the booking page use a CSS file that you supply, you must host the CSS file on a secure web server (using https:).

To do this you need to add the &cssfile parameter to the URL for the booking page, or for example the Iframe SRC.

You could do this to use different styling per page or site.

For example if your css file is: https://yoursite/path/your.css

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

Add the resulting parameter to the booking page URL like this: &cssfile=https%3A%2F%2Fyoursite%2Fpath%2Fyour.css

Your CSS file will be included.

{{#fas:lightbulb}} The external stylesheet needs to be hosted on a secure site (https) to be accepted by the secure Beds24 booking page.


Keywords: URL parameter, parameter, language, number of guests, web design, web designer, developer

Javascript

Javascript can be entered in This page is about the menu {{#fas:cog}} (SETTINGS)> BOOKING ENGINE > PROPERTY BOOKING PAGE > DEVELOPERS or in {{#fas:cog}} (SETTINGS) >BOOKING ENGINE > MULTI BOOKING PAGE> DEVELOPER "Advanced HTML Settings"

Redirects

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>
$(document).ready(function(){
$('#propid1234 a').attr('target', '_parent');
});
</script>

{{#fas:lightbulb}} Check the settings under {{#fas:cog}} (SETTINGS) >BOOKING ENGINE > PROPERTY BOOKING PAGE > BEHAVIOUR before you add such a script.

Change the title text

javascript to change the titletext

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

Booking Page Parameters

  • 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

to

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


Example: hide header

https://beds24.com/booking2.php?propid=2047

to

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

Example: Make a booking page for selected rooms only

Use the propid to open the page and add &hideroom=22543 to hide a room. You can hide multiple rooms by comma separating them.

https://beds24.com/booking2.php?propid=2048&hideroom=3589,3588


Example: link to the booking page with dates pre populated:

https://beds24.com/booking2.php?propid=13437&checkin=2017-8-24&numnight=3

exchange these values with your data:

checkin=2017-8-24 - the date the guest wants to arrive

&numnight=3 - the number of nights the guest wants to book


Example: Link to a booking form with dates and room pre populated:

https://beds24.com/booking2.php?checkin=2017-8-24&numnight=3&numadult=2&numchild=0&br1-32919=Book&roomid=32919

exchange these values with your data:

checkin=2017-8-24 - the date the guest wants to arrive

&numnight=3 - the number of nights the guest wants to book

&numadult=2 - number of adults

&numchild=0 - number of children

&br1-32919=Book - exchange 32919 with the room id the guest wants to book

&roomid=32919 - exchange 32919 with the room id the guest wants to book

Example: Booking form for a preselected room and dates

Create a URL like this:

https://beds24.com/booking2.php?propid=13434&checkin_hide=2016-11-24&numnight=2&numadult=1&br1-32906=Book

You need to define:

1) propid

2) one of checkin or checkin_hide (different date formats)

3) one of checkout, checkout_hide or numnight

4) numadult and/or numchild

5) br1-32906=Book where "br1 is offer 1, br2 is offer 2 etc. and 32906 is the room to book.


Parameter Value Description
https://beds24.com/booking.php Path to booking page At the very minimum there must also be one of propid, roomid or ownerid parameter
roomid id number of room. The page will open showing this room.
propid id number of property. The page will open showing this property.


ownerid id number of owner. The page will open showing all properties and rooms for this owner
checkin check-in full date The page will open at this check-in date
mobile=0 desktop view Display the booking page in desktop view


fdate_date check-in date of month The page will open at this check-in date, must be used with either fdate_monthyear or fdate_month and fdate_year. Must be in format DD
fdate_monthyear check-in month and year The page will open at this check-in date, must be used with fdate_date and be in the format MM-YYYY
fdate_month check-in month The page will open at this check-in date, must be used with fdate_date and fdate_year and be in the format MM
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
numnight number of nights Initial value for the number of nights selector
numadult number of adults Initial value for the number of adults selector
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
numdisplayed number of nights with prices displayed Only applies to price table pages, use this to reduce the number of nights for narrow designs
referer text This text will be recorded with any bookings originating from this widget allowing tracking of booking sources
invoicee integer Charges and payments will be assigned to this invoicee ID.
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.
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
hidefooter yes, no Do not show the property information at the bottom of the page
multiroom 0, 1 Opens the page with multi-room booking selected or unselected. (2013 new style booking page only)
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)
hideprop property id Do not show this property on the booking page, multiple id's can be specified with a comma separating them.
maxprop number of properties Show a maximum of this many properties based on the sort order. Additional properties are hidden.
hideroom room id Do not show this room on the booking page, multiple id's can be specified with a comma separating them.
maxroom number of rooms Only show a maximum of this many rooms based on the sort order. Additional rooms are hidden.
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.
group keyword Show only properties that have this group keyword
nogroup keyword Exclude properties that have this group keyword
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/)
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)
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.

Customise Booking Widgets

Code snippets for booking widgets are available in {{#fas:cog}} (SETTINGS) BOOKING ENGINE > BOOKING WIDGETS.

You can use HTML and CSS to create custom solutions.

Make Your Own Booking Widget


Wordpress

If you use the Beds24 Wordpress plugin booking widgets and booking page can be added via a short code. Options and help regarding customisation can be found directly in the plugin settings.

Old booking page only:

|- | hidename || yes, no || Do not show the property name heading

|- | hidedesc || yes, no || Do not show the description

Custom Applications / API

We also have an API which allows developers to develop their own applications and solutions.

The API functions are available at https://api.beds24.com

The documentation is directly in the API.

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

This category currently contains no pages or media.

Retrieved from "http://co-reception.com/wiki/index.php?title=Category:Developers&oldid=16089"