Overview

Ready Education integrates with Ellucian's Ethos platform, enabling seamless data exchanges between your CampusGroups platform and Ellucian SIS systems (Banner, Colleague, etc.) using standardized APIs.

Supported Operations

• Student course enrolment retrieval

• Faculty course section access

• Grade retrieval

• Student profile information

• Hold/restriction information

• Class roster retrieval

Before You Begin

Please confirm all of the following before starting. If anything is unclear, contact help@readyeducation.com before proceeding.

• [ ] Your institution has Ellucian Ethos Integration licensed and active. Ethos must already be configured at your institution. Ready Education cannot enable this on your behalf. Confirm with your Ellucian administrator or account representative if unsure.

• [ ] You have administrator access to the Ellucian Ethos Integration portal. You will need this to create an API key and configure permissions (Steps 1–2 below).

• [ ] A test student account is available. You will need a test student account that is enrolled in at least one active course with grade data present. This account must also exist in your SIS. See Step 3 – Provide Details to Ready Education for full details.

Step 1 – Create an API Key

Ready Education connects to Ethos using an API key that you generate in the Ellucian Ethos Integration portal. This key should be created specifically for the Ready Education integration.

1. Log into the Ellucian Ethos Integration portal. The default endpoint URL is <https://integrate.elluciancloud.com.> Contact your Ellucian administrator if your institution uses a different endpoint.

2. Navigate to Applications (or API Key Management depending on your portal version).

3. Create a new application or API key and give it a recognizable name, for example: Ready Education Integration.

4. Copy and save the API key, you will need it in Step 3.

✅ Check: You have a new API key created specifically for this integration and have it stored securely.

Step 2 – Configure API Permissions

The API key must have Read access to the resources Ready Education needs. Without these permissions, the integration will fail or return incomplete data.

In the Ellucian Ethos Integration portal, grant Read access to the following resources:

• persons

• courses

• sections

• academic-credits

• academic-periods

• grades

• person-restrictions

Permission Configuration Steps

1. Log into the Ellucian Ethos Integration portal as an administrator.

2. Navigate to API Key Management.

3. Select or create the API key to be used for this integration.

4. Enable Read access for all seven resources listed above.

5. Ensure the API key has appropriate scope to access student and faculty data.

6. Verify that credential-based lookups are enabled if using credential type filtering.

Note: The exact location of permission settings varies depending on your Ethos Integration version. If you are unsure where to find these, refer to Ellucian's Ethos documentation or contact your Ellucian administrator.

✅ Check: The API key has Read access to all seven resources above. Test access in the Ethos portal if available.

Step 3 – Provide Details to Ready Education

Once Steps 1 and 2 are complete, send the following to your Implementation Manager or to help@readyeducation.com.

⚠️ Send the API key and any other credentials securely. Do not include API keys in plain email.

What Happens Next

Once Ready Education receives your details, our team will:

1. Authenticate to the Ethos API using the key you provided and confirm connectivity.

2. Validate that course, enrollment, grade, and holds data is returned correctly for your test user.

3. Configure and enable the integration against your production environment.

4. Enable the My Courses module in Ready Campus for your institution.

5. Notify your Implementation Manager once the integration is live and validated.

Your Implementation Manager will confirm go-live and guide you through any final steps, such as enabling My Courses in your Hub menu.

If any issues arise during validation, for example, if the test user returns no data or a permission is missing, we will reach out to you directly with specific details and guidance on next steps.

API Reference

Base URL

• Production: <https://integrate.elluciancloud.com>

• Institution-specific: As configured in ethos.api.url

Authentication

POST /auth

• Headers: Authorization: Bearer <api-key>

• Response: Access Token (JWT string)

Note: Access Tokens expire based on JWT expiration time. New tokens are obtained automatically as needed.

Core Resources

Persons

• GET /api/persons - List persons

• GET /api/persons/{id} - Get person by ID

• GET /api/persons?criteria={json} - Filter persons

Courses

• GET /api/courses - List courses

• GET /api/courses/{id} - Get course by ID

• GET /api/courses?criteria={json} - Filter courses

Sections

• GET /api/sections - List sections

• GET /api/sections/{id} - Get section by ID

• GET /api/sections?criteria={json} - Filter sections

Academic Credits

• GET /api/academic-credits - List academic credits

