Table Of ContentSAP PRESS is a joint initiative of SAP and Rheinwerk Publishing. The know-how offered
by SAP specialists combined with the expertise of Rheinwerk Publishing offers the
reader expert books in the field. SAP PRESS features first-hand information and expert
advice, and provides useful skills for professional decision-making.
SAP PRESS offers a variety of books on technical and business-related topics for the SAP
user. For further information, please visit our website: http://www.sap-press.com.
Bönnen, Drees, Fischer, Heinz, Strothmann
SAP Gateway and OData (3rd Edition)
2019, 841 pages, hardcover and e-book
www.sap-press.com/4724
Colle, Dentzer, Hrastnik
Core Data Services for ABAP
2019, 490 pages, hardcover and e-book
www.sap-press.com/4822
Stefan Haas, Bince Mathew
ABAP RESTful Programming Model: ABAP Development for SAP S/4HANA
2019, 563 pages, hardcover and e-book
www.sap-press.com/4988
Acharya, Bajaj, Dhar, Ghosh, Lahiri
SAP Cloud Platform: Cloud-Native Development
2019, 489 pages, hardcover and e-book
www.sap-press.com/4713
Carsten Bönnen, Harsh Jegadeesan, Divya Mary, and Shilpa Vij
SAP® API Management
Dear Reader,
While editing this guide to SAP API Management, I was reminded of something I didn’t
expect: my childhood. Blocks, specifically.
It’s safe to say that most of us have, at one time or another, played with blocks. I
remember owning a set of the basic wooden kind. Uninspiring in shape and color, but
rich in possibility—those blocks became the walls and towers of imagined cities. Get-
ting a bit fancier, you could use alphabet blocks to create words and sentences, or LEGO
bricks to create impressively detailed replicas of the Millennium Falcon (no longer
strictly a childhood activity, I’d say). Beyond childhood toys, blocks are what make up
our buildings and infrastructure—combined materials opening the doorway to some-
thing greater.
So, it ultimately isn’t surprising that blocks come into play in the digital landscape as
well. As expert authors Carsten Bönnen, Harsh Jegadeesan, Divya Mary, and Shilpa Vij
explain in this comprehensive resource to SAP API Management, APIs are your digital
building blocks. Think of this book as your blueprint to harnessing their potential in
pursuit of an innovative, digital enterprise.
What did you think about SAP API Management? Your comments and suggestions are
the most useful tools to help us make our books the best they can be. Please feel free to
contact me and share any praise or criticism you may have.
Thank you for purchasing a book from SAP PRESS!
Megan Fuerst
Editor, SAP PRESS
[email protected]
www.sap-press.com
Rheinwerk Publishing • Boston, MA
Notes on Usage
This e-book is protected by copyright. By purchasing this e-book, you have agreed to
accept and adhere to the copyrights. You are entitled to use this e-book for personal
purposes. You may print and copy it, too, but also only for personal use. Sharing an
electronic or printed copy with others, however, is not permitted, neither as a whole
nor in parts. Of course, making them available on the Internet or in a company network
is illegal as well.
For detailed and legally binding usage conditions, please refer to the section
Legal Notes.
This e-book copy contains a digital watermark, a signature that indicates which person
may use this copy:
Imprint
This e-book is a publication many contributed to, specifically:
Editor Megan Fuerst
Acquisitions Editor Hareem Shafi
Copyeditor Julie McNamee
Cover Design Graham Geary
Photo Credit Shutterstock.com/213651127/© pumatokoh
Production E-Book Graham Geary
Typesetting E-Book III-satz, Husby (Germany)
We hope that you liked this e-book. Please share your feedback with us and read the
Service Pages to find out how to contact us.
The Library of Congress has cataloged the printed edition as follows:
Names: Bönnen, Carsten, author. | Jegadeesan, Harshavardhan, author. |
Mary, Divya, author. | Vij, Shilpa, author.
Title: SAP API management / Carsten Bönnen, Harshavardhan Jegadeesan,
Divya Mary, Shilpa Vij.
Description: 1st edition. | Bonn ; Boston: Rheinwerk Publishing, 2019. |
Includes index.
Identifiers: LCCN 2019039171 (print) | LCCN 2019039172 (ebook) | ISBN
9781493218608 (hardcover) | ISBN 9781493218615 (ebook)
Subjects: LCSH: Application program interfaces (Computer software) |
Computer programming--Management. | SAP HANA (Electronic resource)
Classification: LCC QA76.76.A63 B66 2019 (print) | LCC QA76.76.A63
(ebook) | DDC 005.1068--dc23
LC record available at https://lccn.loc.gov/2019039171
LC ebook record available at https://lccn.loc.gov/2019039172
ISBN 978-1-4932-1860-8 (print)
ISBN 978-1-4932-1861-5 (e-book)
ISBN 978-1-4932-1862-2 (print and e-book)
© 2020 by Rheinwerk Publishing, Inc., Boston (MA)
1st edition 2020
Contents
Foreword ................................................................................................................................................ 15
Preface..................................................................................................................................................... 17
Acknowledgments .............................................................................................................................. 19
PART I Getting Started
1 Introduction
23
1.1 Trends in Digital Business................................................................................................ 24
1.1.1 Emergence of the Intelligent Enterprise....................................................... 25
1.1.2 The Experience Economy ................................................................................... 25
1.1.3 Business Networks, Digital Ecosystems, and Collaboration .................. 26
1.1.4 Outcome-Based Business Models................................................................... 27
1.2 APIs as Digital Building Blocks....................................................................................... 28
1.2.1 Accelerate Innovative Digital Apps................................................................. 29
1.2.2 Real-Time Interactions with Business Networks ....................................... 30
1.2.3 Omni-Channel Access and Single Source of Truth.................................... 31
1.2.4 Business Model Innovations and Monetization ........................................ 31
1.3 Why Manage APIs? ............................................................................................................. 33
1.3.1 Harmonized, Secure, and Simplified Access................................................ 33
1.3.2 Traffic Management............................................................................................ 35
1.3.3 Governance and Reuse ....................................................................................... 36
1.3.4 Usage Analytics and Monitoring..................................................................... 38
1.3.5 Metering and Monetization.............................................................................. 39
1.4 SAP API Management: A Full-Lifecycle API Management Platform ............. 39
1.4.1 End-to-End API Lifecycle..................................................................................... 40
1.4.2 API Lifecycle Personas ......................................................................................... 41
1.5 Related and Complementary Products...................................................................... 42
1.6 Summary ................................................................................................................................. 43
7
Contents
2 SAP API Management at a Glance
45
2.1 Architecture ........................................................................................................................... 45
2.2 Introduction to the Real-World Scenario ................................................................. 48
2.2.1 Retail ........................................................................................................................ 48
2.2.2 Food Services ......................................................................................................... 49
2.2.3 Health Care ............................................................................................................ 50
2.2.4 Utilities .................................................................................................................... 50
2.2.5 High-Tech ............................................................................................................... 51
2.2.6 Pharmaceuticals................................................................................................... 52
2.3 Deploying and Running Your First API Proxy ......................................................... 52
2.3.1 Prerequisites.......................................................................................................... 53
2.3.2 Set Up the Landscape and the Technical Conditions............................... 53
2.3.3 Create the API Proxy............................................................................................ 54
2.3.4 Manage the API Proxy with Policies............................................................... 58
2.3.5 Deploy...................................................................................................................... 61
2.4 Summary................................................................................................................................. 62
3 Managing the End-to-End Lifecycle of APIs
63
3.1 Overview of the API Lifecycle ........................................................................................ 63
3.1.1 Design ...................................................................................................................... 65
3.1.2 Develop.................................................................................................................... 65
3.1.3 Manage ................................................................................................................... 66
3.1.4 Meter and Monetize ........................................................................................... 66
3.1.5 Engage ..................................................................................................................... 66
3.2 Components of SAP API Management ...................................................................... 67
3.2.1 API Designer........................................................................................................... 67
3.2.2 API Portal................................................................................................................. 75
3.2.3 Developer Portal................................................................................................... 95
3.2.4 API Gateway........................................................................................................... 102
3.3 Lifecycle of APIs.................................................................................................................... 103
3.3.1 Create an API Provider........................................................................................ 103
3.3.2 Create an API Proxy ............................................................................................. 106
8
Contents
3.3.3 Secure and Manage Your APIs.......................................................................... 109
3.3.4 Create an API Product ......................................................................................... 113
3.3.5 Monitor and Analyze Your APIs ....................................................................... 116
3.3.6 Meter and Monetize Your APIs ........................................................................ 118
3.4 Summary ................................................................................................................................. 119
PART II Designing, Developing, and Managing
Enterprise APIs
4 Developing APIs
123
4.1 API Development Methodology ................................................................................... 123
4.2 Access the API Designer .................................................................................................... 125
4.3 API Providers.......................................................................................................................... 126
4.3.1 Create ....................................................................................................................... 127
4.3.2 Import....................................................................................................................... 134
4.4 Develop New APIs ............................................................................................................... 135
4.4.1 Microservices ......................................................................................................... 136
4.4.2 Software Development Kit................................................................................ 148
4.4.3 SAP Cloud Application Programming Model............................................... 150
4.5 Add Resilience to Your APIs............................................................................................. 150
4.6 Summary ................................................................................................................................. 152
5 Managing Enterprise APIs
153
5.1 Policy Editor Basics.............................................................................................................. 153
5.2 Using Policies......................................................................................................................... 156
5.3 Traffic Management .......................................................................................................... 158
5.4 Mediation................................................................................................................................ 160
5.5 Security..................................................................................................................................... 162
9
Contents
5.6 Extension ................................................................................................................................ 164
5.7 Summary................................................................................................................................. 166
6 Traffic Management
167
6.1 Access Control....................................................................................................................... 168
6.2 Concurrent Rate Limit ....................................................................................................... 170
6.3 Quotas...................................................................................................................................... 177
6.4 Response Cache ................................................................................................................... 181
6.5 Spike Arrest............................................................................................................................ 184
6.6 Summary................................................................................................................................. 186
7 Mediation
187
7.1 Assign Message.................................................................................................................... 188
7.2 Extract Variables ................................................................................................................. 195
7.3 JSON to XML .......................................................................................................................... 200
7.4 XML to JSON .......................................................................................................................... 205
7.5 Key Value Map Operations ............................................................................................. 208
7.6 Raise Fault .............................................................................................................................. 212
7.7 Service Callout...................................................................................................................... 214
7.8 Summary................................................................................................................................. 217
8 Security
219
8.1 Authentication ..................................................................................................................... 220
8.1.1 Verify API Key......................................................................................................... 220
8.1.2 OAuth....................................................................................................................... 222
10
