Get Access to Common Good APIs

To start using an already-existing common good API, follow the steps listed below. If an existing common good API does not meet business integration needs, see Custom Integrations Solutions.

For questions about this process, contact oit-integration@umn.edu.

1. Acquire or Identify the AD Functional Account to be Used

Teams or individuals that intend to subscribe to an API are expected to use a functional account, available in Active Directory (AD), for their application subscription in Boomi.  Functional accounts provide a way to track a particular subscription account back to the team/department (or the individual) that creates and manages it.

If a functional account needs to be created, request the creation of a new functional account, modification of an existing functional account, or a conversion to a functional account submit the Functional Account ARF. 

2. Request AD Functional Account to be built in Boomi

Once a functional account has been identified or created that will be used to gain access to the API Developer Portal in Boomi (a.k.a. API Catalog), request that the OIT Integration team create an account inside of Boomi using this same name using the following steps: 

1. Send a request email message to oit-integration@umn.edu

2. Subject line  “Create Boomi API Account for <team name>”

3. Message body should include these details:

• Functional account name

• Team/department name

• Brief description of the anticipated use for this account

• Any special urgency or timeline requirements

Note that this email message will open a ticket in TDX to the OIT Integration team for fulfillment

Following the creation of the Boomi account the integrations team will share the account credentials, including a password that is unique to Boomi, with the requestor for their use in the next API subscription step.

NOTE: The account created in Boomi will have the same username as the functional account; however, the password will be unique to Boomi. 

3. Submit a request to use a common good API

To request the use of an API to a production environment, submit the Common Data Layer API ARF. In order to submit the ARF, provide the following information:

1. The name of the API to be used

2. The business needs which access to this API will fulfill, including the name of the system that will consume the API and how the data will be used.

3. Information about the audience: Who will use the system consuming this data and will it be available at the individual data element level or in aggregated format in this system?

All API requests may be routed to the data custodian for review or approval. All APIs have a data classification value; APIs that contain private-restricted data may require additional business case justification prior to approval. See the Data Security Classification Policy for more information on data security classifications. 

To request the use of an API in a non-production environment, contact oit-integration@umn.edu with the following information:

1. The name of the API

2. The Boomi functional account name

4. Create an API Subscription Request in the Boomi API Developer Portal

Following the submission of the Common Data Layer API ARF, you must submit an API subscription request in the Boomi API developer portal following the process outlined in the Subscribe to a Boomi API document 

Note: Make sure the application being used in the integration is registered in Boomi.