Aeries Software allows data to be pulled by authorized vendors through the OneRoster API to automatically sync with 3rd Party Applications. This eliminates the need for manual CSV transfers or complicated SFTP uploads.
Classlink (OneSync) connects to Aeries through a OneRoster API Certificate unless there is a specific need for an SFTP data upload.
TABLE OF CONTENTS
Configuration ↑
1. Login to your Aeries Admin portal with an Administrator account
2. Navigate to Security -> API Security
3. Select the “Add New Record” button
4. Enter the product name "Classlink (OneSync)" and any comment you’d like.
a. Select OneRoster from the Type drop-down menu
5. Click 'Insert' to save the OneRoster API credentials 
Security ↑
6. Grant the following API Permissions;
| Permissions | ||||
| Table/Program Area | Read | Update | Insert | Delete |
| Student Data | ||||
| Student Data | √ | |||
| Gradebook | ||||
| Gradebook Scores | ||||
| Gradebook Category | ||||
| Gradebook Assignment | ||||
| School Information | ||||
| Schools | √ | |||
| Terms | √ | |||
| Scheduling | ||||
| Teacher Data | √ | |||
| Master Schedule | √ | |||
| Course Data | √ | |||
| Classes | √ |
7. Select the checkbox next to “Display Consumer ID & Secret Keys For OneRoster” to view the OneRoster Credentials. This is sensitive information and should be treated as such.
8. You’ll need the Consumer ID, the Consumer Secret Key, along with your Aeries OneRoster URL* to configure the initial connection to Classlink (OneSync).
*The "OneRoster URL" is shown on the API Security page and on the School Options page at the district level. Copy it exactly as shown.
In this example, the highlighted text is the "OneRoster URL." Your own OneRoster URL will be different.
The OneRoster URL is your Aeries base URL plus the OneRoster path /ims/oneroster/v1p1. For hosted customers, the base URL ends in .aeries.net or .asp.aeries.net followed by the portal path, for example https://yourdistrictname.aeries.net/admin or https://yourdistrictname.asp.aeries.net/admin. Self-hosted districts use their own Aeries web address.
(replace "yourdistrictname" with your actual assigned URL address)
* If there are any issues with the OneRoster URL (Link missing or does not load), please reach out to Aeries Support.
Vendors utilizing the OneRoster API may require the following URL Information.
Roster API URL: {Base URL}/ims/oneroster/v1p1 (for example, https://yourdistrictname.aeries.net/admin/ims/oneroster/v1p1/academicSessions/)
Authentication type: OAuth2
Token URL: {Base URL}/token/ (for example, https://yourdistrictname.aeries.net/admin/token/)
Vendor Information ↑
9. More information about Classlink (OneSync) Sync can be found on the Classlink (OneSync) website: https://www.classlink.com/products/onesync