Generating and Managing API Credentials

Overview

The Cadence client API can be utilized to programmatically import data, send messages, and retrieve information. To utilize the API, a custom application must be written to work between Cadence and your system of record. The Cadence API is the server and your application is the client. This article will explain how to generate and manage API credentials (necessary for request headers)

Generating API Credentials

Cadence API credentials can be generated in the platform under API > [New Credential]. These credentials must be provided in the request header when making requests using the API.

Considerations

Before generating or managing credentials, there are some important considerations.

• API credentials provide a significant level of access to the system.  Contact data can be viewed, updated, and SMS messages can be triggered.
• API credentials can only be viewed once within Cadence, and that is immediately after they are created.  As such, they should be stored securely at that time.
• If API credentials are no longer used, become lost/unknown, or if there are questions about their security, they should be disabled immediately and new credentials should be generated
• When API credentials are disabled, any applications that are using them on campus will no longer function.

Managing API Keys

The list of existing credentials is displayed.  The secret is no longer visible after creation, but the name and key can help identify what the key is utilized for.  

Credentials can be revoked by using the menu under the three dots to the right.  

New credentials can be generated with the [ New Credential] button. 

Credentials should generally be used by a single application or integration and not widely shared.  The name should be appropriate and precise to help later identify what they are being used for.

As mentioned, the credentials will only be fully visible at this time.

Credentials should be stored securely once generated, and utilized within your applications with attention to standard security practices for your development framework/language/environment.  Access to these keys provides a significant level of access to your data and messaging functionality within Cadence.

For full API documentation, visit this page.