Integrate your course and delegate data with your LMS using the API v2 Feeds

Steps to integrate your webinar data with your meeting software

Related Help Guide Pages

• Integrate with the accessplanit API v2 Feeds - Overview

• API v2 - Developer Resources

• Courses Overview

There are many reasons you might want to integrate your accessplanit platform with an LMS to manage your training courses across both systems. By synchronising your accessplanit platform with your LMS, you can ensure that Course information, Delegates registrations, and Delegate progress are always kept up-to-date in both platforms, reducing the need for manual updates and minimising the risk of errors. This not only saves valuable time for your team but also helps maintain data accuracy.

A real-time integration keeps your Trainers and Delegates informed of any updates, which gives your Delegates a smoother learning experience and enables your Trainers to provide timely support. Additionally, automating data synchronisation between your accessplanit platform and your LMS can significantly reduce human error, leading to more reliable tracking of progress and outcomes.

As your training programmes expand, the scalability of this integration will enable you to handle an increasing number of Courses and Delegates efficiently.

Open

While there are a number of different ways to integrate your Course & Delegate data between your accessplanit platform and your LMS software, this guide will focus on how to complete this integration using the accessplanit API v2 feeds. APIs give you real-time access to your data, they keep information consistent, and can grow with your needs, supporting custom data elements. Overall, APIs are a reliable and flexible way to link different systems and services together, making everything work together more easily.

Follow this page to learn the steps to integrate the Course scheduling and Delegate data in your accessplanit platform with your Learning Management software using the accessplanit v2 API Feeds.

1. Prerequisites

The following steps should be followed:

• Ensure your meeting software supports Integrations via an API

• Explore your options for how your integration will be created (who will be developing it)

Ensure your connecting software supports Integrations via an API

Before you begin planning your integration, we recommend confirming that your [what] software will support the integration.

Explore your options for how your integration will be created (who will be developing it)

Review your options for who could develop this integration for you; you may have an internal development team, an external third party that you have worked with before, or your meeting software supplier may have developer recommendations or be able to complete the integration themselves.

2. Planning your integration

There are two key steps for planning your website integration:

• Understand common set-ups and best practice

• Define what and how data will be shared within your integration

Understand common set-ups and best practice

Depending on your requirements, there are up to 2 key processes that are typically automated for LMS integrations:

• Course integrations
  When both a TMS (such as accessplanit) and an LMS are in use, Course management (including scheduling & updating Courses) is managed in the TMS, integrating these Course details and any updates to the LMS means that Users in the LMS can register onto these Courses and access the relevant information and resources for their booked Courses!

• Delegate integrations
  Delegate integration is often two-way between an LMS and a TMS, details of the Delegates that register for their Courses within the LMS will be pulled into your accessplanit platform, and Delegates registered by administrators in your accessplanit platform will be pushed to your LMS. Additionally, once your Delegates have completed their Courses, automating recording their statuses and scores from your LMS back into your accessplanit platform can save a lot of time!

Open

Define what and how data will be shared within your integration

Once you have reviewed the common set-ups and best practice for [what] integrations above, you should define the inputs and output for integrating your courses into your website.

3. Developing & testing your integration

Development

Please see our dedicated developer guide to access information and guidance for working with the API v2 feeds: API v2 - Developer Resources

Testing

Depending on your development methodology, we recommend to start testing early and continue to test during the development phase, rather than leaving testing to the very end of the project. Incorporating a combination of testing types; including Unit Tests, Integration Tests, and Functionality/UAT testing is important to ensure everything is working as expected.

During your Functional testing phase, you will test your integration against it's specific functionality requirements, this testing can be combined with User Acceptance Testing (UAT) which is where your users will complete tests using real-world data to test the integration. Within this tests you should include both valid and invalid data, to ensure correct information is successful, and incorrect information fails.

FAQs

• Is the data provided by the API v2 feeds in real-time?
  Yes, each API GET request you make will return real time data for that moment.
  
  

• Can I access historical data in the API v2 feeds?
  Yes, you can adjust your filters of your request to include or exclude historical data.
  
  

• What data formats are supported by the API v2?
  JSON
  
  

• How is the data transmitted via the API to keep it secure?
  The APIs can only be accessed by users with API permissions, additionally the range of access is them limited by roles, this means that not every API User can access all endpoints.
  
  

• How do I get access to the API v2 feeds?
  Your initial API Access will be granted alongside the module purchase.
  For any additional API Users please speak to your Optimise CSM and they will ensure your access is set up promptly.
  
  

Support