SAP API Management

180 Pages·2017·4.44 MB·English

User Guide PUBLIC
2017-02-18
SAP API Management
Content
1 SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
1.1 What's New. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Release 2017-02-18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Release 2017-02-04. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Release 2016-12-15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Release 2016-11-16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Release 2016-10-20. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Release 2016-08-26. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Release 2016-07-29. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Release 2016-07-07. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Release 2016-06-10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Release 2016-05-05. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Release 2016-04-10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Release 2016-03-12. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Release 2016-02-10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Release 2015-12-15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Release 2015-11-17. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Release 2015-09-22. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Release 2015-08-25. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Release 2015-08-04. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.2 Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Components of SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Concepts of API Platform for SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
Set Up SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Quick Documentation Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Further Information: Recordings, Blogs, FAQs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
1.3 Build APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
API Artifacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Configure Cache Resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Add Key Value mapping at Environment Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Create an API Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Manage Certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Create an API Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Test APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Debug API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
1.4 Publish APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
SAP API Management
2 PUBLIC Content
Create a Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
View Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
1.5 Analyze APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Pre-Configured Charts and KPIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160
Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Working with the Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
1.6 Consume APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
Onboard an Application Developer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Browse Catalog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Subscribe to a Product. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Create an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Consume Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
Analyze API Usage in Subscribed Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
1.7 Securing SAP API Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176
2 API Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177
SAP API Management
Content PUBLIC 3
1 SAP API Management
With the emergence of cloud, mobile and social technologies, new applications have become a driving force in the
way people consume content and access services. Millions of mobile devices in use today are generating digital
data at an exponential rate. This massive influx of digital information is changing the way businesses are
operating. To keep up with the digital footprint produced, businesses identify and implement ways to reach out to
their customer and meet their needs, easily and securely.
Through software interfaces called application programming interfaces (APIs), companies can provide business
services and information directly to customers. APIs simplify the work of programming graphical user interface
components for all types of apps on mobile devices, in the cloud, and on wearables. Exposing digital assets enable
you to create and deliver content and business services to your customers, partners, and employees so that they
can better engage, collaborate, and innovate.
SAP 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 co-innovation 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.
SAP API Management facilitates consumer engagement anywhere, any time. It reduces complexity by leveraging
a single provisioning platform (API Platform) to provide unified access and governance of APIs across a
heterogeneous landscape.
Central API management and monitoring - SAP API Management provides one experience for managing and
monitoring all APIs across various data platforms and is enriched with real-time analytics.
Secure and scalable enterprise information for digital access - SAP API Management enables consumers to
access relevant data directly in a secure manner. Selective data can be exposed while reducing the risk of security
breaches. Rather than app developers consuming services directly, they access APIs created using SAP API
Management. APIs created using SAP API Management map a publicly available HTTP endpoint to backend
services. SAP API Management handles the security and authorizations required to protect, analyze, and monitor
your services.
Table 1:
page 15 Getting Started
Regardless of your role, familiarize yourself with core SAP API Management con­
cepts. As an administrator, learn about the activities required before APIs can be
built using SAP API Management.
page 31 Build APIs
API Platform: To expose an API, you first need to create an API Provider. You can
then create an API proxy and associate it with policies.
Applicable to: API Administrator
SAP API Management
4 PUBLIC SAP API Management
page 154 Publish APIs
API Platform: To publish your APIs, you need to create a product.
Applicable to: API Administrator
page 159 Analzye APIs
API Analytics: Use the capabilities of API Analytics to analyze API usage, perform­
ance, and potential errors.
Applicable to: API Administrator
page 165 Consume APIs
Developer Services: Use the SAP API Management Developer Portal to consume
the exposed APIs.
Applicable to: Application Developer and Application Consumer
1.1 What's New
This section outlines the new features for SAP API Management that are provided in monthly software updates.
The new features are listed according to the month of the customer software release.
1.1.1 Release 2017-02-18
This release note corresponds to the customer shipment on 2017-02-18 and build versions of API Portal 1.23 and
Developer Portal 1.25.
Table 2:
Function Type of Description
Change
Policy template New You can now import, export and delete policy templates to an API
Proxy. For more information see Import a Policy Template [page
145], Export a Policy Template [page 146] and Delete a Policy Tem­
plate [page 147]
1.1.2 Release 2017-02-04
This release note corresponds to the customer shipment on 2017-02-04 and build versions of API Portal 1.22 and
Developer Portal 1.25.
SAP API Management
SAP API Management PUBLIC 5
Table 3:
Function Type of Description
Change
Policy template New You can now create and apply policy templates to an API Proxy. For
more information see Policy Template [page 143]
Policy type New You can now add new policies to an API Proxy. For more information
see XML Threat Protection policy [page 112] and Regular Expres­
sion Protection policy [page 115]
Metering data New ● You can now view the number of calls made for all APIs in a
product. For more information see Create a Product [page 155]
● You can now view the number of calls made for all APIs in an ap­
plication. For more information see View Applications [page
158]
● You can now view the number of calls made by the application
key for the current month. for more information see Create an
Application [page 172]
1.1.3 Release 2016-12-15
This release note corresponds to the customer shipment on 2016-12-19 and build versions of API Portal 1.19 and
Developer Portal 1.22.
Table 4:
Function Type of Description
Change
Post Client flow New You can now add a PostClientFlow to the ProxyEndpoint, which exe­
cutes after the response is returned to the requesting client applica­
tion. For more information, see Flow [page 35]
1.1.4 Release 2016-11-16
This release note corresponds to the customer shipment on 2016-11-15 and build versions of API Portal 1.18 and
Developer Portal 1.21.
Table 5:
Function Type of Description
Change
SOAP Message Validation Policy New A new policy has been introduced to validate SOAP messages and
reject the messages if it does not conform to the specified require­
ments. For more information, see SOAP Message Validation Policy
[page 101]
SAP API Management
6 PUBLIC SAP API Management
Function Type of Description
Change
On-Premise Connectivity New You can now connect to the on-premise system through HANA cloud
connector and create API provider of on-premise type. For more in­
formation, see Create an API Provider [page 129]
1.1.5 Release 2016-10-20
This release note corresponds to the customer shipment on 2016-10-20 and build versions of API Portal 1.17 and
Developer Portal 1.20.
Table 6:
Function Type of Description
Change
SAML Assertion Policies New A new policy has been introduced to enable API proxies to validate
and generate SAML assertions in inbound and outbound requests.
For more information, see SAML Assertion Policy [page 98]
Enhancement in on-boarding user ac­
Enhanced There is a confirmation dialog added while on-boarding user ac­
count
count, which displays options to open a service request or incident
based on success or failure scenario, respectively. For more informa­
tion, Onboard a Customer Account [page 20]
1.1.6 Release 2016-08-26
This release note corresponds to the customer shipment on 2016-08-26 and build versions of API Portal 1.15 and
Developer Portal 1.18.
Table 7:
Function Type of Description
Change
Breadcrumb option added in Analytics New When you apply filter on a chart to drill down more in to details, you
charts can navigate back to any previous parameter that you want to view
using the breadcrumb option. For more information, see Working
with the Analytics Dashboard [page 162]
Create API from API designer You can create APIs in open API format using the API designer that is
made available on API Portal. For more information, see Create an
API from API Designer [page 139]
SAP API Management
SAP API Management PUBLIC 7
1.1.7 Release 2016-07-29
This release note corresponds to the customer shipment on 2016-07-29 and build versions of API Portal 1.14 and
Developer Portal 1.17.
Table 8:
Function Type of Description
Change
UI enhancements New UI has been enhanced to adapt Fiori based framework. Tabular view
has been enabled with row wise actions in the following screens: API,
API Provider, Certificate, Product and Application.
Support for four new static dimensions Enhanced You can now filter analytics data based on the following four new
static dimensions: Request URI, API Provider Host, Proxy Base Path
and HTTP status code.
1.1.8 Release 2016-07-07
This release note corresponds to the customer shipment on 2016-07-07 and build versions of API Portal 1.13.7
and Developer Portal 1.16.5.
Table 9:
Function Type of Description
Change
UI enhancements New UI has been enhanced to adapt Fiori based framework. All the navi­
gation bars on the left hand side of the application has been replaced
with icons for better look and feel.
Define drill-down options in custom Enhanced You can now drill-down in custom charts based on default or custom
charts dimensions, so that you can analyze a specific dimension as re­
quired. For more information, see Working with the Analytics Dash­
board [page 162].
Simplified Onboarding Process New You can now perform self-service based on-boarding of API Portal
and Dev Portal from the HCP service cockpit. For more information,
see Onboard a Customer Account [page 20].
1.1.9 Release 2016-06-10
This release note corresponds to the customer shipment on 2016-06-10 and build versions of API Portal 1.12 and
Developer Portal 1.15.
SAP API Management
8 PUBLIC SAP API Management
Table 10:
Function Type of Description
Change
Configure custom charts based on multi­ New You can now configure charts based on multiple measures and di­
ple measures and dimensions mensions, by setting the filters at the time of configuration. For more
information, see Working with the Analytics Dashboard [page 162]
Regenerate application Key Enhanced You can now regenerate the application key and use the same in all
your new requests. For more information, see Create an Application
[page 172]
Manage API Provider certificates New You can now upload new API Provider certificates and associate
them to the API providers at the time of registration. For more infor­
mation, see Manage Certificates [page 131]
1.1.10 Release 2016-05-05
This release note corresponds to the customer shipment on 2016-05-05 and build versions of API Portal 1.11 and
Developer Portal 1.14.
Table 11:
Function Type of Description
Change
API Portal home page New Once you log on to the API Portal you can now view a new home
page, which shows tiles on various parameters at a high level of the
current API Management account. Tiles include API Calls, API Errors,
Total APIs, Applications, API Provider errors, consumption pattern of
APIs and API provider, Products, and Developers.
View API Key and Secret New If you have logged on to the API Portal with the role APIPortal.Admin­
istrator, you can view the API key and secret of the applications.
UI improvements Enhanced The look and feel of the API Portal has been enhanced to provide bet­
ter usability.
Save and publish products New You can now explicitly save and publish products. For more informa­
tion, see Create a Product [page 155]
1.1.11 Release 2016-04-10
This release note corresponds to the customer shipment on 2016-04-10.
Note
The above date refers to the planned release date and can change without further notice.
SAP API Management
SAP API Management PUBLIC 9
Table 12: API Portal
Function Type of Description
Change
Analytics dashboard in Developer Portal You can now view API usage based on subscribed applications. For
New
more information, see Analyze API Usage in Subscribed Applications
[page 175]
View API Portal content in read-only A new role is introduced to allow users to only view API portal. For
New
mode more information, see Assign Users to Roles [page 21]
You can now add user credential for the API provider in the API Por­
Manage API provider user credentials in Enhanced
tal. For more information, see Create an API Provider [page 129]
API Portal
Save and deploy APIs You can now explicitly save and deploy APIs. For more information,
New
see Create an API from the API Portal [page 135]
Publish products associating with API re­ You can now associate API resources with the published products.
Enhanced
sources For more information, see Create a Product [page 155]
Add key value pairs at the environment You can now add key value pairs at environment level to manage API
New
level proxies scope for longer-term data persistence. for more informa­
tion, see Add Key Value mapping at Environment Level [page 126]
Add custom charts in analytics dash­ You can now add custom charts in analytics dashboard. For more in­
New
board formation, see Working with the Analytics Dashboard [page 162]
View applications from API portal New You can now view the applications in API Portal. For more informa­
tion, see View Applications [page 158]
Navigate to chart details from dash­ You can now navigate to chart details from dashboard. For more in­
Enhanced
board formation, see Working with the Analytics Dashboard [page 162]
1.1.12 Release 2016-03-12
This release note corresponds to the customer shipment on 2016-03-12.
Note
The above date refers to the planned release date and can change without further notice.
Table 13: SAP API Management Design time
Function Type of Change Description
Publish products associating with API re­ You can now associate API resources with the pub­
Enhanced
sources lished products. For more information, see Create a
Product [page 155]
Add key value pairs at the environment You can now add key value pairs at environment
New
level level to manage API proxies scope for longer-term
data persistence. for more information, see Add
Key Value mapping at Environment Level [page
126]
SAP API Management
10 PUBLIC SAP API Management