Infinite Campus API Sync Functionality
✓ Runs every two hours, by querying the OneRoster API
✓ Syncs all students who are designated as "active today" (activeToday = 1)
✓ Syncs all active staff members (employment.active = 1)
✓ Supports co-teachers for sections (sectionInfo_teacherPersonID, sectionInfo_teacher2PersonID, etc)
✓ Students and teachers need Infinite Campus Portal accounts in order to sync to Clever (see below)
✓ Clever only has access to OneRoster compatible fields made available by Infinite Campus. The available fields can be found here.
In order to sync your data through the OneRoster API you'll need to make sure your Infinite Campus in on version 1633 or higher.
Setting up the API sync
1. Obtain API credentials
In order to setup the API sync you'll obtain your API credentials from your Infinite Campus instance. You'll be able to do this by logging into Infinite Campus:
System Administration > User Security >OAuth Management > OAuth Client Management
There you'll create create an OAuth Client:
- Click New to create a new credential record.
- Enter a Client Name.
- Enter a Consumer Key following the hard-coded prefix.
- Leave OneRoster API selected as the Realm.
- Modify the Token Expiration Date if desired. Do not exceed 13 months from the current date.
- Leave the Status as Active.
- Click Save to finish.
2. Change sync type of Clever account
If you already have a Clever account and are switching to the API sync, please contact Clever Support. Our team will need to switch your account sync type before you can move forward. If you signed up for a new account, the IC API sync will be the default sync type for your account and no switch needs to be made. You're free to move on to the next step!
3. Enter API credentials in Clever
Once your account's sync type is the IC API sync, please take the credentials for the API and enter them into the Sync Settings page in your Clever Dashboard:
Web URL: API Host Name (should include "learningdata" and not end in v1p1)
Username: Consumer Key (the hard-coded prefix + the text you entered)
Password: Consumer Secret
Push "Sync Now" on the Sync Settings page to kick off the initial IC API sync!
In order for students and teachers to be accessible in the IC API (and thus synced to Clever) they will need to have IC Portal accounts created.
To batch create IC Portal accounts, you have a couple of options:
1. System Administration > User Security > Student Accounts > Add Students > Change Accounts
This option creates all accounts with a default username and password, and must be completed separately for each school site.
2. System Administration > User Security > Batch and Import Wizard > User Account Batch Import Tool
With this method, when new users are created in IC you'll need to grant them IC Portal access in order for them sync to Clever.