Product: Roster Server   

Audience: ClassLink Administrator

 

If you are ready to set up Roster Server to pull data from the Skyward API, you’ll need to retrieve your URL to Skyward, the key, and secret.  

 

Overview

• Skyward API Set Up
• Connection to ClassLink Roster Server
  
• Importing Guardians

 

 

Skyward API Set Up

Note: Ensure that the Skyward API Server has been installed. Refer to the Skyward documentation for more information.

 

To create a Secured User account within the Skyward database for your ClassLink Roster Server follow these steps below:

1. Browse to “Product Setup – Skyward Contact Access – Secured User”.

2. Click Add.

3. Click the Organization button.

4. Enter ClassLink as the Organization (Vendor) Name.

5. Click Add Entered name to Secure Users.

6. Click Save.

7. Highlight the New Organization User in the Secured User list, then click the API button at the lower-right corner of the screen.

8. Click Generate New key.

9. Record the values for the Key and Secret.

 

Connection to ClassLink Roster Server

1. Log into ClassLink -> click on your Roster Server app (or click on your ClassLink Management Console app, then click on Roster Server from the left frame). You can also access the Roster Server Console by logging in through https://console.oneroster.com.

2. Go to Settings -> General.

 

 

5. Under SIS Connector Settings -> click Choose to select your SIS (Skyward API).

6. Enter the Skyward Key and Secret values, along with your API URL.  The API URL is https://{DNSNAME} /api.

In some cases, the URL will look similar to this: https://skyward.schoolDistrictName.org/api

7. Click SAVE in the bottom right corner.

8. Click Test Connection and a message of success will appear.

9. Turn the Enabled switch on.

10. Click Run Connection (This may take a while).

 

 

11. Under Importer Settings -> turn the Sync button on and choose a sync schedule.

12. Click on Import Rosters -> Import Now and your files will appear. This document will help as well.

13. Go back to the left frame menu -> click Applications to choose the applications to the roster. This document will help as well. 

 

Importing Guardians

The Skyward API connector now supports adding guardians to the users CSV (if available). To add guardians, simply toggle the "Guardian" option. Please note that guardian information will only be added if it already exists in Skyward. If the "Guardian" checkbox is toggled, a second toggle will appear, called "Student Guardian Email". If enabled, a metadata field will be added to the users CSV, which contains any linked guardians' emails. 

 Updated: Oct 2020