API Keys

To enhance the security of Anthology Inc. products, API keys were added to the products released in May 2018 and later. An API key is a secret token that is submitted with a web service request to identify the origin of the request. The key for the consumer of the service needs to match the key of provider of the service, otherwise access to the service is rejected. The API key is unique for each customer.

The API key is an AppSetting in the web.config files of applications built on the CampusNexus framework. It uses the following syntax:

<add key="apiKey" value=""/>

The API key is the same key that is used in the Package Manager screen of Installation Manager.

API Key

Installation Manager 1.18 and later automatically adds the key value to the web.config files during installation of the following product versions:

  • CampusNexus CRM 12.0 and later
  • Anthology Student 19.0 and later
  • Contracts & Activities 19.0 and later
  • Portal 19.0 and later
  • Regulatory 10.1 and later
  • Financial Aid Automation 6.2 and later
  • Workflow Composer 2.6 and later

Using Earlier Product Versions

If you are using products with earlier versions in combination with any of the above listed versions, the API key must be manually added to the web.config file of the older version.

If there is no key defined in the web.config file, a default key that exists in the authentication provider will be used.

Depending on the product and version, you may need to overwrite the default key with your customer-specific key value.

— OR —

If the appSettings section does not contain the <add key="apiKey" value=""/> line, add the line and specify your key value.

The following is a snippet of a web.config file for Forms Builder Renderer 3.4:

  <appSettings>
    <add key="ConfigureCampusNexusWcfProxy" value="true" />
    <add key="ConfigureCVueNexusWcfProxy" value="true" />
    <!-- Following will be populated when Crm is enabled for Forms Builder -->
    <add key="CmcNexusCrmWebUrl" value="http://<server:port>/" />
    <add key="PaymentProvider" value="pilot-payflowpro.paypal.com" />
    <add key="AuxiliaryServiceBaseUrl" value="" />
    <!-- Following should be set to true only in Azure environments where the Auxiliary service is installed and required. -->
    <add key="UseRemotePdfConversionService" value="false" />
    <!-- Following sets a time before conversion to PDF starts. Default 500, increase if blank documents on a slow server. -->
    <add key="ViewCreatorDefaultStartConversionTimerInMilliseconds" value="" />
    <add key="ApiKey" value="<Your API key value>" />
  </appSettings>
alert If the API keys are not set up correctly, an "Access denied" error will be seen in the Renderer log, for example, when a Forms Builder workflow calls an Anthology Student activity.