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.
Step 1: Skyward API Set Up
Ensure that the Skyward API Server has been installed. Refer to the Skyward documentation for more information.
Create a Secured User account within the Skyward database for your ClassLink Roster Server:
Browse to “Product Setup – Skyward Contact Access – Secured User”
Click “Add”
Click the “Organization” button
Enter “ClassLink” as the “Organization (Vendor) Name”
Click “Add Entered name to Secure Users”
Click “Save”
Highlight the New Organization User in the Secured User list, then click the “API” button at the lower-right corner of the screen.
Click “Generate New key”
Record the values for the “Key” and “Secret”.
Step 2: Connection to ClassLink Roster Server
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.
Go to Settings>General
Click “Connector Settings”
Click on Settings > General.
Under SIS Connector Settings, click “Choose” to select your SIS (Skyward API).
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
Click “SAVE” in the bottom right corner.
Click “Test Connection” and a message of success will appear.
Turn the “Enabled” switch on.
Click “Run Connection” (This may take a while)
Above, under Importer Settings, turn the “Sync” button on and choose a sync schedule.
Click on Import Rosters > Import Now and your files will appear. This document will help as well.
Go back to the left frame menu and click Applications to choose the applications to roster. This document will help as well.