Integrate with Ellucian Ethos APIs for SIS data

Steps

1. In the Ellucian Ethos Integration portal at https://integrate.elluciancloud.com, register your application and generate an API key (Ethos uses API key-based token exchange rather than direct OAuth 2.0 client credentials).
2. Exchange your API key for a short-lived JWT access token by POSTing to https://integrate.elluciancloud.com/auth with header Authorization: Bearer your_api_key; the response body contains the JWT token string.
3. Use the JWT token as a Bearer token in the Authorization header of subsequent API calls; tokens expire (typically in 5 minutes) — refresh proactively by re-exchanging the API key before expiry.
4. Query Ethos Data Model (EEDM) resources via GET https://integrate.elluciancloud.com/{resource-name}?limit=100&offset=0 (e.g., /persons, /student-academic-programs, /sections); the resource names follow the Ellucian EEDM naming convention, not standard REST conventions.
5. Parse responses as JSON arrays; use the Accept header version to request a specific EEDM schema version (e.g., Accept: application/vnd.hedtech.integration.v8+json) when the resource has multiple versions to ensure predictable response structure.
6. For change-data-capture, query the /consume endpoint with a query parameter to receive a change-notification feed; alternatively, subscribe to Ethos events for real-time push-based integration if the Ethos Event Broker is configured.