In this lesson, we will cover the following topics:
- Products in the context of SAP API Management
- Create and publish a Product
- Show Products at Developer Hub
- Navigate to your Product
- Navigate to your API
What are Products in the context of SAP API Management?
Products are artifacts that appear on the Developer Hub. The Developer Hub can be 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. By clicking on the tile, the Developer Hub gets activated.
After opening the Developer Hub, 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 Developer Hub
To open the Developer Hub portal, one of the following role collections is required:
- AuthGroup.API.Admin
- AuthGroup.API.ApplicationDeveloper
We have already assigned both role collections to users when provisioning the SAP Integration Suite capabilities.
If you are using a SAP BTP trial account, then you have to assign the mentioned role collections in the cockpit of your SAP BTP subaccount.
Open the Developer Hub with Published Products as a Sample
In the following 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.
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.
Follow these steps in the order listed:
- 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 Developer Hub portal
- Check out your Product
Create and Publish a Product
A prerequisite for creating a product is a working API. The product creation starts using Engage. Then, navigate to the Products tab.
Choose the Create button to start the procedure.
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.
The other entries, such as Quota, Requests Every, and Scope are optional and must be defined by policies.
A sample setting for that can be found here: Create a Product
- Tab: APIs
Here, you can choose your previously created API proxy that 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. You can also combine individual resources.
In the following case, all resources of the GWSAMPLE_BASIC_v1 API are added.
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 Developer Hub portal. It is called Publish.
Show Products at Developer Hub
The Developer Hub portal is its own application. This was provisioned together with SAP management.
TheDeveloper Hub portal is connected to the API Management using its own URL. These can be checked under Settings→API if any problems occur.
After opening the Developer Hub portal, as described previously, all published products display as tiles.
Navigate to Your Product
Navigate into the tile to get information about the product.
Let's learn about the marked sections in the figure.
- 1: This displays the description of the product.
- 2: This displays the metadata of the product.
- 3: This shows 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 and product name is P_GWSAMPLE_BASIC_v1.
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 can find the Swagger UI for calling the assigned resources.
When you successfully test a selected resource (such as GET/ProductSet ), you will see the well-known Proxy URL from SAP API Management as a Request URL.
