Curating, Publishing, and Tracking APIs in Oracle API Manager Cloud Service

Purpose

This tutorial shows you how to curate, publish and track your application programming interfaces (APIs) in Oracle API Manager Cloud Service.

Time to Complete

1.5 hours

Background

With Oracle API Manager Cloud Service, you can create and publish APIs that expose the functionality of back-end systems or other services:

• A proxy service that's exposed as an API
• A user interface to help consumers find and use the APIs
• Runtime facilities for validating API keys and monitoring API usage

Scenario

In this scenario, you start by creating the Oracle API Manager Cloud Service users and groups:

User Name	Group	Role
curator	API Curator	API Curator
consumer	API Consumer	API Consumer
admin	API Admin	API Admin

Next, you import an existing service bus project, which will provide the proxy services that you will publish to the Oracle API Manager Cloud Service Portal as an API. The curation process for the API includes adding metadata to help consumers to discover and understand the API and publishing the API to the Oracle API Manager Cloud Service Portal.

You use the API Manager Cloud Service Portal to:

• Create an application
• Discover APIs for the application to consume
• Subscribe applications to APIs

Using the application key supplied by Oracle API Manager Cloud Service, you test the API to ensure that the key works. Finally, you view the captured runtime metrics in Oracle API Manager Cloud Service.

What Do You Need?

• A subscription or trial subscription to Oracle API Manager Cloud Service
• Mozilla Firefox and its RESTClient plug-in

Creating Groups for API Manager Roles

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open Fusion Middleware Control Console to start the Oracle Enterprise Manager application.

2. On the Login page, enter weblogic for the user name and password, and click Login.

   

3. In the Target Navigation pane, expand WebLogic Domain, right-click the domain name, select Security, and then select Users and Groups.

   

4. On the Users and Groups page, click the Groups tab, and then click Create.

   

5. On the Create a New Group page, enter API Admin in the Name field, enter a description in the Description field, select DefaultAuthenticator from the Provider list, and click Create.

   

6. On the Users and Groups page, repeat steps 4 and 5 to create two more groups:

   • API Consumer
   • API Curator

   After you create the groups, the Groups tab will look similar to the following list:

   

Assigning Application Roles to Groups

1. In the Target Navigation pane, expand WebLogic Domain, right-click the domain name, select Security, and then select Application Roles.

   

2. On the Application Roles page, under the expanded Search section, select Service_Bus_Console from the Application Stripe list, and click Search Application Roles.

   

3. On the Application Roles result page, scroll down, select APICurator, and click Edit.

   

4. On the Edit Application Role page for the API Curator role, click Add.

   

5. On the Add Principal page, select Group from the Type list, and click Search roles.

   

6. On the Add Principal result page, scroll down, select the API Curator role, and click OK.

   

7. On the Edit Application Role page, verify that the API Curator group is listed as a member, and click OK.

   

8. On the Application Roles page, verify that the API Curator group contains a membership for the APICurator role.

   

9. On the Application Roles page, under the expanded Search section, select API_Manager from the Application Stripe list, and click Search Application Roles.

   

10. On the Application Roles result page, scroll down, select APIConsumer, and click Edit.

    

11. On the Edit Application Role page for the API Consumer role, click Add.

    

12. On the Add Principal page, select Group from the Type list, and click Search roles.

    

13. On the Add Principal result page, scroll down, select the API Consumer role, and click OK.

    

14. On the Edit Application Role page, verify that the API Consumer group is listed as a member, and click OK.

    

15. On the Application Roles result page, scroll down, select APIApplicationAdministrator, and click Edit.

    

16. On the Edit Application Role page for the API Application Administrator role, click Add.

    

17. On the Add Principal page, select Group from the Type list, and click Search roles.

    

18. On the Add Principal result page, scroll down, select the API Admin role, and click OK.

    

19. On the Edit Application Role page, verify that the API Admin group is listed as a member, and click OK.

    

Creating Oracle API Manager Cloud Service Users

1. In the Target Navigation pane, expand WebLogic Domain, right-click the domain name, select Security, and then select Users and Groups.

   

2. On the Users and Groups page, click the Users tab, and then click Create.

   

3. On the Create a New User page, enter curator in the Name field, enter a description, select DefaultAuthenticator from the Provider list, enter and confirm your password, and then click Create.

   

4. On the Users and Groups page, repeat steps 2 and 3 to create two more users:

   • consumer
   • admin

   The Users tab will look similar to the following list:

   

Assigning Users to Groups

1. In the Target Navigation pane, expand WebLogic Domain, right-click the domain name, select Security, and then select Users and Groups.

   

2. On the Users tab, select the curator user.

   

3. On the Settings for User: curator page, click the Groups tab.

   

4. Select API Curator and Monitors from the Available list, click the right arrow to move the groups to the Chosen list, and click Save.

   

5. Repeat steps 2, 3 and 4 for consumer and admin users.

   The Settings for User: consumer page will look similar to the following:

   

   The Settings for User: admin page will look similar to the following:

   

In this section you import the Oracle Service Bus projects from a JAR file, which contains the Currency_Services and Utilities project configurations.

1. Download the sbconfig.jar file into a local directory on your system. This file contains the Oracle Service Bus sample applications.

2. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Service Bus Console to start the Service Bus Console application.

3. On the Login page, enter weblogic in the User ID field, enter the password, and click Sign In.

   

4. On the Service Bus Console page, click Create to create a session.

   

5. On the Resources tab, click the Import Config Jar icon.

   

6. On the Import Config Jar page, click Browse, find the sbconfig.jar file on your file system, and click Next.

   

