Creating a Product

Objective

After completing this lesson, you will be able to create a product

Product Creation

In this lesson, the following topics are discussed:

  • What are Products in the context of SAP API Management?
  • Create and publish a Product
  • Show Products at API Business Hub Enterprise Portal
  • Navigate to your Product
  • Navigate to your API
  • API Business Hub Enterprise portal in a glance

What Are Products in the Context of SAP API Management?

Products are artifacts that appear on the SAP API Business Hub Enterprise portal. The SAP API Business Hub Enterprise portal is accessed using its own URL. It is accessible in the SAP Integration Suite cockpit through the navigation in the upper right corner of the interface.

Screenshot of the SAP Integration Suite. Choose API Business Hub Enterprise. Information is provided in the following text.

After opening the API Business Hub Enterprise portal, the products are displayed as tiles. The API used under a product corresponds to the API Proxy URL of the corresponding API.

Needed Roles (Role Collection) to Use the API Business Hub Enterprise

To open the API Business Hub Enterprise portal, one of the following role collections is required:

  • AuthGroup.API.Admin
  • AuthGroup.API.ApplicationDeveloper

We have already assigned both role collections to the user when provisioning the SAP Integration Suite capabilities.

If you are coming via learning.sap.com, then you have to assign your user account to the mentioned role collections.

Open an API Business Hub Enterprise portal with published products as a sample

In this screenshot, you can see an already created product named Product based on the GWSAMPLE_BASIC_v1 API.

This page is empty, if you have not yet created a product.

Screenshot of an already created product named Product based on the GWSAMPLE_BASIC_v1 API.

The products can then be searched for, found, and consumed by developers.

Procedure for creating a Product

Note

You perform this step in the SAP Integration Suite cockpit.

The following steps must be carried out in the following order:

  • Create a Product using the Create button
  • Add the entries under the Overview tab
  • Add an API under the APIs tab
  • Choose the Publish button
  • Open the API Business Hub Enterprise portal
  • Check out your Product

Create and Publish a Product

A prerequisite for creating a product is a working API. The creation is started using Engage. Then, navigate to the Products tab.

Choose Engage > Create.

Choose the Create button to start the procedure.

At least the following entries must be made:

Tab: Overview
The Name and Title should be the same. The Title is the heading of the tile. The description is also displayed on the tiles and is intended to give the user the most important information about the API.
Example
Name: P_GWSAMPLE_BASIC_v1 Title: P_GWSAMPLE_BASIC_v1 Description: An API based on the Enterprise Procurement Model (EPM). Authentication is done using policies. No additional authentication is required.Screenshot of completed fields for creating a product.

The other entries such as Quota, Requests Every, and Scope are optional and must be defined by policies.

A sample setting for that is found here: Create a Product

Tab: APIs

Here, you can choose your previously created API proxy, which you can add to your API product. When you select the Add button, all available APIs are displayed. You can assign any combination of the displayed APIs. It is also possible to combine individual resources.

In the following case, the entire (all resources) of the GWSAMPLE_BASIC_v1 API is added.

Screenshot of the added API.

Entries under the tabs Permissions, Rate plans, and Custom Attributes are optional.

A sample setting of custom attributes is described here: Custom Attributes

Publish Your Product

After the product has been configured, the product implementation must be published on the API Business Hub Enterprise portal. It is called Publish.

Choose Publish.

Show Products at API Business Hub Enterprise Portal

The API Business Hub Enterprise portal is its own application. This was provisioned together with SAP management.

The API Business Hub Enterprise portal is connected to the API Management using its own URL. These can be checked under SettingsAPI if problems occur.

After opening the API Business Hub Enterprise portal, as previously described, all published products display as tiles.

Screenshot shows the published products.

Navigate to Your Product

At the moment, you still have the possibility to choose between two representations. We use the new design. Navigate into the tile, you are routed to the Test Environment tab.

Screenshot of the test environment and numbered steps. Information about explanations are provided in the next paragraph.

Explanations:

  • No. 1: Here is your description of the product
  • No. 2: Here is the metadata of the product
  • No. 3: The design decision
  • No. 4: The logged-in user

To test the API, navigate to the APIs tab. Here, you can now see the title of the assigned API. In this case, it is GWSAMPLE_BASIC. The name of this API is GWSAMPLE_BASIC_v1. The product name is P_GWSAMPLE_BASIC_v1.

Choose Manage Connections.

Navigate to Your API

When you select the tile with the title of the associated API, you are in the API. Under the tab, API Reference, you will find the Swagger UI for calling the assigned resources.

Choose API Reference.

