Skip to main content

WebLink GraphQL API

Updated

WebLink GraphQL API

The WebLink API is designed to facilitate the quick construction of high quality eCommerce experiences for training operations. A complement to the main Administrate API, the WebLink API offers a high level of control for developers and organizations that want to design their own User Experience, integrate tightly with an existing eCommerce solution, or extend functionality of other applications.

It is important to understand that the WebLink API documented here is the same API that is used to drive the Administrate WebLink widgets. Therefore, any functionality you see within the standard WebLink widgets is achievable using this API.

To date the WebLink API and WebLink Widgets have been deployed on hundreds of websites ranging from completely custom user experiences to embedded widgets within existing sites. The API and Widgets have also been used within iOS and Android apps shipped within the Apple App Store and Google Play Store.

Features

The WebLink API broadly provides the following features:

  1. Catalog - searching and retrieving information about courses and events.
  2. Shopping Cart
  3. Checkout and Payment
  4. User Authentication and Identity Management for customers/learners.

Best practices

It is considered best practice for developers to focus the bulk of their engineering on item 1: the Catalog area. The look and feel of the Catalog is indeed what customers most often like to personalize. Showing a course catalog with events that are scheduled to run can be quickly and easily customized using whatever language or framework you choose.

You can also choose to embed WebLink widgets which render the most common elements (Catalog, Event list, Shopping Cart etc.)

Performance

For performance reasons, it is highly recommended to cache course and event data so that this information is not loaded with every visit. This data tends to be relatively non-volatile, and Webhooks can be configured within the Administrate platform to notify your app of changes.

The WebLink API is rate limited, mainly to encourage the best practices above.

Schema

The full set of entities are listed in the API Reference.

If you are unfamiliar with GraphQL, we recommend starting with Introduction to GraphQL in our guides section.

For information on how to authenticate against the WebLink GraphQL API, see Authorization.