Skip to main content

Getting Started

Welcome to Our API Documentation​

This guide provides everything you need to seamlessly integrate with our platform.

We start with a detailed overview of Authentication to help you securely access the API. From there, you'll find step-by-step guides for common use cases, including:

Additionally, we have included explanations of key concepts, such as the distinction between contacts and users, as well as common terminology related to courses, to help you navigate the API with confidence.

Contacts​

Contacts refer to each person that has been stored in your aXcelerate system. Each person in aXcelerate will have a Contact Record that will contain all of their personal and enrolment information. A Contact Record must be created for each person that you wish to interact with in aXcelerate.

For more information about Contacts, please see https://support.axcelerate.com.au/hc/en-gb/articles/360000496855-Contact-Management

Users​

In aXcelerate, a User record cannot exist without an associated Contact record, but a Contact does not necessarily need to have a User record.

Each User is assigned a Role, which determines the permissions they inherit. These permissions can be specifically overridden for the individual User (from within the interface) after they have been created and assigned a Role.

aXcelerate will automatically generate a User record for any Contact enrolled in a course if one does not already exist. Additionally, if your account uses a Corporate Identity Provider (IDP) for Single Sign-On (SSO), a User record may be created during a successful SSO attempt. This creation is based on matching rules between aXcelerate contacts and the claims provided by the IDP.

To manually create a User record, a POST request must be made to the /user endpoint. In this request, you must include the contactId parameter, which should be set to the unique identifier of the Contact record for which you are creating the User.

If you want to assign a specific Role during User creation, you can include the roleId parameter with a value corresponding to the desired Role. All available Roles can be retrieved with a GET request to /user/roles.

By omitting roleId, the system will assign a ‘Learner’ role or the ‘Default Learner Role’ specified in the ‘Additional Options’ area of System Settings.

Terminology​

Our API is fairly generic with teminology and a lot actions and endpoints revolve around a 'course'. A course, however, can be many things.

  • A Qualification
  • A Workshop Type
  • A Class Instance
  • A Workshop Instance
  • An E-Learning Instance

Typically an endpoint will also require a type parameter that will be the delination of which type of course your request refers to.

Types​

  • Wokshop Type / Workshop Instance (type = w)
  • Qualification / Class Instance (type = p)
  • Unit (type = s)
  • E-Learning (type = el)