Background:

This article provides a high-level overview of how Experiential Learning Cloud (ELC) integrates seamlessly with your university’s Student Information Systems (SIS) or Customer Relationship Management (CRM) tools using REST APIs. Explicitly designed for program administrators, this guide explains the integration without requiring technical expertise.

NOTE: This feature is currently in beta testing.

 

What is a REST API Integration?

A REST API (Representational State Transfer Application Programming Interface) integration is a streamlined method to connect two different software systems, enabling them to exchange information effortlessly and securely. Think of it as a bridge that allows your SIS or CRM system and ELC to communicate and synchronize data.

A REST API allows data to be transferred between platforms when called using GET, POST, PUT, or DELETE calls. These calls will need to be configured by your University’s IT team in order to define when you will call the API and what operation will be performed on the data.

 

Why use an API Integration with ELC?

An API integration with ELC offers numerous advantages, streamlining and enhancing the accuracy of administrative tasks.

• Data Syncing: Keep student, placement, and course data consistently updated without manual entry.
• Improved Accuracy: Minimize errors associated with manual data entry, ensuring reliable and precise records that align with your university's SIS or CRM tools.
• Enhanced Efficiency: Free up administrative time by reducing repetitive tasks, allowing staff to focus on database management and student engagement.
• Advanced Customization & Management: Empower your university's IT team with complete control to customize and manage API integrations directly within ELC, ensuring optimal alignment with your program's specific data transfer needs.

 

What Data Can Be Integrated?

The API integration currently supports the transfer of the following data into and out of ELC:

• Users & user demographic information
• Sites & site demographic information
• Groups, classes, & enrollment information

*More data points and integration capabilities are expected in future updates to continually enhance functionality.

 

What Tasks Can an API Integration Do in ELC?

Depending on which data points you choose to integrate, the API integration can take care of the following tasks in ELC that you would otherwise need to complete manually:

• Users
  • Create new accounts for students, faculty, & external users (such as site supervisors)
  • Add/update account & demographic information
• Sites
  • Create new placement sites
  • Add/update contact & demographic information
• Groups
  • Create new classes & cohorts
  • Associate users with groups & sync enrollment data

 

Getting Started with ELC's API Integration

To configure the API for your university, your IT representative will need to log into your Experiential Learning Cloud instance to agree to the API terms of use and generate an authentication code.

• Create an account for your IT representative and assign them the University IT role.
• They will be brought automatically to the Integrations workspace upon login. From there, they can go to the API workspace and click Add (+) to generate an authentication key. 
• Once they have generated the authentication key, they can visit your university’s Swagger page at
  [customercode].lumivero-elc.app/api-docs/v1

 

IT Documentation

For technical information about configuring the API calls, please reference our technical documentation by following the steps below.

How to Download & Access the HTML File

1. Click here to access the REST API Technical Documentation HTML file
2. Click the Download button at the top of the page
3. Open the HTML file in your browser

NOTE: As we add more functionality and release new iterations of this feature, the technical documentation is subject to change.
Frequently check this page for version updates, and download an updated version of the HTML file when necessary.
Document version is specified in the HTML file name.

 

• Current Version: v1