7. Verify that the Currency_Services and Utilities projects are selected, and click Import.

   

8. Verify that the import was completed successfully, and click Close.

   

9. On the Service Bus Console page, click Activate.

   

10. On the Confirm Session Activation page, enter a description and click Activate.

    

After you've imported the sample project configurations to Oracle Service Bus, you publish the API to Oracle SOA Cloud Service so that consumers can subscribe to it.

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open Service Bus Console to start the Oracle Service Bus Console application.

2. On the Login page, enter curator in the User ID field, enter your password, and click Sign In.

   

3. On the Resources tab, expand the Currency_Services project, and click RestCurrencyRate.

   

4. On the RestCurrencyRate page, click the API tab.

   

5. Click Edit in the Overview section.

   

6. Enter the following values, and click Save:

   • Name: Currency Exchange Rate
   • Version: 1.0
   • Reference Name: API ref
   • Reference URL: http://www.gemservices.com/api/forex/1
   • Tags: cash, money

   

7. In the Publish Status section, click Edit, select Published from the Status list, select the Managed check box, and click Save.

   

8. On the Service Bus Console page, click Save Changes in All Tabs.

   

If your instance is behind a proxy, you need to create and add the Proxy Server to your project's business services.

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open Service Bus Console to start the Oracle Service Bus Console application.

2. On the Login page, enter weblogic in the User ID field, enter your password, and click Sign In.

   

3. On the Service Bus Console page, click Create to create a session.

   

4. On the Resources tab, expand the System directory and select Proxy Servers.  Click Create and select Create Proxy Server.

   

5. On the Create Proxy Server page, enter a resource name and a description, and click Create.

   

6. On the Proxy Server Definition page, enter your server host, port number, and login credentials, and click Save.

   

7. On the Resources tab, expand the Currency_Services directory, and select ConvertCurrencyBiz.

   

8. On the ConvertCurrencyBiz page, click the Transport Detail tab, expand Advanced Options, and click Browse next to the Proxy Server field.

   

9. On the Search and Select: Proxy Server Resource page, click Search.

   

10. Select the proxy server that you created, and click OK.

    

11. On the Service Bus Console page, click Save Changes in All Tabs.

    

12. On the Service Bus Console page, click Activate.

    

13. On the Confirm Session Activation page, enter a description and click Activate.

    

After you've imported the Currency Exchange project into the Oracle Service Bus Console in Oracle SOA Cloud Service, you manage the applications in the Oracle API Manager Cloud Service Portal.

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open API Manager to start the Oracle API Manager application.

2. On the Login page, enter consumer in the User ID field, enter your password, and click Sign In.

   

3. On the Oracle API Manager page, click Subscriptions.

   

4. In the APIs section, click New Application.

   

5. In the New Application dialog box, enter Currency Exchange in the Name field, enter a meaningful description in the Description field, and click Create.

   

   The Currency Exchange application generates a key:

   

After you've created your application in the Oracle API Manager Cloud Service Portal, you discover and subscribe to APIs.

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open API Manager to start the Oracle API Manager application.

2. On the Login page, enter consumer in the User ID field, enter your password, and click Sign In.

   

3. On the Oracle API Manager page, click Catalog.

   

4. On the Currency Exchange Rate 1.0 API page, click Details.

   

   The details page for the Currency Exchange API displays its statistics and the public URL that's used in the Firefox RESTClient to test the API.

   

5. On the Currency Exchange Rate 1.0 API details page, click Select.

   

6. In the Selected APIs section, click Subscribe.

   

7. On the application result page, select the Currency Exchange application, and click Select.

   

8. In the Subscription result dialog box, click Go to Subscriptions.

   

   The Currency Exchange application appears in the Applications section with the API subscription.

   

In this section, you use a REST client for Mozilla Firefox.

1. In the Mozilla Firefox browser, click the RESTClient plug-in to open the client application.

   

2. On the RESTClient page, enter the URL of your Currency Exchange application, add USD/CAD at the end of the URL, and click Send.

   

   Note: USD/CAD represents the required parameters for the Currency Exchange API. The API URL is taken from the Currency Exchange details page.

3. On the Response page, verify that the status code is 403 Forbidden.

   

   The 403 Forbidden status code is returned because the API key wasn't included in the request.

4. On the RESTClient page, click Headers, and select Custom Header.

   

5. In the Request Header dialog box, enter X-API-KEY in the Name field, enter the generated key in the Value field, and click Okay.

   

6. On the RESTClient page, verify that the API key was added to the Headers pane, and click Send.

   

7. On the Response page, click the Response Body (Raw) tab, and verify that the conversion rate result was returned.

   

After you've tested your API with the RESTClient plug-in, some activity is generated for the Currency Exchange Rate API and the statistics have changed.

1. Open Oracle SOA Cloud Service Console, select the service instance that you want to manage, and click Open API Manager to start the Oracle API Manager application.

2. On the Login page, enter admin in the User ID field, enter your password, and click Sign In.

   

3. On the Oracle API Manager page, click Catalog.

   

4. On the Currency Exchange Rate 1.0 application page, click Details.

   

5. On the Currency Exchange Rate 1.0 API details page, select Since Last Reset from the View Statistics list.

   

   The statistics are displayed. Your metrics may be different, depending on the tests you performed in the RESTClient plug-in.

   

6. On the Oracle API Manager page, click Subscriptions to review the existing users' subscription.

   

   Note: The Quick Search section classifies the APIs by their usage.

• Using Oracle API Manager in the Oracle Help Center