Aeries API Certificate Setup for ActivityHero
Overview
ActivityHero uses the Aeries REST API v5 to import student rosters and family contact information. Create a dedicated API credential, grant read access to the required endpoints, and securely provide the certificate to the ActivityHero implementation specialist.
Navigate to Security > API Security.
Allow approximately 15-20 minutes to complete the setup. A newly created credential can require an additional 5-15 minutes to become active.
Security ↑
IMPORTANT: The API certificate provides read access to student data. Treat it as confidential, follow district data security policies, and do not send it through unencrypted email.
Use the Password.Link envelope provided by the ActivityHero implementation specialist to share the certificate.
Prerequisites ↑
- Administrative access to Aeries
- Permission to manage Aeries API security settings
- A secure Password.Link envelope from the ActivityHero implementation specialist
Steps ↑
Access API Security
- Log in to the Aeries administrative portal with an administrator account.
- Select the district site.
- Navigate to Security > API Security.
Direct page path:/admin/SecurityForAPI.aspx
Create the ActivityHero credential
- Click Add New Record.
- In the Product Name field, type
ActivityHero. - Leave the Type field empty. Do not select One Roster or Student App.
- Click Insert.
Configure required read permissions
In the Read column, select each required endpoint. Only read access is required.
| Category | Required endpoint | Purpose |
|---|---|---|
| Student Data | Student Data | Student demographics and enrollment, including English Learner status |
| Student Data | Supplemental Data | Student supplemental information |
| Student Data | District Supplemental Data | District-defined supplemental information |
| Student Data | Contacts | Family and guardian contact information |
| Attendance | Absence Code | Absence code information |
| Attendance | Attendance | Student attendance information |
| Scheduling | Teacher Data | Teacher information |
| School Information | Schools | School information and metadata |
| Multiple LEA Student Data Sharing | Supplemental Attendance | Supplemental attendance information shared across LEAs |
Configure optional read permissions
Select the endpoints that support the Expanded Learning program's requirements. Confirm the required data with the ActivityHero implementation specialist.
- Student Programs - Free and Reduced Lunch
- Student Programs - Special Programs - Foster and homeless program information
- Authorizations - Pickup authorizations
- Student Pictures - Student photos
- Multiple LEA Student Data Sharing - Student Pictures - Student photos
- Multiple LEA Student Data Sharing - 504 Plans
- Multiple LEA Student Data Sharing - Medical Log
- Multiple LEA Student Data Sharing - Red Flags
NOTE: Enable the main endpoint category when additional granular permissions are displayed. If the program needs data that is not listed, discuss the requirement with the ActivityHero implementation specialist.
Retrieve the API certificate
- Select Display Certificate Details.
- Wait two to three seconds for the certificate to be displayed.
- Copy the entire 32-character hexadecimal certificate.
Example format: a1b2c3d4e5f60718293a4b5c6d7e8f90
Allow the credential to activate
IMPORTANT: A new API credential can require 5-15 minutes to become active because of internal caching. An immediate connectivity test can fail during this period.
Securely provide the certificate to ActivityHero
Open the Password.Link envelope provided by the ActivityHero implementation specialist and send the following information:
- Aeries API Certificate for [District Name]
- Certificate: [Paste the 32-character certificate]
- API Base URL: [District Aeries base URL, such as
https://yourdistrict.aeries.net]
The ActivityHero implementation specialist configures the certificate, tests API connectivity, confirms the data to import, and schedules the initial synchronization.
Troubleshooting ↑
| Condition | Action |
|---|---|
| The certificate is not displayed. | Refresh the page, select Display Certificate Details again, and look for a read-only field or highlighted certificate value. |
| A permission is unavailable. | Contact an Aeries administrator who has permission to manage API security settings. |
| The first connectivity test fails. | Wait 5-15 minutes after creating the credential, and then test it again. |