Skip to Content

Consume API Management Service Instance from Kyma

Use the Kyma environment to search and discover API Management, API Portal and API business hub enterprise applications. Kyma environment provides a fully managed Kubernetes runtime based on the open-source project Kyma.
You will learn
  • How to Provision API Portal and API Business Hub Enterprise cluster services
KakabiraKasturi KabirajJune 30, 2022
Created by
Kakabira
June 28, 2022
Contributors
Kakabira
Kakabira

Prerequisites

  • You’ve subscribed to Integration Suite, and have enabled API Management, API Portal and API business hub enterprise capability.
    >If you’re using the API Management stand-alone service, ensure that you’ve already subscribed to API Management, API portal and API business hub enterprise.

  • Ensure that the Kyma environment has already been enabled.
    To enable Kyma Runtime in SAP BTP Cockpit:

  1. In SAP BTP cockpit, navigate to your subaccount.

  2. Go to Services > Service Marketplace and select Kyma Environment.

    Kyma Environment Tile
  3. Select Create either from actions in the upper-right corner of the tile or from the tile overview page, to which you get by clicking on the tile..

    Create Kyma Runtime
  4. On the New Instance and Subscription dialog, change the instance name or keep the default name.
    The default plan assigned to your account is pre-populated.

>The default plan and its specification can differ depending on your global account type.
Confirm changes by selecting Create. For more information on how to set up a fully operational Kyma environment, click Kyma Environment.

Create Kyma Runtime

  • Step 1
    1. Log on to SAP BTP Cockpit and navigate to your subaccount.

    2. Choose Kyma Environment tab and choose Console URL: Link to dashboard to navigate to the Kyma dashboard.

      Link to Dashboard

    3. Choose Namespaces from the left navigation pane. At this point, only the default namespace appears.

      Namespace

    4. From the left navigation pane, choose Service Management > BTP Service Instances > Create Service Instance.

      Create Service Instance

    5. On the Create Service Instance dialog fill in the following details and choose Create:

      Create Service Instance dialog

    • Name: Provide a name or generate it by choosing Generate name

    • Offering Name: You can find the SAP BTP service offering name in the Service Marketplace of the SAP BTP cockpit. Search for the API Management, API Portal/ API Management, API business hub enterprise service and copy the name of the service instance.

    • Plan Name: Similarly, you can find the relevant plan for the respective API Management, API Portal/ API Management, API business hub services in the Service Marketplace of the SAP BTP cockpit.

      Service Marketplace

    • Choose Advance tab on the Create Service Instance dialog and expand Instance Parameters.

      Create Service Instance

      * To create an instance of **API Management, API Portal**, enter **role** as the key in the first textbox and **APIPortal.Administrator** as the value in the second textbox.
      
      * Similarly, to create an instance of **API Management, API Business Hub Enterprise**, enter **role** in the first textbox and **AuthGroup.API.Admin** in the second textbox.
      

    You’re directed to the Service Management > Instances page, where an instance of the newly provisioned API Management, API Portal or API Management, API Business Hub Enterprise service appears.

    Provisioned

    Which role is required to create a service instance of API Management, API Portal?

  • Step 2

    To create the Service Key:
    1. Navigate to the instance that you just created and choose Add Service Binding.

    Create Service Binding

    2. Generate a Name for the service binding and select the Service Instance Name from the dropdown menu, and choose Create.
    Service Binding

    The service instance name, secret, and external name appears under Binding Data. Select the link next to Secret.
    Binding Data

    Copy the clientId, clientSecret, orgId, tokenUrl and the url details.

    Copy the Client ID and Client Secret

    You can now use the clientId, clientSecret, and tokenUrl to fetch the token, and the application URL to perform operation on the APIs.

    Which role is required to create a service instance of API Management, API Business Hub Enterprise?

Back to top