• GET /api/academic-credits?criteria={json} - Filter academic credits

Academic Periods

• GET /api/academic-periods - List academic periods

• GET /api/academic-periods/{id} - Get academic period by ID

Grades

• GET /api/grades - List grades

• GET /api/grades/{id} - Get grade by ID

Person Restrictions

• GET /api/person-restrictions - List restrictions

• GET /api/person-restrictions?criteria={json} - Filter restrictions

Query Parameters

Troubleshooting

The API key returns a 401 Unauthorized error

What to check:

• Confirm the API key was copied correctly with no leading or trailing spaces.

• Verify the key has not been revoked or regenerated in the Ethos portal since it was provided.

• Confirm the API URL is correct, if your institution uses a custom Ethos endpoint rather than <https://integrate.elluciancloud.com,> provide the correct URL to Ready Education.

Access token has expired

What to check:

• Access tokens expire automatically based on their expiration time. If you were previously authenticated but are now receiving 401 errors, your token may have expired.

• Contact Ready Education at help@readyeducation.com if token expiration errors persist after re-authenticating.

Course or enrollment data is missing or incomplete

What to check:

• Confirm that Read access is enabled for all seven resources in Step 2. A missing permission on even one resource (e.g. academic-periods) can cause data to appear incomplete.

• Verify the test user is actively enrolled in at least one current-term course in the SIS.

• If data is present in Ethos but still not appearing, contact Ready Education with the test user's person record ID from the Ethos portal if you have it available.

The test user exists in Ethos but is not matched in the app

What to check:

• The test user's identifier (typically email or student ID) must match exactly between the SIS, Ethos, and the user's SSO account in Ready Campus. Confirm all three use the same value.

• If your institution uses credential-based lookups (e.g. student ID or Banner ID), confirm that credential type filtering is enabled for the API key.

Ethos API returns data but grades are empty

What to check:

• Confirm grades and academic-credits permissions are both enabled on the API key.

• Verify the test student has grades entered for at least one enrollment in the current term, not just registered, but graded.

• Mid-term grades may not be available in all configurations. Confirmed grade data requires the verifiedGrade field to be populated in academic-credits.

Person ID not found

⚠️ Engineering review needed: The following scenario requires input from Engineering to ensure the guidance is appropriate for a client-facing audience.

What to check:

• Verify the test user has successfully authenticated via SSO before attempting to retrieve their data.

• Confirm the test user exists as an active person record in the Ethos portal.

• Contact Ready Education at help@readyeducation.com if the issue persists.

Network timeouts

What to check:

• Confirm network connectivity to your Ethos endpoint is stable.

• Verify that your firewall allows outbound HTTPS connections to <https://integrate.elluciancloud.com> (or your institution-specific endpoint).

• If timeouts persist, contact Ready Education at help@readyeducation.com and we can help determine whether the issue is on your network or the Ethos service.

Error Codes

Frequently Asked Questions

⚠️ Engineering review needed: This FAQ section was not part of the source documentation. Please review all questions and answers for accuracy before publishing.

Does this integration require any installation on our servers?
No. Ethos is a cloud API, no additional software installation is required on your servers.

We have Banner on-premises, not Banner SaaS. Can we still use Ethos?
Ethos can be used with on-premises Banner if your institution has Ellucian Ethos Integration configured as a layer in front of it. Speak with your Implementation Manager if unsure which applies to you.

Who generates the API key, us or Ready Education?
You do. The API key is generated by your Ellucian Ethos administrator in your institution's Ethos portal. Ready Education does not have access to your Ethos portal.

Is the API key the same as our Ethos username and password?
No. The API key is a separate credential used specifically for programmatic API access. It is distinct from any Ethos portal login credentials.

What happens if we regenerate or rotate the API key?
If the API key is changed, Ready Education's integration will stop working until the new key is provided. Contact help@readyeducation.com with the updated key (using a secure transport) as soon as possible to minimize disruption.

Are financial holds supported through Ethos?
Yes, via the person-restrictions resource. Holds appear in the app under the student's profile if the financial modules are enabled on your Ready Campus instance.

Support & Contact

For questions about this integration, or to begin the setup process, please contact your Implementation Manager for next steps. If you are unsure who your Implementation Manager is, please email help@readyeducation.com with your institution name and that you are looking to set up Ellucian Ethos.