Aeries Software allows data to be pulled by authorized vendors through the Aeries API to automatically sync with 3rd Party Applications. This eliminates the need for manual CSV transfers or complicated SFTP uploads.
SchoolCity connects to Aeries through an 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 "SchoolCity" and any comment you’d like.
5. Click 'Insert' to save the Certificate
Security ↑
6. Grant the following API Permissions;
Permissions | ||||
Table/Program Area | Read | Update | Insert | Delete |
Alerts | ||||
Send Alerts | ||||
Commands | ||||
Trigger Student Pre-Enrollment | ||||
Student Data | ||||
Student Data | √ | |||
Student Programs | ||||
Special Programs | √ | |||
Special Education | ||||
Free and Reduced | ||||
Supplemental Data | √ | |||
District Supplemental Data | ||||
Contacts | ||||
Class Schedules/History | ||||
GATE | ||||
Authorizations | ||||
Attendance | ||||
Absence Code Table | ||||
Attendance | ||||
Attendance History | ||||
Bell Schedule | ||||
Calendar | ||||
Enrollment History | ||||
Counseling | ||||
Assertive Discipline | ||||
Test Scores | ||||
Test Scores | ||||
College Entrance Tests | ||||
Other | ||||
Fees and Fines | ||||
Student Pictures | ||||
Activities and Awards | ||||
Gradebook | ||||
Gradebook Data | ||||
Gradebook Scores | ||||
Gradebook Category | ||||
Gradebook Assignment | ||||
Scheduling | ||||
Teacher Data | √ | |||
Staff Data | √ | |||
Staff Job Assignments | ||||
Staff Assignments (Classified) | ||||
Master Schedule | √ | |||
Course Data | √ | |||
Classes | √ | |||
Scheduling Master Schedule | ||||
Student Scheduling Schedules (Course Requests) | ||||
Class Calendars | √ | |||
Flex Periods | √ | |||
Grade Reporting | ||||
Grades | ||||
Transcripts | ||||
Graduation Status | ||||
School Information | ||||
Schools | √ | |||
Terms | √ | |||
Users | ||||
Graduation Requirements | ||||
Other | ||||
Single Sign On (from the 3rd party system) | ||||
Student Groups |
7. Select the checkbox next to “Display Certificate Details” to view the API Certificate. This is sensitive information and should be treated as such.
8. You’ll need the Certificate, along with your Aeries base URL* to configure the initial connection to SchoolCity.
*The "base URL" is the entire web address of your Aeries system leading up to the "/Login.aspx".
In this example, the highlighted text is the "base URL." Your own base URL will be different.
For hosted customers, your base URL will be https://yourdistrictname.aeries.net/admin
9. More information about SchoolCity can be found on the SchoolCity Support Site: https://www.renaissance.com/products/schoolcity/
Configuring SchoolCity for SSO ↑
To provide Teachers and Admin Users access to SchoolCity SSO via Aeries
10. Navigate to the 3rd Party Systems Connection Page.
a. Check the Enable Illuminate SchoolCity Integration checkbox at the district level.
b. You will also need to enter the SchoolCity SSO URL, CSD and API Key provided by SchoolCity.
11. Navigate to the Portal Groups Page
a. Select User Group
b. Grant Read Permission to SSO
12. Populate the SchoolCity ID for each User on the Users Security Page
Once enabled, users will see a SchoolCity icon in the navigation.
Once the user clicks the icon, a new window will open and they will be automatically logged into SchoolCity's system.