Introduction to APIs with NovoEd

Overview

In instances when a customer's application needs to communicate with the NovoEd platform, API calls may be programmed to deliver or retrieve information between the two applications. 

Process

1. Org Admin requests an API Key and Secret from the NovoEd Support Team. (See article.)
2. Connect the API Key to a course or institution. (See article.)
3. Program the APIs in the application that will communicate with NovoEd.
4. Test the API calls within the preferred application.
5. Enable API calls within the preferred courses and/or learning journeys.

Types of APIs

NovoEd provides five different categories of APIs that can be programmed:

1. Enrollment APIs
   • Register New Learner
   • Unregister Learner
   • Resend Welcome Email
   • Get Registration Info
   • Get All Courses in an Institution
     
     
2. Archiving User-Generated Content
   • Message Archive
   • Discussion Archive
   • Assignment Submission Archive
   • Private Feedback Archive
   • Practice Submission Archive
   • Practice Submission Discussion Archive
   • Team and Group Workspaces Archive
     
     
3. Manage Users at the Institution-Level
   • See Available roles
   • See Custom Profile List
   • Update Custom Profile
   • Update Email
   • Update External ID
   • See User
   • Update User
   • Create User
     
     
4. Course APIs
   • Retrieve a List of Courses
   • Update Course Information (Catalog ID, Course Name, Course Dates)
   • Clone Course
     
     
5. Org-Level Analytics
   • Retrieve a List of Users
   • Retrieve a List of Courses
   • Retrieve a List of Enrollments
   • Retrieve a List of Lesson Pages
   • Retrieve a List of Course Activities
   • Retrieve a List of Learning Activity Outcomes 
   • Retrieve a List of Users' Lecture Page Views
   • Retrieve a List of Org Level Users and their Org Level Roles
     
     
6. Learner APIs
   • Mark Specific Web Embed or Web Link Activity as Complete for Specific User