API: Publish an API

Overview

This document outlines the procedure for publishing an API.

Guided Simulation

Simulation: Publish 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 Products.
  4. Click Add.
  5. Select New Product.
  6. Enter a Title for the Product.

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

  7. Click Create Product.

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

  1. Enter a Description.
  2. Enter Contact information (Name, Email, and URL).

    Note: Use a group instead of an individual if possible.

Note: The License and Terms of Service sections can be left blank.

  1. Select Visible to: settings in the Visibility section.
    • Public - viewable by anyone without logging in to the API Portal.
    • Authenticated Users - must be logged in with UMICH credentials and be a part of the any developer org in the API Portal.
    • Custom - you must define your own groups (not recommended).
  2. Select Subscribable by: settings in the Visibility section.
    • Authenticated Users - must be logged in with UMICH credentials and be a part of the any developer org in the API Portal.
    • Custom - you must define your own groups (not recommended).
  3. Click Add API add icon.
  4. Check the boxes for your API and the applicable OAuth Token Provider.

    Note: Refer to the API Developer Cheat Sheet for a list of token providers.

  5. Click Apply.
  6. Click Delete delete icon on the Default plan in the Plans section.
  7. Click OK.
  8. Click Add Plan add icon.
  9. Click New Plan 1.
  10. Enter a Title for the plan.

    Note: Recommended plan names:

    • Non-restricted API: Open_(rate limit of how many calls per minute) If no limit, enter Open_unlimited.
    • Restricted API: Restricted_(rate limit of how many calls per minute) If no limit, enter Restricted_unlimited.

  11. Copy and paste Title Name into the Plan Name field.
  12. Click Add new rate limit add icon.
  13. Enter a rate limit.
  14. Check the Enforce Hard Limit box.
  15. If your plan is restricted, check the Require subscription approval box.
  16. Verify your API and token provider are present and checked.
  17. Click Save.
  18. Click Stage the product... cloud icon
  19. Select Sandbox.

    Note: Green text will indicate success in the upper-left corner.

  20. Click Navigate to... menu icon.
  21. Click Dashboard.
  22. If applicable, click Got it!.
  23. Click Sandbox Catalog.
  24. Delete the product that you used for testing by completing the following sub-steps:

    Note: It will have a State of Published.

    1. Click Manage manage icon.
    2. Select Retire.

      manage menu

    3. Click OK.
  25. Click Manage manage icon on your current product.

    Note: It will have a State of Staged.

  26. Select Publish.
  27. Click Publish.

    Note: The State will change from Staged to Published.

  28. Verify the product is published:
    1. Go to the Support page (INSERT LINK).
    2. Locate your organization's API portal URL.
    3. Click the URL to view your published product.
Last Updated: 
Thursday, April 20, 2017