Student Lab Guide IBM API Connect Proof of Technology v5 0 1 0

12/26/2018 APIC (v2018) Dev Jam - Lab 2 - The Developer Portal Experience - IBM Cloud Garage Method
APIC (v2018) Dev Jam - Lab 2 - The

Developer Portal Experience
Explore the key capabilities of the API Connect Developer Portal.
Before you start
This tutorial is meant to be used with a VM designed to showcase IBM

API Connect. If you do not already have a running instance, please sign
up for one.
Please log in () to be able to reserve an instance.
Tutorial
In this lab, we will take the API created in Lab 1 and
publish it to a Developer Portal; ready for
consumption by app developers. We will begin by
creating a new catalog and configuring the developer
https://www.ibm.com/cloud/garage/dte/tutorial/apic-dev-jam-lab-2-developer-portal-experience 1/13
portal for our Inventory product. We will then define

a new plan in the product and publish to our new
developer portal.
In this tutorial, you will explore the following key

capabilities:
• Configure Developer Portal and publish the APIs

• Create a Portal Account
• Create App and Subscribe to Plan
• Test API in Developer Portal
APIC Dev Jam Series

The APIC Dev Jam Series is a hands-on workshop
with lab exercises that walk you through the
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 Bluedemo reservation to get through all the
labs!
Lab 1 Create And Secure An API To Proxy An Existing

REST Web Service
(https://ibm.com/cloud/garage/tutorials/ibm-api-
connect-v2018/apic-dev-jam-lab-2-the-developer-
portal-experience#lab-1-create-and-secure-an-api-
to-proxy-an-existing-rest-web-service-https-lab-1-
link)
Lab 2 The Developer Portal Experience

portal-experience#lab-2-the-developer-portal-
experience-https-lab-2-link)
Lab 3 Add O Auth Security To Your API

12/26/2018
/ p j p
APIC (v2018) Dev Jam - Lab 2 - The Developer Portal Experience - IBM Cloud Garage Method
portal-experience#lab-3-add-o-auth-security-to-
your-api-https-lab-3-link)
Pre Requisites
1 APIC (v2018) Dev Jam Lab 1 - Create and Secure

an API
(https://ibm.com/cloud/garage/dte/tutorial/apic-
dev-jam-series-lab-1-create-and-secure-api)
Configure the developer portal and admin

password
In this section, you will configure the developer
portal for the sandbox catalog. Then you will define a
new plan for the Inventory product and publish to
this catalog.
Configure Developer Portal
1 In the API Manager from the main menu on the

left click on Manage.
2 Click on the Sandbox Catalog. Then from the left

menu click on Settings.
3 In the displayed settings menu click on Portal.
4 Click on Create.
5 On the Portal Service screen select your portal

service. This will generate a default Developer
Portal URL which is structured as https://<portal-
service-url>/<organization>/<catalog>. Click
on Create.
6 At this point the Portal creation has begun as

shown in the image below. Once the it is
completed you will receive an email containing a
link to activate the portal admin account.
7 Click on the back arrow to go back to the main

menu
8 Click on the link in your email and set a new

password for the admin account.
9 Sign out of the portal and bookmark this address

to use later.
Create a portal developer account

In order to test the live API, you first need to register
as an API consumer in the Developer Portal.
Launch The Developer Portal From Your Bookmark
1 If you bookmarked your Portal URL already, open

a new browser tab, launch the Portal website, and
then proceed to the Create a Portal Account steps
at the bottom of this page.
2 Otherwise, continue with the instructions below

to find your Portal URL.
Find URL From Catalog Settings
1 In the API Manager from the main menu on the

left click on Manage.
2 Click on the Sandbox Catalog tile.
3 Now from the left menu click on Settings.
4 In the displayed settings menu click on Portal.
5 Your URL is under Portal URL. Open this URL in

the browser.
Name a create account and create a portal

account
1 Click on the Create an account link.
2 Complete the registration form to set up your API

Portal account. The E-mail Address that you use
for the API Portal account must be different from
your API Manager login email address.
3 Check the E-mail account that you used to sign

up to the portal. After a few minutes, you will
receive a registration link that you will need to
click on to complete the account registration.
4 Click on the registration link and use your

