Aeries: Integration Overview

SchoolMint has created SIS Fields to facilitate data migration from SchoolMint to Aeries. To set up these fields, an Aeries API connection is required for the syncing process. 

SchoolMint-Aeries Integration

To help move data from SchoolMint to Aeries, SchoolMint has created SIS Fields. It is important to set these up prior to launching forms in SchoolMint. Once the forms have been finalized, the next step will be to begin configuring the syncing process. 

In order to successfully set up these SIS Fields, an Aeries API connection is required to your Production instance.

Below are the three steps to configuring the APIs needed. Completing all of this with give us read and write capability to successfully sync data to your SIS instance (don’t worry, no actual syncing of data will occur until you specify it to occur). 

 Infrastructure Requirements:

• The School/district needs to set up a Windows server which has IIS and requires .Net 4.6.1 or greater to be installed (.net 4.5 or ASP.Net 4.5 as part of the IIS configuration).
• The Windows server should be able to talk to their Aeries Database - as in the DB user that they decide to use on the Windows service config should have the right permissions and the network ports be opened for the Service to talk to the DB.
• The Windows Service should be accessible to SchoolMint via https. The URL should be a proper host URL and not an IP address.
• If the School has any issues exposing this service to SchoolMint (which is outside the School network), we can always provide them the SchoolMint IP addresses, so that they can whitelist our IPs.

 Aeries API Setup:

• Follow the instructions from here to create a key (we only need the API certificate). 
  • SchoolMint will need to have access to the following tables: 
    • Student Data
    • Schools
    • Terms
    • Enrollment History
    • Contacts

Upon completing this task SchoolMint needs:

• API Certificate
• URL of read only API: This is the URL where your admins are logging into Aeries

SchoolMint Windows Service Installation:

• Please follow the instructions from here - to install the service.

Upon completing this task SchoolMint needs:

• Windows Service URL to SchoolMint 
• The client id from the web.config

Confirmation

Once the Service is installed, check if everything looks good by accessing the service in a browser. You should see something like this:

  

• Clicking on the API should show you all of the endpoints: 

 

• If this is not true, please check the Troubleshooting section of this document.
• Please make sure that the appropriate permissions are given to the DB user used in Web.Config.

-------------------------------------------------------------------------------------------------------

Still have questions? Email us at [e-mail].