Our WebLink Plugin allows you to quickly and easily link your website(s) with Administrate. You will then be able to display upcoming Events and Course information, receive online course bookings, send automatic invoices and receive instant payments from your customers. By having this link between your website and Administrate, you also remove the need to duplicate data entry whenever your Course or Event details change.
WebLink functions through the use of Widgets , a small software application that can be installed and executed within a web page .
Administrate widgets can be seen working on our example pages . These are to display functionality and are not styled. However, you would be able to apply your own styling using CSS.
When displaying Course dates, as defined by Multi-session Courses, you can hover over the dates to view the sessions. This will allow the user to clearly see which dates the sessions will be held for that Event.
To use Administrate’s WebLink you will need:
- An active Administrate account
- An API user with API key (see below, Administrate Setup )
- A web host with your website deployed
- jQuery 1.10 (included in the WebLink)
Within the Administrate application you’ll need to create an API user:
- Navigate: Control Panel → Users . Select the WEB Users tab.
- Click +Add WEB User
- In the Product field, select the web integration method: WebLink
- Enter the other details as appropriate
- Click Save
Your WebLink API key will now be displayed. You will use this API key to set the api_key configuration item in the setup below.
Every page of your website that will display an Administrate widget will need to have the Administrate Weblink setup code. It is not important where this code goes on your page.
A sample of this setup code is included below. You can update the “var administrate” portion of this code to include various configuration items that will control how data is displayed through widgets. Configuration items can also be added to the individual widgets themselves. See Configuring WebLink to better understand how and where configuration options are added.
This example will connect to a demo database until the ‘Demo’ portion of the api_key configuration item is updated to include the unique API Key you created in Administrate Setup in the Administrate application.
This example assumes you are based in the UK, using GBP as your currency, and are using PayPal to process online payments. Please update to include the correct currency code, default country and payment processor if this is not the case. For more information on these configuration items and others, see the documentation below that outlines each available configuration item for every widget.
Repeat the steps below for each widget that you wish to install. You can install each widget as many times as you like using the configuration options to vary the output.
Paste the widget code that you require from the widgets section below e.g.:
<div class="administrate-widget" id="widget" data-administrate-event-list=""></div>
If you wish to change the widget’s configuration or edit the widget:
<div class="administrate-widget" id="widget" data-administrate-event-list="show_codes=true/false|show_sold_out=true/false"></div>
Add style to your widgets:
<div style="width:1000px" class="administrate-widget" id="widget" data-administrate-event-list="show_codes=true/false|show_sold_out=true/false"></div>
On the Event’s screen in Administrate, you can define a ‘Registration Deadline.’ When set, the Registration Deadline becomes the last available date to checkout. Thereafter, the Event won’t display on your website.
By default, WebLink will display an event based on the Event’s Learning Mode . Events with a Classroom or Blended Learning Mode will be displayed on your website up until the start date of the Event. Events with a Self-Paced (LMS) Learning Mode will be displayed on your website up until the end date of the Event. If there is no end date set for an LMS Event, the Event will be displayed on your website indefintely.
The Registration Deadline is defined in UTC and can be before - or after - the Event starts. This means you can close registration for an Event a few days early, or let clients register to an Event a few days after it has started. When set, this will show on the Event list, table and slider, in addition to the title, start date, price, etc.
By default, the Registration Deadline is displayed in UTC, but this can be configured using the registration_deadline_timezone option, which is detailed in the options list for the Event Table Widget .
When you have Events that use different currencies, your website visitors will be able to select by which currency they wish to view Events. For example, if you are a UK business but you also run Events in the US, or provide pricing in USD for online events, then your visitors will be able to filter your events by those purchasable in USD.
If your payment processor, e.g. SagePay, Authorize.Net, etc. only allows a single currency, then you may have to set up another different payment processor for the different currencies you offer payment in, or use a multi-currency payment processor. See widget, Checkout , for more information on how to set up a currency list.
WebLink functions through the use of widgets, which are essentially small applications launched within web pages. Below are the widgets available to you through WebLink:
|Category||Displays the details of a specific Course Category .|
|Category List||Displays a list of all your Course Categories .|
|Subcategory||Displays the detail of any given Course Subcategory.|
|Subcategory List||Displays a list of all Course Subcategories.|
|Checkout||Displays the checkout for an order to be placed on Administrate.|
|Course||Displays the details of any given Course .|
|Course List||Displays a list of all Courses .|
|Event List||Displays a list of Events in chronological order.|
|Event Slider||Displays 4 Events at a time within a sliding table.|
|Event Table||Displays a table of Events in chronological order.|
|Learning Track List||Displays and allows checkout of Learning Tracks defined in Administrate.|