WebLink Overview and Installation

Requirements

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)

Administrate Setup

Within the Administrate application you’ll need to create an API user:

1. Navigate: Control Panel → Users. Select the WEB Users tab.
2. Click +Add WEB User
3. In the Product field, select the web integration method: WebLink
4. Enter the other details as appropriate
5. 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.

Website Setup

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.

<!-- Administrate WebLink Setup Code -->
<script type="text/javascript">
    var administrate = {
        // API options
        api_key: 'Demo',
        currency: 'GBP',
        show_times: false,
        num_months: 6,
        show_codes: false,
        show_sold_out: true,
        no_events_message: "There are currently no scheduled events. Please contact us directly (+44 131.555.1212.) to schedule an event.",
        group_size: 100,
        show_remaining_places: false,
        payment_by_cc: true,
        payment_by_invoice: true,
        payment_processor: 'PayPal',
        terms: "Specify Terms & Conditions here or href to webpage",
        default_country: "UK"
    }
</script>
<script id="administrate-web-link" data-main="https://weblink.getadministrate.com/clients/js/init" src="https://weblink.getadministrate.com/clients/js/lib/require.js" type="text/javascript"></script>
<!-- End Administrate WebLink Setup Code -->

Widget Installation

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>

Configuring WebLink

Configuration options can be placed in the widget options as above. They can also be entered in the setup code. This will affect every widget on the page, or every widget on the website if using the same setup code everywhere:

<!-- Administrate WebLink Setup Code -->
<script type="text/javascript">
    var administrate = {
        // API options
        api_key: 'demo',

        //Event List Options
        num_months: 6,
        show_sold_out: false,
        group_by: 'location'
    }
</script>

The same configuration options can be used in the widget code, however, they are formatted slightly differently.

Within the setup code, the following format is used for configuring options:

num_months: 6, show_sold_out: false, group_by: 'location'

Whereas in the widget options, i.e. within the divs, the following format is used:

num_months=6|show_sold_out=false|group_by=location

Registration Deadlines

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 indefinitely.

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 for 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.

You can also choose to not display a date on the Event Table Widget using the Continuous Access toggle located in your event screen within Administrate:

Multiple Currencies

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 Events run over multiple currencies, a drop-down menu will appear allowing to sort by currency.

Widgets

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:

Frequently Asked Questions

1. What about SEO (Search Engine Optimisation) in WebLink?
2. Does WebLink support Human Readable Links?
3. I want to hide the ‘Powered By Administrate’ footer on the checkout screen because it doesn’t match my website, can I do this?
4. How do I have my Weblink orders go through the Sales Opportunities?

<style type="text/css">
    .administrate-footer {
        display: none !important;
    }
</style>

4.  How do I have my WebLink orders go through the Sales Opportunities?

You can send orders that come through WebLink into your Sales Opportunities system, and use that as your order processing system.  In your WebLink Setup Code, add the following:

use_sales_opportunities: true 

References