What is the ClassLink OneRoster API?
ClassLink is a third-party platform that handles seamless SSO, roster data exchange, file management, and more for educational organizations. Quaver supports SSO and roster data exchange through ClassLink. ClassLink furnishes roster data in the IMS Global OneRoster format to third-party vendors, like Quaver, using two methods: API or CSVs delivered via sFTP. Quaver can receive and process roster data from ClassLink using either of these methods. Follow the instructions below to set up a rostering integration with Quaver using ClassLink’s OneRoster API. Alternatively, if your district would like to deliver roster data to Quaver as CSVs, please see our OneRoster CSV Integration instructions.
NOTE: In order to support ClassLink’s OneRoster API, Quaver must have a SSO integration set up with your district as well. View our ClassLink Oauth2 SSO setup instructions.
How to set up ClassLink OneRoster API data exchange with Quaver
|1.||Log into your ClassLink Dashboard with your Tenant Admin account and click the ClassLink Management Console icon.|
|2.||In the sidebar menu of your ClassLink Management Console, click the Manage item under Roster Server.|
|3.||In your ClassLink Roster Server console, click the Applications item in the left sidebar. One the Applications page, click the Add Applications button.|
|4.||Search for "Quaver" in the finder. Click the Add button next to the "QuaverMusic.com" app.|
|5.||You should now see the QuaverMusic.com app appear in your Applications on your ClassLink Roster Server. Ensure that you have the settings for the app set to Enabled and FULL.|
Once you’ve shared your ClassLink OneRoster API endpoint with Quaver by adding our application, our integrations team will be notified. We will reach out with next steps and testing instructions.
Remember that in order to support ClassLink’s OneRoster API, Quaver must have a SSO integration set up with your district as well. View our ClassLink Oauth2 SSO setup instructions.
About the OneRoster format
The OneRoster data format describes the relationships between schools, users, courses, academic sessions, classes, and enrollments. While the information requested by the OneRoster format exceeds Quaver’s needs, Quaver supports the OneRoster specification due to its widespread acceptance as a data interchange format. View IMS Global’s OneRoster specifications.
Quaver can integrate with both the OneRoster 1.0 and OneRoster 1.1 formats via ClassLink’s API.
Remember that a rostering integration with Quaver requires that we also integrate with a Single Sign On (SSO) system used by your district.