Technical Articles

Divya Mary

Posted on June 22, 2020 6 minute read

Part 1: Enable SAP Cloud Platform API Management in Cloud Foundry Environment

Follow RSS feed Like

8 Likes 4,274 Views 17 Comments

SAP Cloud Platform API Management lets you publish, promote, and oversee APIs in a secure and scalable environment. It is available in both Neo and Cloud Foundry Environment. In this blog steps to enable SAP Cloud Platform API Management in Cloud Foundry environment is covered.

SAP Cloud Platform API Management is not yet available in Cloud Foundry trial environment and therefore this steps can be tried out from a production account. For SAP Cloud Platform Integration Suite, you can also follow this blog to enable the API Management capabilities.

Subscribe to API Management services in Cloud Foundry

Logon to SAP Cloud Platform
Navigate to your Global Account and then click New Subaccount button. In case you already have a sub account for your Cloud Foundry Region this step can be skipped.
In the New Subaccount popup dialog, enter a display name for your sub account. Select Cloud Foundry from the environment drop down list and from the provider drop down list select Amazon Web Services ( AWS) or Azure. From the region drop down list select your Region and click on Create button.

Create%20new%20sub-account%20dialog

Create new sub-account dialog

After creation the status will change Once the new sub account is created, click on the Enable Cloud Foundry button to enable Cloud Foundry organization and space in your account. Enter a name for your Cloud Foundry organization and click Create. In case you already have a sub account in Cloud Foundry Region this step can be skipped.

Based on your entitlements and necessary license, under Subscriptions tab SAP Cloud Platform API Management tiles would be visible. Navigate to Subscriptions tab and check for API Management, API portal and API Management, developer portal tiles.

Select API Management, API portal tile and then click on Subscribe button to enable API Portal functionality in your Cloud Foundry environment. After Subscribe button is clicked, status would change to Processing and this would take few minutes while the API Portal service is getting activated in the selected tenant.

Subscribe%20to%20API%20Portal

Subscribe to API Portal

In Cloud Foundry environment based on your business needs you can selectively enable Developer Portal functionality of SAP Cloud Platform API Management. If you would like to enable the Developer Portal functionality then from drop down at the top select API Management, developer portal and click Subscribe. After Subscribe button is clicked, status would change to Processing and this would take few minutes while the Developer Portal service is getting activated in the selected tenant.

Subscribe%20to%20Developer%20portal

Subscribe to Developer portal

With this you have successfully enabled API Portal & Developer Portal functionality of API Management.

Initial Configuration & Set up of API Management services

Next the initial configurations like setting of Virtual hosts, API Portal administrator, Developer portal set up has to be completed. To access the initial configuration setup, your user would have to be assigned the role APIMangement.SelfService.Administrator and AuthGroup.SelfServcie.admin

To assign roles, navigate to your sub-account overview page and select Trust Configuration from Security.

Navigate to Trust Configuration

Choose an active Identity Provider from the list of available identity providers. In the default scenario you should be able to select the SAP ID Service.

Select%20the%20Identity%20Provider

Select the Identity Provider

Enter your user ID from the selected Identity Provider service. In case of SAP IDP Service, you can enter email address of the user and click on Show Assignments and then select Assign Role Collection.

Assign%20Role%20Collection

Assign Role Collection

Select APIMangement.SelfService.Administrator role collection from drop down and select option Assign Role Collection.

Assign%20APIManagement.SelfService.Administrator%20role

Assign APIManagement.SelfService.Administrator role

If you would like to enable Developer Portal capabilities, then repeat the above steps to also add role collection AuthGroup.SelfServcie.admin to your user.

Navigate to Subscription tab, select API Management, api portal and select Go to Application link.

Navigate%20to%20API%20Management%2C%20api%20portal%20application

Navigate to API Management, API portal application

Based on your configured identity provider you will be redirected to enter your user credentials and after successful log-in, A Configure the API Management Service screen appears. Perform the following steps: –

- In the Account section, select the Account Type.
  - Select Non Production account type for non-business critical activities, integrating test systems, testing new scenarios, performance testing, and sandbox activities.
  - Select Production account type for business critical usage, integrating production systems, and productive APIs.
- In the Virtual Host section, enter the Host Alias.
  
  Virtual hosts are the base URLs of an API Proxy that identifies your organization. Once you enter the host alias, your API Proxy would appear in the default API Management domain as shown below:
  
  Example: https://{virtualHost}.apimanagement.hana.ondemand.com.
- Provide an e-mail ID in the Notification Contact field to receive updates. You can also add multiple e-mail IDs. To add more than one e-mail ID, press the Tab button on the keyboard.
- Select the Make <User ID> API Portal administrator checkbox to assign the APIPortal.Administrator role to the mentioned user. Assigning administrator role helps the user to access API portal user interface and services.

