Setup for SAP Integration Suite (API Management)

This page explains how to connect SAP Integration Suite (API Management) running on Cloud Foundry (Multi-Cloud) to SAP Cloud ALM to enable monitoring.

Currently, the following monitoring applications are supported for SAP Integration Suite (API Management):

Prerequisites

  • With Health Monitoring you can monitor the health of custom domain virtual host certificates in API Management
    • This means you will only get monitoring data if you requested a custom domain for the virtual host as described here
  • You need to have access to SAP BTP Cockpit.
  • You need to have an entitlement for the service "API Management, API portal" → for the plan "apiportal-apiaccess"
    • You can check this in SAP BTP Cockpit → <Subaccount for Integration Suite> → Entitlements
  • Your user in BTP Cockpit needs to be a member with the space role "Space Developer" for the space in which you want to create the service instance.

Setup Steps in SAP Integration Suite (API Management)

OAuth Authentication: Prepare and obtain OAuth Credentials

To enable OAuth authentication between SAP Cloud ALM and SAP Integration Suite (API Management), you must create an instance with a service key for the API Management service with the necessary authorizations. 

Create Service Instance

  1. Go to SAP BTP Cockpit → Access the sub-account used for SAP Cloud Integration
  2. Go to "Instances and Subscriptions"
  3. Click the "Create" button to create a new instance
  4. Basic Info
    1. Service: API Management, API portal (apimanagement-apiportal)
    2. Plan: apiportal-apiaccess
    3. Runtime Environment: Choose Cloud Foundry
    4. Space: Select the appropriate space (depending on your company)
    5. Instance Name: Enter an instance name
    6. Click "Next"
  5. Under "Parameters", enter the following JSON string:
    { "role": "APIPortal.Administrator" }
  6. Click "Create" to create the instance

Create Service Key

After the instance is created, you can add the service key.

  1. Select the row of the instance
  2. Go to tab "Service Keys"
  3. Click "Create"
  4. Enter a name for the service key
  5. Click "Create"
Download the service key file. You will need the information in the file later when creating the end-point in SAP Cloud ALM.

Setup Steps in SAP Cloud ALM

Add SAP Integration Suite (API Management) to Landscape Management

SAP Integration Suite (API Management) tenants are currently not imported into the Landscape Management automatically. Instead, you have to create it manually.
  1. Open the Landscape Management application from the launchpad
  2. Click the "Add" button on top of the Cloud Services table
  3. Enter the following values:
    1. Name: Enter the name of your tenant
    2. Description: Optional description
    3. Tenant ID: The <tenant> part of the API Portal Root URL
    4. Service Type: Select "SAP Integration Suite (API Management)"
    5. Tenant Type: Select the appropriate type for your tenant
    6. Root URL: The main URL for your API Portal without /shell/homepage (e.g., https://<tenant>.integrationsuite-apiportal.cfapps.us10.hana.ondemand.com)
  4. Click the "Save" button

Create HTTP Endpoint

  1. Open the Landscape Management application from the launchpad
  2. Select your SAP Integration Suite (API Management) service
    • Select the cloud service with the service type "SAP Integration Suite (API Management)"
    • Do not choose the service with the service type "SAP BTP Cloud Foundry environment" even if the cloud service name contains "API Management"
  3. Select the service
  4. On the tab "Endpoints", press the "Add" button to create a new endpoint
  5. Enter a description
  6. Choose the use-cases you want to use
    1. For Health Monitoring, select: "Health Monitoring"
  7. Overwrite the value in the field "Root URL" with the value of the parameter "url" in the service key.
  8. Choose OAuth2ClientCredentials: Enter the following values from the SAP Integration Suite service key
    1. Client ID: clientid
    2. Client Secret: clientsecret
    3. Token Service URL: tokenurl
  9. Save your endpoint

Next Steps

After creating the endpoint in SAP Cloud ALM, you have to perform the following steps to activate the monitoring use-cases:

  • Health Monitoring: Activate Monitoring Data Collection