Cover image for What is API Management: abstract blue-to-sky gradient with the Negzel mark

Knowledge

What is API Management?

API Management lets an organisation publish, protect and measure its APIs from a single layer placed in front of its back-end systems. In SAP Integration Suite it has five components: API Portal, Developer Hub, API Runtime, API Analytics and API Designer.

Company systems now open data to partners, mobile apps and cloud services as well. Exposing every back end directly means solving authentication, versioning and usage tracking separately in each system. API Management brings these concerns into one layer placed in front of the back end.

What API Management does

  • Design and documentation: APIs are defined and documented with OpenAPI.
  • Security: Access is controlled with OAuth 2.0, API keys, basic authentication or SAML.
  • Traffic control: Quotas and spike limits protect the back end.
  • Performance: Response caching and load balancing across several back ends.
  • Monitoring: Call counts, latency and error data.
  • Monetisation: Per-call or tiered rate plans can be attached to products.

API Management components in SAP Integration Suite

According to SAP's documentation, API Management in SAP Integration Suite consists of five components:

API Management in SAP Integration Suite: components and the path of a call The client app calls the API proxy running in API Runtime, not the back end; rules are applied on the proxy as policies and the call is passed to one or more API providers.
Client appPartner, mobile app, cloud serviceCalls the proxy, not the backendAPI proxyThe address stays the same when the back endchanges.API RuntimePoliciesVerify API KeyOAuth v2.0QuotaSpike ArrestResponse CacheXML and JSON Threat ProtectionXSL TransformJSON to XMLAPI providerBack end, e.g. SAPCPI or SAP GatewayCan connect to severalproviders with loadbalancingThe other API Management componentsDeveloper HubDevelopers discover APIs,subscribe and build appsAPI DesignerDefines and documents APIswith OpenAPIAPI PortalCreates, secures and publishesproxiesAPI AnalyticsCollects URL, user ID andlatency dataSource: SAP Help Portal, SAP Integration Suite API Management documentation.Client appPartner, mobile app, cloud serviceCalls the proxy, not the back endAPI RuntimeAPI proxyThe address stays the same when theback end changes.PoliciesVerify API KeyOAuth v2.0QuotaSpike ArrestResponse CacheXML and JSON Threat ProtectionXSL TransformJSON to XMLAPI providerBack end, e.g. SAP CPI or SAPGatewayCan connect to several providers with loadbalancingThe other API Management componentsDeveloper HubDevelopers discover APIs, subscribe andbuild appsAPI DesignerDefines and documents APIs with OpenAPIAPI PortalCreates, secures and publishes proxiesAPI AnalyticsCollects URL, user ID and latency dataSource: SAP Help Portal, SAP Integration Suite APIManagement documentation.

The path of a call: proxies and policies

The client calls the API proxy, not the back end. The proxy decouples the API from changes in the back end: if the back end moves or changes version, the address the client calls stays the same. Rules are applied on the proxy as policies:

PolicyWhat it does
Verify API Key, OAuth v2.0Identifies the caller and checks its authorisation
QuotaCounts how many requests an application may send in a given period
Spike ArrestProtects the back end from sudden load; keeps no counter
Response CacheKeeps responses in a cache
XML and JSON Threat ProtectionStops suspiciously structured payloads before they reach the back end
XSL Transform, JSON to XMLTransforms the payload

An API proxy can be connected to several API providers with load balancing; if the additional providers are unavailable, traffic goes to the chosen fallback server. This option does not exist for on-premise type providers.

If the API provider is SAP CPI (new name: SAP Integration Suite, Cloud Integration) or SAP Gateway, services can be discovered directly. This way an iFlow endpoint is published as an API protected by policies.

For teams using SAP PI/PO

In SAP's definition SAP PO consists of AEX, SAP NWBPM and SAP BRM; API management is not among them. SAP's migration guide for SAP PO names API Management as the counterpart of the Services Registry in SAP NetWeaver: a developer portal with try and subscribe, analytics on API traffic, and metering.

We cover the other capabilities of SAP Integration Suite in our What is SAP Integration Suite? article and our consulting scope on the SAP Integration Suite consulting page.

Frequently asked questions

What is SAP Integration Suite?

Quick access

SAP module consulting

We provide consulting across SAP modules, from finance to manufacturing and from integration to data.

Looking for the right consultant?Find an Expert SAP Consultant
Finance8
Human resources3
Logistics11
Manufacturing7
Projects and engineering2
Platform and development4
Integration2
Data and control3