What is the Plugin?
General
Temando provides a plugin facility for external websites to plug our booking service into their site. There are numerous methods of achieving this and also for controlling the display or actions taken by the plugin.
The following details all this information.
Plugin methods
Embedded
A website can embed the booking service into their page using an iframe. For the best display the size of the iframe should be width of the 650 and a height of 500.
Example (the "successPage" would be a page of your choosing):
<iframe src="https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html" width="650" height="500"><p>Your browser does not support iframes. You will be required to upgrade your browser before you can proceed with this step.</p></iframe>
Pop-Up
A website can provide the booking service via a popup window. For the best display the size of the popup window should be width of the 650 and a height of 520.
Example (the "successPage" would be a page of your choosing):
<a href="JavaScript:window.open ('https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html' ,'mywindow','width=650,height=520,toolbar=no,location=no,directories=no, status=yes,menubar=no,scrollbars=yes,copyhistory=no,resizable=no');"> Click here to send your freight</a>
Redirect
A website can provide the booking service via a redirect. By doing this the user will be redirected away from your website but returned after the booking process has completed.
Example (the "successPage" would be a page of your choosing):
<a href="https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html">Click here to send your freight</a>
The url to be supplied to any of the methods used is https://www.temando.com/plugin/request.html.
Various control variables can also be supplied as parameters. These allow you to control how the plugin will behave (eg. redirects to a certain page on success) or to autopopulate certain fields, which also lock the fields preventing usres from changing the value (eg. origin location). See Controlling the Plugin below for further details.
A working example page is available to view each of these methods in action. Click here to view this site.
Controlling the Plugin
There are 2 types of controls that can be provided to the plugin via the url (as parameters): behaviour controls and autopopulate controls.
To specify a control you simply add the details to the plugin url. The details are the name of the control and assigning a value.
For example, if you want the plugin to redirect to the page http://www.mysite.com/bookingSuccessPage.html once the user has booked their freight successfully and redirect to the page http://www.mysite.com/bookingFailurePage.html if there was an error or the user decided to cancel out of the booking process then the url would be:
https://www.temando.com/plugin/request.html?successPage=http%3A%2F%2Fwww.mysite.com%2FbookingSuccessPage.html&cancelPage=http%3A%2F%2Fwww.mysite.com%2FbookingFailurePage.html&errorPage=http%3A%2F%2Fwww.mysite.com%2FbookingFailurePage.html
You may have noticed that certain characters were changed (eg. http:// was changed to http%3A%2F%2F). This is because certain characters must be escaped to prevent them from being interpretted incorrect. A list of what characters must be escaped is available from here.
Behaviour Controls
Behaviour controls allow you to specify how the plugin will behave. This includes things such as: what page the plugin should redirect to once the user has completed their booking, the redirect page for failure, etc.
See List of Controls for a complete list of these controls.
AutoPopulate Controls
AutoPopulate controls allow you to specify values for fields requiring input from the user. If a value has been supplied then the field will also be locked preventing the user from changing it. The advantage behind locking the fields is that you can control certain details of the booking. For example, if a user of your site has purchased an item you may want to predefined (ie. autopopulate) the details of the item, rather then allowing them to enter this information themselves (possibly resulting in human errors).
See List of Controls for a complete list of these controls.
List of Controls
The following details all the controls that can be provided as parameters to the plugin's url.
Note: all assigned values must have special characters escaped (eg. ':', '/', etc). A list of what characters must be escaped is available from here.
Behaviour Controls
