Impart Media Gadget Documentation

These are the gadgets currently available that leverage the Soap >> Json Proxy (SJP) .
Please note - Access to the SJP documentation is no longer available. All integration with the Bookeasy database is to be done via the beGadgets, as documented.

Please ensure you read all the supplied documentation through carefully before requesting assistance in managing beGadget functionality for your development.
There is an allocation of time included in the beGadgets licence for technical assistance, however this does not extend to items that are already documented.
Assistance provided for elements clearly documented may incur charges


The Gadgets

The Search Gadget

Details and options for the Search Gadget

The Region Gadget

Details and options for the Region Gadget

The Item Details and Cart Gadgets

Details and options for the Item Details and Cart Gadgets

The Booking Gadget

Details and options for the Booking Gadget

The Confirmation Gadget

Details and code sample for the Confirmation Gadget

The Auth Gadget

Details and code sample for the Auth Gadget

Initial Notes about all the Gadgets

You may notice a couple of things about the examples shown in this documentation:

More information to assist you in installing the Impartmedia beGadgets can be found here > Further beGadgets Information


Authorisation keys

When you sign up to use the Impart Media beGadgets, you will need to let us know the intended domain name of your staging site you are using for the development/testing.
We will give you an authorisation key that must be used in the script call, and will only work on that staging site domain name.

After your development process is completed, impartmedia will need to review the implementation and approve it. Once completed and all invoices are finalised, you will be provided with an API key to use for your live domain.


Common to all gadget insertions

All the gadget insertions must start with the initial call to the gadget engine code, as per this code example. Please note the key parameter at the end - this is required, and the gadgets will NOT work without it.

<script src="//gadgets.impartmedia.com/gadgets.jsz?key=yourKeyGoesHere" type="text/javascript"></script>

¡achtung! Important: “//gadgets.impartmedia.com/gadgets.js” is an integral file for the successful operation of the beGadgets and as such MUST NOT be copied or stored on an external server nor altered in any way.

After the initial gadget engine call, you then start up the gadget(s) you want:

<script type="text/javascript">
	// You would initialise one or more gadgets here
</script>

Our recommendation is that you place your gadget insert into your pages source code just before the closing </body> tag. If you do need to place the gadget insert in your head, or before the element that you wish to insert the gadget into, you will also need to wrap the gadget initialisation in a domready function call:

<script type="text/javascript">
	$w(function() {
		// You would initialise one or more gadgets here
	});
</script>

This will cause the gadget to wait until the page is ready to be manipulated. Generally, you should use the domready wrapper all the time, as this is considered the least error-prone way to start up JS code. This documentation will show the gadgets initialised inside a domready wrapper.


Re-styling the gadgets

One of the primary advantages of inserted gadgets such as these is that you,the implementer, can use CSS on your site to change and mould the appearance of the gadgets to suit your site. beGadgets are highly customisable by using only CSS styling.

To make it easy to figure out what CSS selector you need to address a particular part of a gadget, make a test page, then use Firefox and the add-on Firebug (the HTML tab). This tool is invaluable for figuring out what the DOM looks like after the gadget is running. Chrome, Safari, Opera and IE also have good developer tools.

We've created a sample CSS file that highlights the things you may want to re-style. This file is primarily a guide and only covers a few elements in each gadget, so if you're looking to restyle something that isn't in this file, check above for developer tools. You can download the sample css file here:

Sample gadget restyling CSS file


Server-side access to the data: or creating your own operator pages...

It is highly advisable that you create Operator information pages, in which to house the Details gadgets. This will increase booking rates and offer user the information they need.
If you're interested in creating your own operator pages, you can refer to a sample class we've created for you. It's in PHP, but the logic should be fairly easily transportable to your language of choice.

Sample class for accessing the SJP

It is highly recommended that you read the further information regarding creating Operator pages, which can be found here