Subscribe to API

Prerequisites

• Functional Account

• Boomi Account

• Boomi Application (see Initial Setup)

For each API, do the following:

Step 1: Find the API in API Developer Portal

Option 1 - Look at the Common Good API List on this website for general information about each API

Option 2 - Log into the Production API Developer Portal  or Dev/Test API Developer Portal 

• Use your AD Functional Account: your-functional-account@umn.edu (other campuses also use @umn.edu)

  • If you can't log in, did you request a Boomi Account for this portal AND are you using the Functional Account password?

• In the API Developer Portal you will see both Common Good and Team Specific APIs. Team APIs require approval from the owner of that API.

• You can drill down and get more information about each API such as input/output values and formats.

Questions? If you are unsure if an API will meet your needs or need more help, contact us at oit-integration@umn.edu to open a ticket in TDX.

Step 2: Subscribe to the API

• Log into the appropriate API Developer Portal using your AD Functional Account

  • Production API Developer Portal

  • Dev/Test API Developer Portal

  • Make sure you are subscribing in the correct portal for your use!

• Navigate to the desired API

• Click Subscribe

• Select your Application

• Include an optional message

• Click Subscribe to submit. Your subscription will be pending until we enable it.

• Complete Request to Use API steps below

• We will notify you once your subscription is enabled

Step 3: Request to Use the API

Once you have subscribed to an API, you need to get approval to use it.

For Dev/Test Use

APIs available in the Dev/Test environments are strictly for exploration, integration, and functional testing only. Do not use these APIs for production workloads or live customer-facing applications.

This non-production access allows you to safely build and refine your application before requesting full production access.

How to Request Non-Production Access

To subscribe to an API for use in your Dev/Test environment, please email our integration team at oit-integration@umn.edu with the following required information:

• Name of the Requesting Application

• Name(s) of the API(s) Requested

• Your Intended Use Case of the API(s) in non-production

For Production Use

Submit the Common Data Layer API ARF, with the following information:

• API name

• Business need (including the system name and how the data will be used)

• Audience details:

  • Who will use the system?

  • Will data be shown at the individual element level or in aggregated form?

Note:

• API requests may be routed to the data custodian for review or approval. 

• APIs have a data classification value; APIs with private-restricted data may require additional justification.

 Refer to the Data Security Classification Policy for more information.

See Also

• Try APIs

• Renew API Key