Skip to main content

Configure Connection

Anthology CampusNexus guide

Create an Application API Key for the Student REST APIs, encode it locally, and use the resulting value as the NIM client key.

Before you beginDirect link to Before you begin

  • 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.
Protect the 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.

Create an Application API KeyDirect link to Create an Application API Key

  1. In the CampusNexus Admin Portal, go to Location > Settings > System > Application API Keys.

  2. Select New to create an API key.

  3. Enter the calling application name, select the staff access appropriate for the NIM integration, and save the key.

  4. 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 is the client key used by the CampusNexus connection in NIM.

Configure and validate in NIMDirect link to Configure and validate in NIM

  1. Open the Anthology CampusNexus system connection in NIM.
  2. Paste the encoded value into Client Key, then save the connection.
  3. Run a collection or connection test using an account with access to the Student REST APIs.
  4. If authentication fails, 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.
Last updated on