API: Subscribe to an API

Overview

This document outlines the procedure for subscribing to an API.

Before You Begin

1. Submit a request to join the API portal using the web form on the Getting Started page.
2. Once your request is approved, you will receive 2 emails. In the second email, the long URL will take you to the activation page of API portal.

Guided Simulation

Simulation: Subscribe to an API

Before You Begin

1. See the Glossary for an alphabetical list of definitions of terms related to APIs and the API Directory.
2. See the API FAQ page for context around some of the secions you'll encounter while creating, testing and publishing an API.

Step-by-Step Procedure

The same information from the simulation above is explained in a step-by-step format.

1. Log in to the API portal using your UMICH credentials.
2. Click the Apps tab.
3. Click Create new App.
4. Enter a Title.
5. Click Submit.
6. Check the Show Client Secret box. Copy this URL and store it securely.

   Important: You will need both the Client Secret and Client ID for getting the access token. This is your only opportunity to record the Client Secret.

7. Check the Show box next to the Client ID field. Copy this Client ID and store it securely.
8. Click the API Products tab.
9. Click the API you want to subscribe to.
10. Click Subscribe.
11. Turn on the radio button for the application you just created.
12. Click Subscribe.

    Notes:

    • If it is a public API, the request will be automatically approved.
    • If it is a restricted API, you will need to wait until the API owner approves the request. An email notification will be sent upon approval or denial.

Note: It is recommended that you test the API before coding it into your application. Complete the following steps in the API portal to test:

13. Log in to the API Portal.
14. Click API Products.
15. Click the API product you subscribed to.
16. Click on the API in the left navigation.
17. Select the Client ID from the drop-down list.

    Note: All of your applications will display in this list.

18. Enter the Client Secret.
19. Click Authorize.
20. Enter the Parameter.
21. Click Call Operation.

    Note: The data will display below. If you receive an error, reach out to the contact person/group for the API.

To visit the API Directory, click here.