Username and password to sign in to the API
Portal.
Register a test app

API Connect enforces entitlement rules to ensure
that consumers are allowed to access the API's that
are being requested. The instructions below will
guide you on registering your consumer application
and subscribing it to an API Product.
Create A New Consumer Application
1 Click on the Create an App button in the Create a

new App tile.
2 Give your application the title ThinkIBM

Consumer, then click on the Submit button.
Save The Consumer Application Credentials
When your consumer application is registered in the

IBM API Connect system, it is assigned a unique set
of client credentials. These credentials are required
to be provided on each API request in order for the
system to validate your subscription entitlements.
1 Click on the Show box in both Key and Secret to

reveal. Copy the Key and Secret. Save it to a text
editor. Then click on Continue
2 Now you've entered the App Dashboard. Here

you're able to see analytics of your APIs.
Subscribe To The API Product
At this point, your registered consumer application

has no entitlements. In order for it to be able to
access an API resource, you must subscribe to a
Product and Plan.
1 Click on API Products at the top of the screen.
2 Click on the Inventory APIs 1.0.0 product.
3 Click on the Subscribe button for the default plan

that is listed.
4 Follow the steps to Select your application,

Confirm Subscription, and View Summary. Then
click Done.
Test the API

The API Connect Developer Portal allows consumers
to test the API's directly from the website. This
feature may be enabled or disabled per-API.
1 Open the inventory 1.0.0 API to browse the API

definition.
2 Click on the GET /Items operation from the left-

hand palette.
3 In the right column, you will find information

about the request parameters and links to the
response schemas.
4 Click on the Try it tab.
5 If you only have one application registered, it will

be automatically selected in the Client ID drop-
down menu. If you have more than one, select
the application which is subscribed to this API
Product.
6 Paste your Client Secret into the provided field.
7 Click on the Send button to invoke the API.
8 Scroll down to see the call results.
Note: If running for the first time, you may see Code:

0 No response received. Causes include a lack of
CORS support on the target server, the server
being unavailable, or an untrusted certificate being
encountered. Clicking the link below will open the
server in a new tab. If the browser displays a
certificate issue, you may choose to accept it and
return here to test again.
Summary
You completed the APIC Dev Jam Lab 2 - The
Developer Portal Experience. Throughout the
tutorial, you explored the key takeaways:
• Configure Developer Portal and publish the APIs.
• Create a Portal Account.
• Create App and Subscribe to Plan
• Test API in Developer Portal.
Continue the APIC Dev Jam! Go to APIC Dev Jam -
Lab 3 - Add OAuth Security to your API
(https://ibm.com/cloud/garage/dte/tutorial/apic-dev-
jam-lab-3-add-oauth-security-your-api) to learn
about configuring an OAuth provider service.
How likely are you to recommend this tutorial to a friend or
colleague?
1 2 3 4 5 6 7 8 9 10
How can we improve? (or any other comments)...
Submit
Learn
Topic (https://www.ibm.com/cloud/learn)
Data Centers (https://www.ibm.com/cloud/data-centers)
Products (https://www.ibm.com/cloud/products/)
Solutions (https://www.ibm.com/cloud/solutions/)
Customers (https://www.ibm.com/case-studies)
Security (https://www.ibm.com/cloud/security)
Build
Get started (https://www.ibm.com/cloud/get-started)

Docs (https://console.bluemix.net/docs/?
cm_mmc=IBMBluemixGarageMethod-_-MethodSite-_-10-
19-15::12-31-18-_-docs)
Architectures (/cloud/garage/architectures)
Practices (/cloud/garage/category/practices)
Toolchains (/cloud/garage/toolchains)
Courses (/cloud/garage/category/courses)
(/cloud/garage/dte)
Engage
Support (https://www.ibm.com/cloud/support)
Services (https://www.ibm.com/cloud/services)
Garage Home ()
Partners (https://www.ibm.com/cloud/partners)
Your Account
Sign up (https://console.bluemix.net/registration/?
19-15::12-31-18-_-bm_reg)
Login (https://console.ng.bluemix.net/login/?
19-15::12-31-18-_-bm_login)
Get help (https://support.ng.bluemix.net/gethelp/?

19-15::12-31-18-_-bm_help)
Login issues (https://support.ng.bluemix.net/supportticket/?
app=account&index=2&cm_mmc=IBMBluemixGarageMethod-
_-MethodSite-_-10-19-15::12-31-18-_-bm_ticket)
Analytics (/cloud/garage/analytics)
Social
Blog (https://www.ibm.com/blogs/bluemix/)
Twitter (https://twitter.com/IBMcloud)
YouTube (https://www.youtube.com/user/IBMCloud)
Facebook (https://www.facebook.com/IBMCloud/)
Garage
Visit a Garage (services/what-is-the-cloud-garage)

Cloud adoption and transformation services
(/cloud/garage/services)
What's New (/cloud/garage/news)
Garage Method
Culture (/cloud/garage/category/culture)
Discover (/cloud/garage/category/discover)
Envision (/cloud/garage/category/envision)
Build (/cloud/garage/category/build)
Manage (/cloud/garage/category/manage)
Run (/cloud/garage/category/run)
Learn (/cloud/garage/category/learn)
Experimental: Translate this page (machine translation): Select Language

Student Lab Guide IBM API Connect Proof of Technology v5 0 1 0

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Student Lab Guide IBM API Connect Proof of Technology v5 0 1 0

Enviado por

Direitos autorais:

Formatos disponíveis

12/26/2018 APIC (v2018) Dev Jam - Lab 2 - The Developer Portal Experience - IBM Cloud Garage Method

APIC (v2018) Dev Jam - Lab 2 - The

Before you start

This tutorial is meant to be used with a VM designed to showcase IBM

Please log in () to be able to reserve an instance.

portal for our Inventory product. We will then deﬁne

In this tutorial, you will explore the following key

• Conﬁgure Developer Portal and publish the APIs

APIC Dev Jam Series

Lab 1 Create And Secure An API To Proxy An Existing

Lab 2 The Developer Portal Experience

Lab 3 Add O Auth Security To Your API

1 APIC (v2018) Dev Jam Lab 1 - Create and Secure

Conﬁgure the developer portal and admin

Conﬁgure Developer Portal

1 In the API Manager from the main menu on the

2 Click on the Sandbox Catalog. Then from the left

3 In the displayed settings menu click on Portal.

5 On the Portal Service screen select your portal

6 At this point the Portal creation has begun as

7 Click on the back arrow to go back to the main

8 Click on the link in your email and set a new

9 Sign out of the portal and bookmark this address

Create a portal developer account

Launch The Developer Portal From Your Bookmark

1 If you bookmarked your Portal URL already, open

2 Otherwise, continue with the instructions below

Find URL From Catalog Settings

1 In the API Manager from the main menu on the

2 Click on the Sandbox Catalog tile.

3 Now from the left menu click on Settings.

4 In the displayed settings menu click on Portal.

5 Your URL is under Portal URL. Open this URL in

Name a create account and create a portal

1 Click on the Create an account link.

2 Complete the registration form to set up your API

3 Check the E-mail account that you used to sign

4 Click on the registration link and use your

Register a test app

Create A New Consumer Application

1 Click on the Create an App button in the Create a

2 Give your application the title ThinkIBM

Save The Consumer Application Credentials

When your consumer application is registered in the

1 Click on the Show box in both Key and Secret to

2 Now you've entered the App Dashboard. Here

Subscribe To The API Product

At this point, your registered consumer application

1 Click on API Products at the top of the screen.

2 Click on the Inventory APIs 1.0.0 product.

3 Click on the Subscribe button for the default plan

4 Follow the steps to Select your application,

Test the API

1 Open the inventory 1.0.0 API to browse the API

2 Click on the GET /Items operation from the left-

3 In the right column, you will ﬁnd information

4 Click on the Try it tab.

5 If you only have one application registered, it will

6 Paste your Client Secret into the provided ﬁeld.

7 Click on the Send button to invoke the API.

8 Scroll down to see the call results.

Note: If running for the ﬁrst time, you may see Code:

How can we improve? (or any other comments)...