Configure Connection
Ellucian Cloud guide
Arrange Ethos API access, enter your API key in NIM, and validate person retrieval before using Ellucian Cloud data for downstream automation.
Prepare the connectionDirect link to Prepare the connection
API setup documentation is gated by an Ellucian Ethos login. Contact Ellucian Support for assistance configuring access to the data your process requires.
NIM requires an API Key.
Configuration resourcesDirect link to Configuration resources
Use your authenticated Ethos documentation and Ellucian Support for API access setup. The Tools4ever Ellucian Cloud connector repository provides connector-specific reference material.
Obtain an API keyDirect link to Obtain an API key
- Work with your Ellucian administrator or Ellucian Support to configure Ethos API access for NIM.
- Obtain the API key for the intended environment and store it securely.
- Confirm that the key grants access to persons and the other data collections required by your downstream user automation.
Enter the connection settingDirect link to Enter the connection setting
- In NIM Studio, open Systems > Overview and add an Ellucian Cloud system, or select the existing system.
- Open Connection and enter the following setting.
| NIM setting | Value |
|---|---|
| API Key | The API key supplied for your Ellucian Ethos integration. |
- Save the connection.
Validate the resultDirect link to Validate the result
-
Select Test Connection. NIM attempts to retrieve a single person using:
GET /api/persons?offset=0&limit=1 -
If the test fails, verify the API key, network access, and permission to retrieve persons with your Ellucian administrator or Ellucian Support.
-
Collect the system and confirm that the required person, student, employee, academic, or organizational data is present.
-
Validate record matching and field mappings before using the collected data for downstream user automation.
The connection test checks person retrieval. Validate the other collections required by your process separately.
Resolve endpoint data validation errorsDirect link to Resolve endpoint data validation errors
If an endpoint encounters data validation errors, the collection fails and reports the issue found on the affected page of the API request. A successful connection test does not rule out validation errors on later pages or other endpoints.
- Review the collection error and identify the endpoint and affected request page reported by NIM.
- Contact Ellucian Support with the reported validation details so they can help identify and clean up the underlying data issues.
- After the data is corrected, collect again and confirm that the affected collection completes successfully.