You can view the entered values and confirm the setup values.

You can view the set up progress for each of phases of API Portal service configuration. As part of testing the setup, a sample HelloWorld API Proxy will be deployed on the newly configured API Portal.

API%20Portal%20set%20up%20progress

After a successful service enablement, you would have to logout and log-in again for the on-boarding changes for API Portal administrator roles to be reflected in the current session.

Logout%20from%20API%20Portal

Logout from API Portal

After successful login you can view & explore the features of API Portal.

API%20Portal%20Home%20Page

API Portal Home Page

Helloworld%20API%20Proxy%20pre-deployed%20for%20testing

HelloWorld API Proxy pre-deployed for tryout

Next you can also enable your Developer portal service. Navigate to SAP Cloud Platform cockpit -> Subscription tab, select API Management, developer portal and select Go to Application link.

Developer%20portal%20service

Developer portal service

Based on your configured identity provider you might be redirected to enter your user credentials and after successful log-in, wait for sometime till Developer Portal is successfully set up. After set up of Developer Portal , logout and login for all changes to be reflected.

After re-login you can on-board yourself as an Application Developer on Developer Portal side. For this, click on the Register button.

In the Register dialog, select your country of origin and then select OK.

After registration, logout and log-in again for the role changes to be reflected.

With this you have successfully enabled SAP Cloud Platform API Management service in Cloud Foundry environment.

Note:- If you encounter any issue while on-boarding of SAP Cloud Platform API Management, you raise a customer service incident on the component OPU-API-OD-OPS.

Stay tuned, more blogs on API Management in Cloud Foundry environment to come:

Enable API Management capability ( current blog)
Connect to on-premise APIs
Service Plans of API Management
Manage integration flow from Cloud Integration

Alert Moderator

17 Comments

You must be Logged on to comment or reply to a post.

Saritha Vodela

June 23, 2020 at 1:47 pm

Divya

Very helpful
- Like(0)
Ramesh Vodela

June 23, 2020 at 2:01 pm

Divya

I wanted to this blog with my trial account(foundry) – I could find API portal and API developer entitlements in my account. Does this mean for trial account holders we cant try this feature?

For the Neo environment, these are present. The Scenario I’m working on is the CPI-odata-cloud connector for on-premise data service. I configured everything and when I test in CPI connection test with Could connector I get success but in the odata call when I use the virtual host in the URL

Also when I created Destination in CPI for on Prem the connection test fails – I could not figure how connection test in CPI with location ID passed but not in the destination

(s4h:443 configured in the cloud connector) I get an error. So What I did was go to the Neo environment and created API but still Cant access it from CPI.

Can you suggest any solution?

Ramesh
- Like(0)
- Divya Mary Post author
  
  June 23, 2020 at 9:31 pm
  
  Hi Ramesh,
  
  The blog highlights the setup of SAP API Management including API Portal & Developer Portal functionality in Cloud Foundry. This feature is not yet available in Cloud Foundry trial environment. In Cloud Foundry trial we have a lite plan which in turn helps you connect to a SAP API Management Neo trial environment. You can follow this steps on your productive accounts of SAP API Management.
  
  Sharing a blog on connecting Cloud Integration to on-premise API via Cloud Connector ( it also captures the Location ID ) part for the configuration.
  
  Apologies but I may not have fully understood your scenario -> you are trying to connect which service in the Neo Environment with Cloud Integration. Also where is your Cloud Integration ( or CPI) tenant located is it CF trial or Neo productive accounts.
  
  If you are noticing an error in the connectivity you can also raise a customer support incident on the component LOD-HCI .
  
  Thanks and Best Regards,
  
  Divya
  - Like(0)
  - Ramesh Vodela
    
    July 11, 2020 at 6:08 pm
    
    Divya
    
    Thanks for the info provided.
    
    I see that the trial cloud foundry now has options to create integration, API, connectors, and Business Advisory. I followed the same procedure for the roles and assigned them to my user. When I try I get forbidden error. I can't find any documentation with the new changes to try out.
    
    Can you send any links for the setup?
    
    Ramesh
    Like(0)
    - Ramesh Vodela
      
      July 11, 2020 at 9:17 pm
      
      I found the following document
      
      https://developers.sap.com/tutorials/cp-starter-isuite-onboard-subscribe.html
      
      I could get this to work if the cloud foundry environment is created with AWS and Frankfurt
      
      You need to add one more authorization to your user email
      
      Authgroup SelfserviceAdmin Role in addition to those mentioned in the document.
      
      With all these all the services will work except Open Connectors I got the same error which I got couple of months back
      
      Ramesh
      
      Like(0)
Gergo Timar

