Integration - APIs Overview

Modified on Sat, 26 Apr at 2:50 PM

Integration Overview

To help automate data management between CourseKey and Nexus (SIS), both systems have been integrated via APIs. Registrars who are involved with the management of Nexus on behalf of their programs and other supporting roles who interact with attendance data and reporting should have a basic understanding of how these systems interact and how often.

Understanding Integration APIs

The integration APIs consist of individual jobs that are executed by timers in a sequence. These jobs are responsible for both sending new data and updating existing data in CourseKey and Nexus. It is important to understand the source of truth for each of the APIs listed below, how the systems interact and where updates should be made.

In general, the rule of thumb is all attendance records and adjustments should always be made in CourseKey to ensure that both systems are identical. CourseKey will send all new attendance data daily along with any historical records that were changed after the last completed posting.
All other information like student emails, instructor teaching assignments, course start and end dates, attendance schedules, etc. will come from Nexus. Any changes made involving user, course, scheduling or enrollment information should always be made in Nexus and the changes can be verified in CourseKey.

API SOURCES OF TRUTH: NEXUS

1. Create/Update User (Instructor)

2. Create/Update Course

3. Create/Update Schedules

4. Create/Update User (Student)

5. Register/Drop Users in Course

API SOURCE OF TRUTH: COURSEKEY

6. Post/Update Attendance Data

API Schedules and Frequencies

The individual jobs work off of a scheduling sequence that will request and send data between the two systems. The frequency and times for each of the jobs are listed in the tables below and will help anyone managing either system better understand when to expect changes in one system to reflect in the other.

1. NEXUS TO COURSEKEY JOBS

API Job	Frequency	Time
CREATE COURSE	EVERY 15 MINUTES	Starts 1st minute of hour (EX: 12:01, 12:16, 12:31)
UPDATE COURSE	EVERY 15 MINUTES	Starts 5th minute of hour (EX: 12:05, 12:20, 12:35)
CREATE SCHEDULE	DAILY	11:02 pm
UPDATE SCHEDULE	EVERY HOUR	Starts 2nd minute of hour (EX: 12:02, 1:02, 2:02)
CREATE STUDENT USER	EVERY 15 MINUTES	Every 3rd minute of hour (EX: 12:03, 12:18, 12:33)
UPDATE STUDENT USER	EVERY 15 MINUTES	Starts 2nd minute of hour (EX: 12:02, 12:17, 12:32)
CREATE INSTRUCTOR	EVERY 15 MINUTES	Starts on the exact hour (EX: 12:00, 12:15, 12:30)
ENROLL/UPDATE ROSTER	EVERY 15 MINUTES	Starts 4th minute of hour (EX: 12:04, 12:19: 12:34)

2. COURSEKEY TO NEXUS JOBS

API Job	Frequency	Time
GET ATTENDANCE TIMESHEET	DAILY	6:05 PM
IMPORT ATTENDANCE TIMESHEET	DAILY	6:20 PM
GET ATTENDANCE ADJUSTMENTS	DAILY	6:10 PM
IMPORT ATTENDANCE ADJUSTMENTS	DAILY	6:40 PM