Initial Setup

To use the APIs, you’ll need two separate accounts—a Functional Account and a Boomi Account—both using the same name. This allows us to associate API subscriptions with a specific project, team or department.

Step 1: Functional Account

This account is used to log into the API Developer Portal and manage your subscriptions.

• To request, modify, or convert a Functional Account, submit the Functional Account ARF.

  • Be sure to check AD (Active Directory) under access.

  • You may have separate Functional Accounts per project, team or department.

Tip: While you can log into the portal with your personal UMN account, you should not use it for API subscriptions. Always use a Functional Account.

Step 2: Boomi Account

This account is used to authenticate when calling APIs. You’ll have one Boomi Account for all your API subscriptions related to a project, team or department that matches to your appropriate Functional Account.

To request a Boomi Account:

1. Ensure your Functional Account is set up.

2. Email oit-integration@umn.edu to create a ticket in TDX.

Email Subject: Create Boomi API Account for <team name>

Include in the message body:

• Functional Account name

• Project/team/department name

• Platform(s) needed: Dev/Test, Production or Both

  • Request Dev/Test if you're unsure whether the APIs will meet your needs

  • Brief description of the anticipated use

  • Any special urgency or timeline requirements

Once created, the Boomi account password will be shared with you via Box.

Note: The functional and Boomi accounts will have the same name, but different passwords.

Tip: Label them clearly in your password manager to avoid confusion.

Step 3: Create an Application in Boomi

An application is a collection of your API subscriptions.

1. Log into the API Developer Portal with your Functional Account

   • Production API Portal

   • Dev/Test API Portal

2. Go to Applications > Register an Application

   • Tip: Consider having a separate Application for each project.

     • This will allow you to have multiple subscriptions to the same API (one per project)

     • Each subscription will have a different API key

     • On key renewal or change, you will only need to update one project

3. Fill in the form and click Register

   • Use a clear, descriptive name that reflects your campus/team/department and project. Example: UMD-ITSS-Bookstore

   • Use a shared email address that is regularly monitored. Important communications like subscription renewals will be sent here.

NEXT STEP: Subscribe to an API