API: Create and Test an API

Overview

This document outlines the procedure for creating and testing an API.

Before You Begin

 

  1. Submit a request to join the API Directory to publish an API by clicking Request to join a provider organization 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 manager.
  3. Log in with your level 1 UMICH credentials and 2-factor authentication (DUO).
  4. Click Confirm to confirm your identity.

 

Guided Simulation

Simulation: Create and Test 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 Directory Field Description page for context around the fields and sections in the API Directory while creating an API.

 

Step-by-Step Procedure

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

  1. Click Navigate to...

    menu icon

  2. Click Drafts.
  3. Click the APIs tab.

    Note: You will see all of the APIs developed by your provider organization members.

  4. Click Add.
  5. Select New API.
  6. Enter a Title for the API.

    Note: The Name field will default based on the value in Title field.

  7. Click Create API.
  8. Click Got it!

    Note: This is a one time message and you may only see it if this is your first time in the API Directory.

Important: Click Save save icon often to avoid losing work.

Note: Policy Assembly will be skipped over at this time, but users will return to this section later in the process.

add icon

  • Click Add Path add icon in the Paths section.

    Paths section with add path button

  • Enter the Path. Include the parameter in curly brackets. (i.e. /path/{parameter})
  • Click Get.
  • Click Add Parameter.

    Note: Adding a Parameter is not required.

    Paths section with add parameters information

  • Select Add new Parameter.
  • Enter the Name of the parameter (without brackets).
  • Select Path from the Located In drop-down list.
  • Enter a Description for the parameter.
  • If applicable, add additional parameters.
  • If applicable, use the Tags section to make your API more easily searched by tag.
  • Click Policy Assembly on the left navigation or scroll up to the section.
  • Click Edit Assembly.
  • Click Invoke.
  • Enter the Title and Description.
  • Overwrite the existing value in the URL field with: $(endPointUrl)$(api.operation.path).
  • Click Save save icon.

    Note: The API is not published, but is ready to test.

  • Click Test.

    Test icon

  • Verify Sandbox is selected under Catalog on the left side of the screen.
  • Enter a Name to create a new product.
  • Click Save save icon.

    Note: While it is not required to add an OAuth security API, if you did add an OAuth security API, you must bundle it with your API in order to allow access to your API once published.

    Note: If you added an OAuth security definition to your API, complete the following set of sub-steps:

    1. Click All APIs.
    2. Click Products.
    3. Click your product.
    4. Click APIs on the left navigation or scroll down to the section.
    5. Click Add API add icon.
    6. Check the box for the applicable OAuth Token Provider.
    7. Click Apply.
    8. Click Save save icon.
    9. Click All Products.
    10. Click APIs.
    11. Click your API.
    12. Click Assemble.
    13. Click Test.

      Test icon

     

  • Click Create and Publish.
  • Click Next.
  • Select an Operation.
  • Click Authorize.
  • Enter an assignmentId in the Parameters section.
  • Click Invoke.
Last Updated: 
Tuesday, June 13, 2017
ITS.umich page: