APIC Dev Jam Lab 1 - Create and Secure an API

• Creating an API by importing an OpenAPI definition for an existing REST service.

• Configuring ClientID/Secret Security, endpoints, and proxy to invoke endpoint.

• Testing a REST API in the online developer toolkit.

• Publish an API for developers.

APIC Dev Jam Series

Import API to the Developer Workspace

1. Open a browser window to the API Manager Portal. If the screen displays [[\“Your connection is not private\”]] click Advanced, and then Accept the to continue. Log in with the username ad credentials supplied.

   

   When you login for the first time you will see What’s new in API Connect 10. Click Done after reviewing.

   

2. Click on the [[Develop APIs and Products]] tile to enter the online development workspace.

    

3. Now you are in the home screen of the online developer tool. From here, you can begin to create APIs and Products.

    

4. Click [[ADD->API.]]

    

5. On the next screen, select [[Existing OpenAPI]] under Import, as in the image below. Then click [Next.]

    

6. Now download the[[Inventory.yaml]]  file the dte-labs git repository using the following command.

   curl -OL https://raw.githubusercontent.com/ibm-cloudintegration/dte-labs/master/APICv10/inventory.yaml
   
   Copy to clipboardCopied!

   You can also down the file using this link : inventory.yaml

   Choose the downloaded [[Inventory.yaml]] OpenAPI definition and Click [Next.]

    

7. [Do not ]select [Activate API]. Click [[Next]].

    

8. The API should be imported successfully as shown in the image below. Click [[Edit API]].

   

Configure API

Configure API Key security

1. Click [[Security Definitions]].

2. In the [[Security Definition]] section, click the [[Add]] button on the right. This will open a new view titled [[API Security Definition][.]]

3. In the [Name] field, type [[client-id]].

4. Under [Type], choose [[API Key]]. This will reveal additional settings.

5. For [Located In] choose [[Header]]. For [Key Type] choose [[Client ID]]. In [[Parameter Name]] type [[X-IBM-Client-Id]]. Your screen should look like the image below. 

   

6. Click the [[Save]] button to return to the [Security Definitions] section.

7. Click [[Add]] again to add the client secret definition.

8. Under [Name,] type [[secret]].

9. For [Located In] choose [[Header]]. For [Key Type] choose [[Client Secret]]. In [[Parameter Name]] type [[X-IBM-Client-Secret]]. Your screen should look like the image below. 

   

10. Click the [[Save]] button to return to the [Security Definitions] section.

11. Click [[Security]] in the left menu.

12. Click [[Add. ]]This will populate the [Security Definitions] table with secret and client-id. Select both as shown in the image below. Then click [[Save]]. 

    

13. Add security and enable secret and client-id. Click Save to save the changes.

    

Define Target-URL for Sandbox environment

1. Click on [[Properties]] in the left menu.

2. Click on the target-url property. The target-url property is automatically inserted to be able to define multiple run-time targets for the service.

3. In the [Default value] text field, type https://apic-pot-inventory-api.mybluemix.net[.]

4. Click [Add.]

5. Choose the [Sandbox catalog] and for the URL type https://apic-pot-inventory-api.mybluemix.net

6. Click [Save] to complete the configuration.

Configure Proxy Call in Designer

1. On the top Navigation, click [[Assemble]].

2. Click [[Invoke]] in the flow designer.  

3. This will open a window from the right to configure. In the URL field, type [[\$(target-url)\$(request.path)\$(request.search)]]. 

4. Click [[Save]].

Test the API

1. Click the [play] [icon] as indicated in the image below. 

   

2. Toggle [[Offline]] to activate API. to publish the API itself to the gateway for testing.  

   

3. After the API is published, additional tabs appear your screen should look like the image below.

4. Choose [Test] tab and append [/Items] to the URL as shown below.

   

5. Your client Id  and client secret for the sandbox-test-app is prefilled.

6. Scroll all the way to the bottom of the test view.

   

7. Click [[Send]].

8. If this is the first test of the API, you will see a certificate exception. Simply click on the URL and choose the option to proceed.

9. Go back to the test view and click [[Send]] again.

10. Now you will see a Response section with Status code 200 OK and the Body displaying all the inventory items.

    

Publish API

Create Inventory Product and Add API

1. From the vertical navigation menu on the left, click [Develop] to return to the Develop home screen.

   

2. Click [Add] and select [Product].

3. On the next screen, select [New Product]. Then click [Next].

4. For the Title, enter [[Inventory APIs][.]] Click [Next].

5. Select the [inventory 1.0.0 API] as shown in the image below. Then click [Next].  

   

6. Keep the [Default Plan] as is. Click [Next].  

   

7. Under [Publish], enable [Publish Product] as shown in the image below. Then click [[Next][.  ]]

   

8. The Product is now published successfully with the API base URL listed and available for developers from the developer portal. Go to APIC (v10) Dev Jam - Lab 2 - The Developer Portal Experience to see how to access this API as a developer.

Summary

• Create an API by importing an OpenAPI definition for an existing REST service.

• Configure ClientID/Secret Security, endpoints, and proxy to invoke endpoint.

• Test a REST API in the online developer toolkit.

• Publish an API for developers.