Embedded Files
This guide outlines the renewal process for a Common Good API subscription. Renewing involves obtaining a new API key before the current one expires. The new subscription will be valid for one year from approval and provides a new key.
Step 1: Request a New Subscription
Step 1: Request a New Subscription
Yes, you need to subscribe to the same API again to renew the key. Do not use Generate a New Key as this will not renew the subscription, only change the key.
One month before expiration, an email will be sent to the AD account associated with the application.
Access the API Developer Portal
Sign in using your Functional Account (typically the one that received the notification).
From the main menu, select API Catalog.
Locate and open the API you wish to renew.
Click Subscribe and submit the request. A confirmation window will appear.
Step 2: Submit the Renewal Form
Step 2: Submit the Renewal Form
Production
Production
Access the Form: Renewal Form (TDX)
Complete the Form
Requestor: Your name
Department: Select your department
Request Type: Choose Subscription Renewal
API to Renew: Select the API
Belongs to Subscription: Enter the Application name used for the new subscription
Additional Information: Add relevant context
Submit: This creates a ticket with the OIT Integrations team.
Wait for your request to be processed
Dev/Test
Dev/Test
Send an email to oit-integration@umn.edu
Include:
Environment (Development or Test)
API name
Application name
Step 3: Retrieve the New API Key
Step 3: Retrieve the New API Key
Sign in again
From the main menu, click Subscriptions.
Identify the new subscription by its later expiration date.
Copy the Key
Copy the displayed API key.
Do NOT click “Generate Replacement API key.” The key is already generated.
Step 4: Update your processes
Step 4: Update your processes
Replace the expiring key with the new key wherever you are consuming the API
Both keys will work for up to 6 weeks or until the expiring key expires.
Page updated
Report abuse