June 29, 2020 at 7:06 am

Hi Divya, first of all thanks a lot for doing all your blog posts about SCP APIM, they are very helpful! I have a question to this one. As I understand in the past the APIM service on SCP Cloud Foundry was acting like a service broker, meaning the API portals, proxies were all on Neo and the CF APIM instance was just used by the apps running on CF. From this blog it sounds like this is not the case anymore, because APIM portals, proxies are all available on Cloud Foundry now. Do I get it right? Is there a feature parity between the Neo and CF APIM services?

Gergo
- Like(0)
- Divya Mary Post author
  
  June 29, 2020 at 9:08 am
  
  Hi Gergo Timar
  
  Thanks a ton for your kind words for the blogs. This is correct with this new enhancement, API Portal & Developer Portal is available in SAP Cloud Platform Cloud Foundry environment.
  
  Details about the feature parity between Neo and Cloud Foundry environment for SAP API Management can be found in this SAP Note. Our product engineering team is working on closely this feature parity gap.
  
  Thanks and Best Regards,
  
  Divya
  - Like(1)
Mattias Johansson

October 17, 2020 at 7:00 am

Thanks for the very informative blog.

We're setting up API Management for some new use cases, which is the most future safe option, to use NEO or CloudFoundry.

Our client applications and "on premise" systems all run on Azure NL, so I guess the cloudfoundry on AzureNL would be the one with the lowest latency?

regards

Mattias
- Like(0)
- Divya Mary Post author
  
  October 21, 2020 at 10:09 am
  
  Hi Mattias,
  
  Since your client applications are running on Azure NL, it would be best to enable SAP API Management on the Azure NL ( Cloud Foundry ) environment .
  
  Thanks and Best Regards,
  
  Divya
  - Like(0)
  - Mattias Johansson
    
    October 22, 2020 at 2:48 pm
    
    Thank you for the response
    Like(0)
Mansour Ilyes

March 19, 2021 at 10:03 am

Hi Divya,

thank you for this blog and for the given information,

currently i am trying to reproduce the steps in a trial environment but i am facing an issue from the beginning :

as you know 'Subscriptions' were moved to the marketpalce and even if the API Management exist i wasn't able to create/subscribe to it

API Management

You can find the issue screenshot below

API management issue

I am wondering if this issue is related to the trial environment or maybe some new steps are missing.

Thank you.

Ilyes
- Like(1)
/
- Vidyadhar Kurmala
  
  April 26, 2021 at 9:24 pm
  
  Hi Llyes,
  
  Did you check if you have roles w.r.t below screenshot assigned to Default Identity provider under Trust configuration? Here is SAP help link for your reference. I have complete step1 and tried step2 then it worked.
  
  https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html
  
  Thanks,
  
  Vidyadhar
  - Like(1)
  /
  - Mansour Ilyes
    
    April 27, 2021 at 10:53 am
    
    Hi kurmala,
    
    thank you for replying,
    
    I wansn't even be able to subscribe to the Api Manager, so the related roles are not available in the IP.
    
    I saw your link and i will follow the other method using the integration suit as i don't have issue while subscribing, i haven't notice that before, thank very much 🙂
    
    Ilyes
    Like(0)
- Thiago de Castro Mendes
  
  May 28, 2021 at 10:23 am
  
  Hello Mansour Ilyes,
  
  With the introduction of the Integration Suite, the steps changed a bit, so you might want to check this tutorial to:
  
  1- Create Integration Suite service instance;
  2- Add the capabilities to the instance;
  3- Run the Integration Suite Booster;
  4- Access the API Portal.
  
  https://developers.sap.com/tutorials/cp-starter-isuite-onboard-subscribe.html
  
  Hope it helps,
  Thiago.
  - Like(0)
Senthilkumar Moorthy

April 28, 2021 at 8:51 am

Hello Llyes,

I also get the same error. if you have resolved, please let me know how?

Regards

Senthil
- Like(0)
/
- Thiago de Castro Mendes
  
  May 28, 2021 at 10:22 am
  
  Hello Senthilkumar Moorthy,
  
  With the introduction of the Integration Suite, the steps changed a bit, so you might want to check this tutorial to:
  
  1- Create Integration Suite service instance;
  2- Add the capabilities to the instance;
  3- Run the Integration Suite Booster;
  4- Access the API Portal.
  
  https://developers.sap.com/tutorials/cp-starter-isuite-onboard-subscribe.html
  
  Hope it helps,
  Thiago.
  - Like(0)
  - Senthilkumar Moorthy
    
    May 28, 2021 at 11:28 am
    
    Thanks Thiago de Castro Mendes for your support. I will look into this tutorial and setup the instance.
    
    Regards
    
    Senthil.
    Like(1)