Aeries API Credentials Setup for JumpRope

This guide walks you through creating API credentials in Aeries that JumpRope will use to import roster data (students, teachers, courses, schedules, and family contacts).

Prerequisites

  • Administrative access to your Aeries system
  • Permissions to manage API security settings in Aeries
  • Approximately 15-20 minutes to complete

Overview

JumpRope uses Aeries' REST API (v5) to synchronize roster data. You'll create a dedicated API credential for JumpRope with specific permissions, then provide the certificate key to your JumpRope implementation specialist through a secure channel.

Please provide an email address to JumpRope Support where you can receive a secure link. Use this secure channel to provide the API key and credentials.

Step-by-Step Instructions

1. Access Aeries Admin Portal

  1. Log into your Aeries administrative portal
  2. Use your Aeries administrator credentials
  3. Select the district site to log in

2. Navigate to API Security Settings

  1. In the Aeries admin portal, navigate to: Security - > API Security
    • Direct URL path: /admin/SecurityForAPI.aspx
  2. Wait for the page to fully load
  3. You should see a list of existing API credentials (if any) and an Add New Record button

3. Create New API Credential

  1. Click the Add New Record button

  2. In the Product Name field, enter: JumpRope

    • Use a descriptive name that clearly identifies this credential is for JumpRope
    • If you're creating multiple credentials for testing/production, consider names like JumpRope Production or JumpRope Test

  3. Leave the "Type" field empty. Do not select "One Roster" or "Student App".

  4. Click the Insert button to create the credential

  5. Wait for the credential to be saved

4. Configure API Permissions

After creating the credential, you need to enable specific API endpoints. For each endpoint listed below, click the checkbox in the Read column to enable it:

Required Endpoints:

  • ☑ Student Data - Student demographics and enrollment
  • ☑ Contacts - Family/guardian contact information
  • ☑ Class Schedules/History - Student and teacher schedules
  • ☑ Student Pictures - Student photos
  • ☑ Teacher****Data - Teacher information
  • ☑ Staff Data - Teacher and staff information
  • ☑ Master Schedule - Course sections and scheduling
  • ☑ Course Data - Course catalog
  • ☑ Classes - Class data
  • ☑ Grades - GRD/final grades (add UPDATE access to this one as well as READ)
  • ☑ Valid Marks - Valid final grade marks
  • ☑ Schools - School information and metadata
  • ☑ Terms - Term information and metadata
  • ☑ Student Groups - Student group info
  • ☑ Multiple LEA Student Data Sharing - Student Data - Student demographics
  • ☑ Multiple LEA Student Data Sharing - Student Pictures - Student photos

Important Notes:

  • Only Read access is required for everything except Grades, which requires update access as well if you would like to transfer final grades back into Aeries reporting
  • You may see additional granular permissions under each endpoint - enable the main endpoint category
  • If any checkbox appears grayed out or unavailable, you may need additional Aeries administrator permissions

5. Retrieve the API Certificate

  1. Locate the Display Certificate Details checkbox near the top or bottom of the page
  2. Check the box to reveal the certificate
  3. Wait 2-3 seconds for the certificate to appear
  4. The certificate is a 32-character hexadecimal string(letters a-f and numbers 0-9)
    • Example format: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 (this is not a real certificate)
  5. Copy the entire certificate string

Troubleshooting: If the certificate doesn't appear:

  • Refresh the page and try checking the box again
  • Look for a read-only text field or highlighted text on the page
  • The certificate should be clearly visible once the checkbox is checked

6. Wait for Credential Activation

IMPORTANT: Newly created API credentials in Aeries can take 5-15 minutes to become fully active due to internal caching.

JumpRope will test the credential against multiple API endpoints before beginning import. If the credential is tested immediately after creation, it may initially fail but should work after waiting.

No action required - just be aware of this delay when coordinating with your JumpRope implementation specialist.

7. Securely Provide Certificate to JumpRope

Security Considerations:

  • The API certificate provides read access to student data - treat it as confidential
  • Do not transmit the certificate via unencrypted email
  • Follow your district's data security policies for sharing credentials

Recommended Methods:

  1. Secure Portal - Use your district's secure file sharing portal if available
  2. Encrypted Email - Use email encryption if your email system supports it
  3. Phone/Video Call - Read the certificate over a secure call with your JumpRope implementation specialist
  4. Password-Protected Document - Place certificate in a password-protected document, share document and password separately

What to Send:

  • Aeries API Certificate for[Your District Name]
  • Certificate:paste the 32-character certificate here]
  • API Base URL:[your Aeries URL, e.g., https://yourdistrict.aeries.net/admin]

After providing the certificate, your JumpRope implementation specialist will:

  1. Configure the certificate in JumpRope's schedule import system
  2. Test API connectivity to verify the credential works
  3. Confirm which schools/sites will be imported
  4. Schedule the initial data synchronization