SAP API Management – Overview & Getting started Updated 2022
Blog Update: This blog continues to be updated in 2022.
Although written originally in 2016 continues to be updated as a central launchpad in 2022 – please continue to check back here for updates.
If you are new to the SAP Community, or relearning how the updated tagging format works you can search all API Management content by following these tags for API Blogs:
However, this covers a lot of content to sift through (champagne problems). On this page is a curated starting point of available documentation / how-to guides / tutorials / more, to help you hit the ground running with SAP API Management on SAP Cloud Platform.
- SAP Help Documentation
- SAP Cloud Platform, API Management Feature Scope Description
- SAP Enterprise API Best Practices Guide
Official Learning Resources
- SAP API Management Product Page
- SAP Cloud Platform API Management Capabilities Page
- SAP Developers API & Integration Page
- SAP API Management – Open SAP Course (MOOC)
- Discover and Consume SAP Product APIs @ SAP API Business Hub
- SAP Cloud Platform Use Case Finder – SAP API Management
- Productive Cloud Platform Users – Get started with API Management Recipe
- SAP API Management – Deep hands-on across policies
- SAP Integration Suite Customer Use Case Examples
SAP Blog Resources
Introduction / Getting Started
- SAP API Management Frequently Asked Questions
- Try out API Management – Free Trial of SAP API Management on SAP Cloud Platform is available now!
- SAP API Management Customers – Get Started with Cloud Platform Discovery Center Missions
- SAP API Management Introduction – Developer View
- Exploring API Portal and API Business Hub Enterprise APIs of SAP Integration Suite
- Onboarding to Developer Portal Guide
- Public SAP Cloud Platform, API Management API Proxy GitHub Now Available
- SAP Developers Center – API Management Developer Tutorials
- Discover how APIs are important to B2B Scenarios
- Unleash the Killer API – an SAP Executive look at API
- The role of APIs and the new API Economy
Integration Suite – API Platform
- Discover CPI Integration Flows and build APIs via API Wizard
- Managing Time Intensive Integration Flows with API Management
- YouTube Series – Getting started with SAP Cloud Platform, API Management
- SAP API Management Demo
- First Look @ SAP Cloud Platform, API Management
- Secure APIs with Policies
- Consume APIs in Web IDE
- Simplify API Governance with Policy Templates
- Creating and Applying Policy Templates
- Applying Policy Templates – JSON Threat Protection
- Applying Policy Templates – Cross Origin Resource Sharing (CORS)
- Applying Policy Templates – URL Masking
- Applying Policy Templates – Caching Metadata for OData APIs
- Monetizing APIs
- Governing Microservices on Cloud Foundry with SAP API Management
- Connecting API Management to API Business Hub
- Governing Cloud Platform Integration APIs in SAP API Management
- Governing SAP Gateway APIs in SAP API Management
- Connecting to 3rd Party (Non-SAP) APIs with SAP API Management
- Integrating with Open Connectors – governing over 175 3rd Party APIs
- JSON Web Tokens (JWT) for Identity Verification
- Security Mini-Series on YouTube
- Part 1 – Introduction to Principal Propagation
- Part 2 – Setting up OnPrem Connectivity on Cloud Foundry
- Part 3a – Pass-through OnPrem Connectivity on CloudFoundry
- Part 3b – CF Authenticated Pass-through OnPrem Connectivity on CloudFoundry
- Part 3c – Oauth User Token Exchange OnPrem Connectivity on CloudFoundry
- Part 3d – Oauth2SAML Bearer Association OnPrem Connectivity on CloudFoundry
- Part 4 – OAuth2SAML Bearer Association on Neo
- Part 5 – SAML Assertion Flow for Prinicpal Propagation on Neo
- Part 6 – SAML Assertion Flow for Principal Propagation on CloudFoundry
- Part 7 – Client Credentials Flow for Prinicpal Proagation on Cloud Foundry
- Part 8 – Neo to CF OAuth2SAML Bearer for Principal Propagation on Cloud Foundry
- Security – API Security Best Practices Blog
- Part 1 – Restrict access to API based on IP Addresses
- Part 2 – Rate limit API calls with Retry time
- Part 3 – Rate limit API calls for OData Batch calls
- Part 4 – Data masking of sensitive data from API response
- Part 5 – JSON Threat protection against injection attacks
- Part 6 – XML Threat protection against injection attacks
- Part 7 – Log all API interactions
- Part 8 – Threat protection against SQL injection attacks
- Part 9 – Threat protection against XML External entity injection attacks
- Part 10 – Raise alerts via email notification when threat is detected
- Part 11 – Rate limit concurrent connection to target
- Part 12 – Rate limit API call per developer
- SAP API Management Exposing PI / PO Interfaces as Open APIs in the Cloud
- API Providers – Connectivity from SAP API Management to Various Backends
- Part 2: Connecting and exposing APIs from SAP Gateway
- Part 3: Connecting and exposing Interfaces from SAP Process Integration/Process Orchestration(PI/PO)
- Part 4: Connecting and exposing APIs from SAP HANA
- Part 5: Connecting and exposing APIs from SAP S/4 HANA
- Part 6: Connecting and exposing APIs from SAP Success Factor
- Part 7: Connecting and exposing APIs from SAP Cloud Platform Integration
- Part 8: Connecting and exposing APIs from 3rd Party Here Maps
- SAP OData Provisioning for SAP Gateway services
- Monetize your APIs – Data as a Service Series
SAP API Management on Cloud Foundry
- Managing Cloud Foundry Apps in SAP API Management (Neo or CF)
- Developing Cloud Foundry Services and managing in SAP API Management (Trial example)
- SAP API Management availability on SAP Cloud Platform Cloud Foundry Amazon Web Services (AWS)
Working with Policies
- SAP API Management – Policy Management
- SAP API Management – Understanding Policy Flow
- 2019 – Key Value Map Policy
- 2019 – Encrypted Key Value Map Policy
- SAP API Management – Enabling URL masking
- SAP API Management – SOAP to REST
- How to expose a SOAP WebService as REST API
- Mash-up in an API proxy
- OAuth with SAP Cloud Platform API Management
- Traffic Management: ConcurrentRateLimit example
- SAP API Management – simplify your life with policy templates!
- Create your own Error Codes
- List of variables for use in Policies
- How to transport API assets between instances
- Analytics on API Portal
- Creating a custom dashboard with payload metrics in SAP API Management
- Metering and Monetizing your APIs
- Consuming objects from BOC via API Management
- Consuming APIs from Web IDE via SAP API Management
- Consuming APIs from Business Objects Cloud via SAP API Management
- Improve API Performance using policies (Part 1)
- Improve API Performance using policies (Part 2)
- Dynamic Routing via custom Route Rules
Advanced API Techniques
- Support and Debugging – Troubleshooting and tracking techniques
- Debugging API Proxies– Troubleshooting Techniques
- Cache me if you can — Advanced caching techniques
- Principal Propagation with Azure AD — Setting up Principal Propagation from Azure or External Apps through APIM.
Interesting Use Cases
- Monetization of digital services with API Management SAP Subscription Billing Part 1
- Setting up and consuming APIs from Amazon Alexa via API management
- Single Sign-On (SSO) personalized user access to SAP (S/4HANA) APIs walk-through
- SAP Cloud Platform – Workflow automation of S/4HANA in a Fiori App, leveraging OData API managed by SAP API Management
- Internet of Things made simpler with SAP API Management Part I – Overview,
- Customize your Developer Portal using SAP Cloud Portal Templates
- SAP API Hub (Beta) available on HANA Cloud Platform Trial
- How to use SAP API Hub (Beta)
- A more fun API to manage and build an App on top of
- Show me the ‘API’ money. A step by step guide.
- Importance of APIs in B2B Business
- API Management in Insurance Industry
Customer Use Cases
There are many great blogs full of interesting questions and answers, but the material inside is becoming somewhat dated. You can still refer to them below, but the guides will not match the current state of API Management:
- SAP API Management Technical Brief (download) / SAP API Management – Cloud Technical Brief (display)
- Solution Brief: SAP API Management (cloud offering)
- How to use SAP API Management on HCP Trial
- Exposing Digital API’s using HCP Trial – API Management Service
- SAP API Management – Connecting on-prem made simple
- SAP API Management Getting started Series (Video)
I hope this helps as a starting point, as before please feel free to follow (or contribute) to the Community Tags for APIs and API Management.
Hi Holger, Elijah,
this is a good structured page. In one central page all relevent topic in a consolidated way brought together. So as a wonderful starting point into the new topic API Management.
one general remarks on API's:
Why are API's and therefore its management so important for the business?
- API are the new revenue generators and apps are the new marketmakers. So API's and apps are part of your digital transformation and API Management is an important enabler.
For hundred of years traditional markets were influenced by intermediaries - you could also call them middle-man. They brought together request and demand sides. They knew the inner mechanics of their market, knew what the demand and request side wanted, what language they spoke and where those who simplified the complexity of both sides and made business with both possible. Think about a stock broker. He knows how to make it for me as individual simple to buy or sell stocks. I don't need to know where to find a place where I can get the stocks or which other places might exist where I could get a stock with better conditions, or where they are kept and all the details in between. This is handled by a broker. He is the intermediary between buyer and seller of stocks.
So are the apps the intermediaries of today markets. And how to apps work? They work on API's. Those companies who do not provide for their products and services API's can't be found and can't be used. Here I like the "I"-part in API. The "I" stands for interFACE. So the API is the face you give your products and services to the outsidde world. Without API's no one can build an app which consumes your product/service through API's. All for what the intermediaries in the classical market stood for is now packed into an App.
Apps are the marketmakers. And the more intermediaries you have for your products and services, the more representatives I have for my offerings to the market. Therefore you should not only provide your own Apps, rather than allow others - your intermediaries- to build their own apps based on your API's. API Management provides an open platform where you can deliver a feeding ground for as much app developers as you like. They themself then can build and market apps in their preferred language and environment and you manage the design and consumption to your API's thru an API Management solution.
With API management you allow others outside to build apps to your products and services in a way they understand. Be it as a REST or OData call or thru SOAP, RFC in JSON or XML format or ...
The how all that works is described in this starting point page for SAP API Management
Thank you Matthias, this is a wonderful write-up, and perspective on APIs and reason for management. I might suggest making this a blog post, so that it can be seen more broadly!
I have one productivity HCP account but this service is not available. Is it available only on HCP trial?
For productive HCP account usage, you will need to purchase SAP API Management. It is provided as an a-la-carte service.
If you wish to trial SAP API Management, in order to understand the capabilities, then it will only be available on the HCP Trial account.
I have a quick question with regards to developer portal . Hope I can find answer on this forum .
Is it possible to do the authentication of developer on developer portal from customer's corporate AD?
And If not then is it part of product road map and would it be available at some point ?
Yes, SAP CP API Management follows the Cloud Platform principles, of allowing the capability of calling a 3rd party IdP, assuming it supports the right interface (e.g. SAML 2.0). ADFS for example is a known supported IdP.
Requires a mapping on SAP CP users / groups to the users desired to have access on the IdP.
Thanks for quick response .
It was confusing when I read on SAP help portal of SAP CP API management that one need to be scn user in order to access developer portal.
I hope it will be possible in a similar way as we can authenticate on SAP CP Portal service from 3rd part IDP via SAP CP Identity .
Good timing on this request, as one of my colleagues, Divya Mary, just recently posted a blog on this very item:
I hope that you and others find this useful.
Thanks for informing me.
I want to utilise a scenario with two trial account.
Trail accountA and accountB.
I have created a api product from trial accountA. now is it possible for accountB to use api product from accountA in his web IDE data connection and what needs to done in accountB to use that api product.
I'm not sure that I follow your question precisely. Let me rephrase and you can tell me if I have accurately encapsulated your question.
Trial AccountA has API Management enabled, you create an API Proxy, bundle it into a Product and expose it via the Developer Portal. Then you wish to have WebIDE on Trial Account B connect to the Developer Portal of Trial Account A to consume the APIs exposed there?
This unfortunately is not possible, as the Trial has specifically limited the number of developers allowed to be onboarded to 1 (the account owner). You would need to either use a productive instance of API Management (which can have unlimited users onboarded to Developer Portal), or use WebIDE from the first instance to discover and start the build, and export the project to the second instance.
Let me know if I misinterpreted your question or you need further clarity.
thanks for reply. I was precisely asking the same question that you answered.
one more question. in developer account can i deploy the created api product directly to SAP business hub.so that our client can connect to api business hub and use the service with their respective backend. and consume via web ide to create the SAPUI5 application.
Great Landing page for API Management, Elijah!
Hi Elijah - useful post. I'm new to the SAP API and I'm looking for details on which API to use for integration of SAP ERP with one of our client's eCommerce platform. The information around the site is quite vast and I feel kind of lost. Your help would be greatly appreciated.