Application API Keys

You can use the Application API Keys page to generate and store the application keys for third-party applications that want to use CampusLink APIs or Student Web App. To allow the key-based authentication for third-party application integrations using CampusLink APIs or Student Web App, the application keys can be generated and stored using the new settings menu added.

This page helps Staff Members to generate or regenerate and store the API keys for the third-party application that wants to use CampusLink APIs or Student Web App.

The integrating application is expected to use the calling application and Application key while calling the CampusLink APIs or Student Web App.

While CampusLink continues to support staff credentials based authentication (where the staff username and password are to be supplied), it is recommended to use Key Based authentication as this reduces the need for these staff member accounts to be added to Active Directory and Microsoft Entra (formerly called Azure Active Directory) in these environments. Key Based authentication reduces the issue related to security and maintenance of the User account that is used for CampusLink API calls by various integrators. Also, any client applications that use the staff member specified in the ApiUserName and ApiUserPassword keys in SyRegistry to authenticate with CampusLink should move over to key based authentication. The SyRegistry keys APIUserName and ApiUserPassword are deprecated and will be removed in a future Anthology Student release.

Prerequisites

To view the page, you must have System - Settings - View authorization.

You can associate a staff user for a particular key. This staff member's identity is used for API calls made using the key-based token. You can create a new staff member if needed, grant them the necessary campus and staff group permissions to track the changes made during the integration.

The staff member associated with the key must have the permissions and authorizations required for a particular integration.

Access Method

Select the Settings tile > expand System > select Application API Keys.

Actions Available

Columns

Added By Indicates the User ID from which the Application API Key was added. Calling Application Indicates the name of application that uses the CampusLink API for the integrations. This field is limited to 200 characters and cannot contain any space. Special characters and numbers are allowed. This field has to be unique. At the time of key generation, record the application key’s value for use in your client application code. This value is never displayed again after you leave this page. Expiration Date Indicates the date when the API Key is no longer valid. This date is posted when the integrations with given API key do not work. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. This field cannot be set to more than 2 years from the current date. Date Added Indicates the date when the Application key was entered.

Date Modified Indicates the date when the Application key was changed. Modified By Indicates the User ID from which the Application API Key was modified. Staff Indicates the last name and first name of the staff member. You can either create a new staff member with appropriate permissions or use an existing staff member with the required permissions. Each system-generated application key is associated with a system-generated staff member (for example, StudentApiUser@anthology.local) . This staff member only exists as a Staff record in the application and does not have a password or be required to be added as an AD/AAD user. As a result, this staff member is never used to authenticate against. However, this staff member’s authorizations in Anthology Student are used to determine permissions for API calls that are made in the system context, using the key. The staff member’s Id is also used to update the database for the calls made by the client application. By default, this staff member will have admin access. You can adjust the user’s permission based on the needs of your application.