SAP API Management - Overview & Getting started Updated 2023

[Elijah_Martinez]

Blog Update: This blog continues to be updated in 2023. 

Although written originally in 2016 continues to be updated as a central launchpad in 2023 - 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:

• API


• SAP API Management


• SAP API Management, cloud edition


• Integration Suite

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.

 

Official Documentation

• 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

---

Enablement Series

• 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
  
  
  
  • Modeling the JWT Flow in API Management
  
  
  • Configure JWT for Okta
  
  
  • Configure JWT for Azure Active Directory
  
  
  • Configure JWT for XS UAA (Cloud Foundry)
  
  
  • Configure JWT for SAP Gigya aka Customer Data Cloud
  
  
  
  


• 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
  
  
  
  • Part 2: Exposing OData interfaces as APIs
  
  
  • Part 3: Exposing SOAP interfaces as APIs
  
  
  • Part 4: Exposing REST interfaces as APIs
  
  
  • Part 5: Using API Management policies to secure, protect and scale open APIs
  
  
  
  


• 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
  
  
  
  • Part 1 - Setting up SAP OData Provisioning
  
  
  • Part 2 - Connecting API Management to SAP OData Provisioning
  
  
  
  


• Monetize your APIs - Data as a Service Series
  
  
  
  • Part 1 - Create and Monetize APIs
  
  
  • Part 2 - Govern and Monetize APIs
  
  
  • (Related) - Full monetization with SAP Subscription Billing
  
  
  
  

 

---

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)

---

 

Creating APIs

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

• 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

• 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.


• SSO with OIDC -- Multiple IDP setup with SAP API Management, SSO with OIDC.

 

---

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 ...


• Internet of Things made simpler with SAP API Management Part I - Overview,
  
  
  
  • Part II - SAP Cloud Platform IoT Service
  
  
  • Part III - IoT APIs via SAP API Management
  
  
  
  


• 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

• Centrica PLC - UK Oil & Gas - API-Led Digital Integration Hub

 

Archived Topics:

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.