Configure Connection
Anthology CampusNexus guide
Create an Application API Key for the Student REST APIs, prepare the encoded key, and test OData access from NIM.
Before you beginDirect link to Before you begin
NIM requires Hostname and API Key. Public API setup documentation is not readily available; use the existing Admin Portal procedure below and consult your vendor for environment-specific access requirements.
- Confirm that you can sign in to the CampusNexus Admin Portal and manage Application API Keys.
- Choose a clear calling application name for NIM, such as
Tools4everNIM. - Have a secure location ready to store the generated application key.
The application key and its Base64-encoded value grant access to the Student REST APIs. Treat both as secrets: do not put them in tickets, email, screenshots, or public encoding websites.
If the required CampusNexus information is already synchronized to Ellucian Ethos Cloud, consider the Ellucian Cloud integration as an alternative. Confirm that its available data and operations meet your process requirements, including any student record updates.
Create an Application API KeyDirect link to Create an Application API Key
-
In the CampusNexus Admin Portal, go to Location > Settings > System > Application API Keys.
-
Select New to create an API key.
-
Enter the calling application name, select the staff access appropriate for the NIM integration, and save the key.
-
Copy the Calling Application Name and Application Key. Store the application key securely.
Create the NIM client keyDirect link to Create the NIM client key
Build a JSON value using the calling application name and application key. Then Base64-encode that JSON with UTF-8 encoding.
{"CallingAppName":"<CALLING_APPLICATION_NAME>","KeyValue":"<APPLICATION_KEY>"}
For example, in PowerShell, replace both placeholder values before running the command:
$payload = '{"CallingAppName":"<CALLING_APPLICATION_NAME>","KeyValue":"<APPLICATION_KEY>"}'
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes($payload))
Copy the command output. This encoded value is the API key used by the CampusNexus connection in NIM, called Client Key in the existing setup instructions. Base64 is encoding, not encryption; protect the output as you would the original key.
Configure and validate in NIMDirect link to Configure and validate in NIM
- Open the Anthology CampusNexus system connection in NIM.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The CampusNexus host for the environment NIM will access, using the format expected by the Connection screen. |
| API Key | The Base64-encoded JSON value prepared in the previous step. If the field is labeled Client Key, enter the same encoded value there. |
Test OData accessDirect link to Test OData access
- Select Test Connection. NIM attempts to retrieve the UsaStates OData collection.
- If the test fails, check the hostname, network access, and API permissions. Confirm that the calling application name and application key were copied exactly, the JSON property names remain unchanged, and the value was Base64-encoded as UTF-8.
- Collect the student, enrollment, group, and relationship collections needed by your process. Validate record matching before using the data for downstream provisioning or roster management.
- Test intended student updates and school-defined field changes with safe records before enabling automated writes.
A successful UsaStates test confirms access to that OData collection. Validate permissions for your other collections and intended updates separately.