Skip to main contentDemoHub - Cloud Pak for Integration

APIC Dev Jam - Lab 7 - The Consumer Experience

In this lab, you will explore the consumer experience for APIs that have been exposed to your Sandbox catalog. Using the Developer Portal, you will log in and subscribe to the latest Accessories Product and test the APIs from the portal, before testing it in a live Web Application.

In this tutorial, you will explore the following key capabilities:

  • Subscribe to a plan in order to consume an API.

  • Test an API from the developer portal.

  • Consume an API from a sample test application.

    APIC Dev Jam Series

The APIC Dev Jam Series is a hands-on workshop with lab exercises that walk you through designing, publishing, and securing APIs. This workshop is for API developers, architects, and line of business people who want to create a successful API strategy. There are 8 labs and each is 30 minutes long. Make sure you choose enough time in your reservation to get through all the labs! 

[NOTE: ][This demo environment contains a full API Connect installation in Cloud Pak for Integration. The login information to the APIC cluster will be sent in a separate email when you reserve the instance. Use Google Chrome, Firefox or Microsoft Edge to access the cluster using the credentials supplied. Make sure you login using API Manager User Registry not Common Services registry.]

Prerequisites: Labs 1-6

Subscribe o the Accessories Product

In this section, you will subscribe to a plan for the Accessories Product using the IBM Consumer application.

  1. Launch the Developer Portal in a browser using the link provided.

  2. If you are logged in to the portal, log out to clear your session.

  3. Click the [[API Products]] link.   tutorial html 444fff2d8e0d46b7

  4. Notice that only the Inventory product is listed, even though you just published the Accessories product. Recall that you assigned the Accessories product to be visible only by developers who are logged in to the portal.

  5. Enter Login page using Sign in option at the top right corner of the page.

    tutorial html db604e248301f829
  6. Login using the username \<portaluser> and password \<portaluser-password>

    tutorial html 492593c5f2350159
  7. Click the [[API Products]] link after logging in.

  8. Select the [[ Accessories 1.0.0]] product. 

    tutorial html 6efccbf2582a30c0  

  9. You will be directed to the Product page which lists the available plans for subscription. Click [[Subscribe]] under the [[Silver]] plan.   tutorial html fd5ece1fe8b66fa5

  10. Note: The Gold plan requires approval by the API provider for any subscription requests and allows unlimited requests for a given time period. The Silver plan is limited to 100 requests per hour and does not require approval by the API provider for subscription requests.

  11. A subscription wizard is initiated. All the applications available are displayed (in this case we only have the IBM Consumer application). Click [[Select App]] which is located below the application tile.   tutorial html fe0fc338b5ae9fd3

  12. A window with the subscription details is displayed to confirm the information provided. Click [[Next]] once you have reviewed the information.   tutorial html ea31c68f8a08a741

  13. The last step is displayed with the summary of the subscription. Click [[Done]] to finalize the wizard.   tutorial html 359b7068e5f3a808

Test APIs from the Developer Portal

In this section, you will use the Developer Portal to test one of the Accessories APIs. This is useful for application developers to try the APIs before their application is fully developed or to simply see the expected response based on inputs they provide the API.

  1. Click the [[logistics 2.0.0]] API link on the Accessories product page.   tutorial html 8ec6b1024d5a2f9a

  2. Click the [[GET /shipping]] path on the left navigation menu. 

  3. Click the `Try it` link to access the test area.   tutorial html 6326764a039cba2b

  4. Scroll down to the Parameters section, enter any United State Zip Code (e.g., `90210`) and click [[Send]] to invoke the API.   tutorial html 74d26a44eab03d67

  5. You should see a [[200 OK ]]and a response body as shown below.   tutorial html f9b90c1492df91e8

  6. Go ahead and try out the [[Logistics GET /stores]] and the [[Financing GET /calculate ]]APIs as well.


Congratulations! You have created multiple plans, tested APIs in the developer portal, and used the APIs in a consumer application.