Configure Connection

Aeries SIS guide

Configure API Security in Aeries, enter the hostname and certificate key in NIM, and test system information access.

Before you startDirect link to Before you start

Follow the Aeries API Security documentation to create a dedicated third-party product record and authorize its access. NIM requires Hostname and Certificate Key. The key is the Aeries API certificate string.

Create the NIM vendor recordDirect link to Create the NIM vendor record

Sign in to the Aeries Admin Portal in the current school year and go to API Security > 3rd Party Vendors.
Create a new record named NIM. Leave Type unset for the Aeries Public API and select Insert to save.
Use Display Certificate Details to obtain the certificate key and store it securely for the NIM connection.
Configure the following existing permission areas for the NIM vendor record, enabling the access needed by your process.
Student Data
- Student Data
Scheduling
- Teacher Data
- Master Schedule
- Course Data
- Classes
School Information
- Schools
- Terms
- Users
Class Schedules
- History
Enrollment History
No additional sub-permission is required.
Staff Data
No additional sub-permission is required.

Grant Read for required collections. Staff and assignment creation also require the appropriate Insert permissions; authorize other supported writes only when your process needs them. Permission changes can take up to five minutes to apply.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add an Aeries SIS system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Hostname	The Aeries application address for the environment NIM will access, using the format expected by the Connection screen.
Certificate Key	The API certificate string from the NIM vendor record in Aeries API Security.

Test system information accessDirect link to Test system information access

Select Test Connection. NIM attempts to retrieve system information from:
```
GET /api/v5/systeminfo
```
Confirm that the test succeeds. If it fails, check the Hostname, Certificate Key, vendor record, and network access.
Collect the system and inspect students, staff, student_enrollments, student_classes, and the roster collections required by your process.
Validate record matching and relationships before using Aeries data for downstream lifecycle automation.
Test intended staff and assignment creation with safe records before enabling automation or delegated App actions.

The connection test retrieves system information. Validate collection permissions and each intended write operation separately.

Step 1 of 3