If you successfully test a selected resource, here GET/ProductSet, you will see the well-known Proxy URL from SAP API Management as a Request URL.

Screenshot of the proxy URL.

API Business Hub Enterprise Portal at a Glance

The API Business Hub Enterprise portal offers a platform to deploy products with your associated APIs, centrally in your enterprise. This is the only place where developers search, find, and test APIs, and ultimately consume the corresponding proxy URL in their own processes. For this purpose, the API Business Hub Enterprise portal offers the following:

  • Your own user management
  • A role-based access to the products
  • An additional authentication Layer with its own API key
  • A self-registration Unknown developer

Resources

Resources are available at SAP Help: SAP Help Portal

Resources are also available at Blogs: Protect Your API Proxy by Adding Application Key Verification | Tutorials for SAP Developers

Summary

A product in the context of SAP API Management is its own artifact that encapsulates created APIs or parts of them (resources). The product is configured and deployed (published) on the API Business Hub Enterprise portal. The product can be tested on the API Business Hub Enterprise portal. Access to the products is restricted through roles.

Create a Product Based on Your Created API

Business Scenario

The API Business Hub Enterprise is a robust platform designed to centralize and streamline the management of APIs for your deployed products. This business case helps you understand how to navigate the API catalog, use the available APIs effectively, and employ the built-in monitoring tools to gain valuable insights into API performance and usage when using APIs in your enterprise.

Task flow

In this exercise, you will perform the following tasks:

  1. Create and publish a Product to an API.
  2. Test your deployed API in the API Business Hub Enterprise.

Prerequisites

You have successfully completed the previous exercise.

Outcome of this exercise

By the end of this learning, you will be equipped with the knowledge and skills to maximize the potential of the API Business Hub Enterprise, enhancing your ability to streamline integrations and drive innovation in your organization.

What do you learn within this exercise

You can create an API based on a deployed Product at the API Business Hub Enterprise portal.

Task 1: Create and Publish a Product

Steps

  1. Create a Product based on your API Proxy.

    1. Navigate to Engageclick on Create.

      Engage overviewHow to set up a product
    2. Start the creation process with the Overview tab.

      FieldInput
      NameAPI_GWSAMPLE_BASIC_XXX
      TitleAPI_GWSAMPLE_BASIC_XXX
      DescriptionAPI Based on your API Proxy. The authorization against the source interface is realized via policies. No extra credentials needed.
      The product
    3. Choose the APIs tab and the Add button, choose your API Proxy and then choose the OK button.

      Choose the API proxy

      The Permission, Rate plans, and Custom Attribute tabs are primarily not necessary for this exercise and can be skipped.

      1. Permission: Whenever you create or edit a draft product, you can add permissions to the product. Use this procedure to grant user roles the necessary permissions for discovering and subscribing to the product in the API Business Hub Enterprise. Only users assigned the required role are able to discover and subscribe to the product.
      2. Rate plans: API Management enables users to create rate plans and attach them to products. With a rate plan, you can charge application developers for using your APIs.
      3. Custom Attribute: Custom attributes can be used to influence the runtime behavior of API proxy execution. These attributes can be set at the product level or at the application level (when an application is created by an admin on behalf of a developer). They offer the flexibility to extend functionality based on attribute values that can be set or read during the API proxy execution flow. These attributes can be accessed during an API call through the following policies: Verify API Key, Access Token, and Access Entity.
    4. Choose and click the Publish button on the top-right side.

      Published product
    5. Choose and click the top-right side navigation bread crumbs Explore our Ecosystem, to log on to the API Business Hub Enterprise .

      API Business Hub Enterprise access from the SAP Integration Suite
    6. Within the API Business Hub Enterprise, choose the created GWSAMPLE_BASIC_XXX Product API.

      API Business Hub Enterprise landing page
    7. Choose the APIs menu tab.

      API at API Business Hub Enterprise landing page
    8. Then, choose the GWSAMPLE_BASIC_XXX Product tile.

      API proxy
    9. If everything works correctly, you will see the entry with the API proxy URL and the status of the published Product.

    10. Now, choose the API Reference menu tab.

      API reference
    11. Navigate to the My Workspace using the top-left navigation menu.

Task 2: Test your deployed API in the API Business Hub Enterprise

Steps

  1. Test your Product

    1. Choose the Resource GET/ProductSet.

    2. Click onTry out.

      Try out of GET/ProductSet
    3. Afterwards, click on Execute.

      execution view
    4. On (1) you can see the API proxy URL that you know from the API management.

    5. On (2) you can see the response that comes from the ES5 system.

Log in to track your progress & complete quizzes