SAP API Management
User Guide | PUBLIC 2024-08-09
SAP API Management Standalone Service
THE BEST RUN
? 2024 SAP SE or an SAP affiliate company. All rights reserved.
Content
1
SAP API Management in the Cloud Foundry Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 What is API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Components of API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Concepts of API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
API Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Accessibility Features in API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Important Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.2 What's New for SAP API Management Cloud Foundry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Archive - Release Notes for SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
1.3 Patch Releases for API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Patch Archive 2021. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
1.4 Configure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Initial Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Custom Domain Configuration for API Portal or API business hub enterprise Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Region-Specific IP Addresses Available for API Management Cloud Foundry Environment. . . . . . 161
Configuring Additional Virtual Host in Cloud Foundry Environment. . . . . . . . . . . . . . . . . . . . . . 163
Shadow Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Cancel API Management Service Subscription. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Centralized API business hub enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
1.5 Build API Proxies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Key Components of an API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Different Methods of Creating an API Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Edit an API Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Additional Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
1.6 Test API Proxies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Debug an API Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
1.7 Publish API Proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Create a Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
View Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
1.8 Consume API Proxies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Onboard an Application Developer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .647
Configure API business hub enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Customize the Visual Format of the API business hub enterprise . . . . . . . . . . . . . . . . . . . . . . . 655
Manage Domain Categories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Manage Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
2
PUBLIC
SAP API Management Standalone Service Content
Manage External Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660 Manage Developer Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661 Subscribe to a Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663 View Applications, Costs, and Analyze Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663 Create an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .664 Consume Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669 Analyze Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670 Consume API Proxies Using SAP Business Application Studio. . . . . . . . . . . . . . . . . . . . . . . . . .671 Test Runtime Behavior of APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671 1.9 Analyze API Proxies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .673 API Analytics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674 Advanced API Analytics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678 SAP Analytics Cloud for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689 1.10 Monetize APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689 Rate Plan Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690 Billing Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695 Create or Update or Read an Application using Subscription key. . . . . . . . . . . . . . . . . . . . . . . 699 1.11 Discover API Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703 Package Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704 1.12 API Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .704 1.13 Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705 Data Protection and Privacy for API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 1.14 Monitoring and Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748 Limits in API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748 Monitor the Health of Custom Domain Virtual Host Certificates Using SAP Cloud ALM. . . . . . . . 752 API Management FAQs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752 1.15 Migration of API Management Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764 Migrating API Management from Neo to the Multi-Cloud Foundation. . . . . . . . . . . . . . . . . . . . 764 Migration of API Management Content between Cloud Foundry Environments. . . . . . . . . . . . . 809
SAP API Management Standalone Service Content
PUBLIC
3
1 SAP API Management in the Cloud Foundry Environment
SAP API Management lets you publish, promote, and oversee APIs in a secure and scalable environment.
Environment
This service runs in the following environments:
? NEO environment ? Cloud Foundry environment
Features
Create omni-channel experiences
Use API Designer and Open APIs to create a omni-channel mobile experience across devices.
Secure your digital assets, interfaces
Help protect your data and digital assets in this hyper-connected world. Get deep insights on API usage.
Manage the end-to-end lifecycle Scale billions of API calls to unlock new opportunities, new business
of APIs
potential and add additional value.
Engage developers and partners API Business Hub Enterprise simplifies sharing managed APIs and collaborations with customers, partners, and developers.
Grow new revenue streams
Monetize your data and digital assets with help of API Portal. Upsell and cross-sell through your ecosystem.
Evolve B2B integrations
Extend solutions with additional SAP BTP capabilities for mobile, offline and integration.
Benefit from multitenancy support
Use this service in tenant-aware pplications.
API Management technology helps you to share digital assets and enable developer communities to consume these assets in new channels, devices, and user interfaces. Available in the cloud, the technology helps promote coinnovation among employees, partners, and the developer community. To gain better insights about consumer needs, you can empower employees and partners with access to critical information and increase reach to a wider customer base.
4
PUBLIC
SAP API Management Standalone Service SAP API Management in the Cloud Foundry Environment
The Cloud Foundry environment gives you the ability to subscribe to the API Management service, while you may choose a public infrastructure to run the API Management service, such as Amazon Web Services or microsoft Azure.
Get started by subscribing to API portal and API business hub enterprise applications where you can create APIs and consume them. For setting up the API Portal application, see here [page 117]. Once the API portal is setup, see here [page 121] to set up the API business hub enterprise application.
1.1 What is API Management
API Management lets you publish, promote, and oversee APIs in a secure and scalable environment. Using API Management, you can create simple digital experiences for your consumers, partners, and employees.
The API Management capability in SAP Integration Suite is a complete solution, that addresses all enterprise requirements for API security and governance.
With API Management you can:
? Proxify your APIs: Create your own unified and harmonised API presence, using your own domain. ? Secure your APIs: Secure your APIs against unauthorized access and threats. API management helps
organizations define a standardized set of policies to protect APIs and the underlying backends.
? Perform Traffic Management: Configure cache, and control traffic quotas and spikes, using the traffic
management policies.
? Govern your APIs: Discover and document all your APIs, manage the lifecycle of your APIs and govern
them using the policies. Over 30 different policy types are available, ranging from traffic management and security policies.
? Get Business Insights: Monitor with usage analytics, logs, events and triggers; use business insights to
monetize your APIs.
? Transform your APIs: Apply advance header and payload modifications. ? Developer Engagements: API business hub enterprise is a feature-rich, themed, and customizable portal
designed specifically for application developers. It provides comprehensive API documentation, code snippets, and more. With API business hub enterprise, developers can easily engage with the platform, enabling them to discover, subscribe to, and consume APIs directly.
SAP API Management Standalone Service SAP API Management in the Cloud Foundry Environment
PUBLIC
5
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related download
- amazon simple email service aws documentation
- selling on amazon guide to xml
- overview of amazon web services aws whitepaper
- online shopping project documentation template
- guidance application programming interfaces apis in adgm
- m y d e a l u n iv e r s a l a p i d o c u m e amazon s3
- sap api management
- heos cli protocol specification denon
- tidal workload automation 6 3 3 documentation overview
- qualys integration with aws security hub