SAP-samples/manage-apis-codejam

Managing APIs in your landscape with SAP API Management

Welcome to the Managing APIs in your landscape with SAP API Management CodeJam repository. In this SAP CodeJam, we will look at SAP API Management part of the SAP Integration Suite and how we can use it to manage the different APIs exposed by our systems and services.

API Management Scenario

As is - Current data flow without SAP API Management

We work for a company, ITeLO. ITeLO is a large enterprise with offices in 50 different countries. They currently use SAP S/4HANA Cloud as their main ERP and SAP SuccessFactors to manage their employees. Also, within their organization they have multiple development teams and they want to standarise how developers discover/consume/manage the APIs exposed by the variety of systems that they have in-house and external APIs that are consumed by their internal systems.

Our task is to make accessible and organise the APIs from/consumed by the different systems/services in our landscape. Also, we want to control/limit the number of paths/operations exposed for certain APIs, e.g. the SAP S/4HANA Cloud Business Partner API.

By the end of the CodeJam, we will achieve an API Management scenario like the one below in the diagram.

To be - Managing our APIs with SAP API Management

Prerequisites

The prerequisites to follow the exercises in this repository, including hardware and software, are detailed in the prerequisites file.

Live system

As part of this CodeJam we will try to provide access to a live SAP S/4HANA Cloud instance. Whenever you see the following emoji - 🔐 - in the exercises, it means that your instructor will provide details to configure a live system.

Material organization

The material consists of a series of exercises. These exercises build on each other and should be completed in the given order. For example, we start by creating a simple integration flow, and we will extend it in the subsequent exercises.

The repository includes some slides, which will be used when running an SAP CodeJam event. The slides were built using Marp and an HTML export is included here. You can also preview the slides here.

Exercises

During the CodeJam you will complete each exercise one at a time. At the end of each exercise, questions are included to help you think about the content just covered and are to be discussed with the entire CodeJam class, led by the instructor, when everyone has finished that exercise.

If you finish an exercise early, please resist the temptation to continue with the next one. Instead, explore what you've just done and see if you can learn more about the subject covered. That way, we all stay on track together and can benefit from some reflection via the questions (and answers).

See below for an overview of the exercises part of this CodeJam.

• Please ensure that you have completed all the prerequisites.
• Exercises:
  • Exercise 01 - The OpenAPI specification
  • Exercise 02 - Getting familiar with the SAP Business Accelerator Hub
  • Exercise 03 - Discover and import an API
  • Exercise 04 - Deploy an API
  • Exercise 05 - Testing an API using the API Test Console
  • Exercise 06 - Publishing our API
  • Exercise 07 - Import an API using an OpenAPI specification
  • Exercise 08 - Add an SAP SuccessFactors Employee Central API
  • Exercise 09 - Monitoring APIs
  • Exercise 10 - API policies
  • Exercise 11 - Consume protected APIs by creating an application
  • Exercise 12 - Protecting our APIs
  • Exercise 13 - Editing API paths, operations, and documentation
  • Optional Exercise 01 - Expose integration flow via API Management
  • Optional Exercise 02 - API Security Best Practices
  • Optional Exercise 03 - API Provider

Troubleshooting

While going through the exercises, you might encounter common problems not explicitly related to them. Check out the troubleshooting.md page, which includes a list of these common problems and their potential solutions.

Known Issues

None

Feedback

If you can spare a couple of minutes at the end of the session, please help us improve for next time by giving me some feedback.

Simply use this Give Feedback link to create a special "feedback" issue, and follow the instructions there.

Gracias/Thank you/Obrigado/Merçi/Danke!

How to obtain support

Support for the content in this repository is available during CodeJam events, for which this content has been designed.

Alternatively, if you are completing this CodeJam on your own, outside of an event, you can create an issue in this repository if you find a bug or have questions about it.

For additional support, ask a question in SAP Community.

Contributing

Please send a pull request if you wish to contribute code or offer fixes or improvements. Due to legal reasons, contributors will need to accept a DCO when they create the first pull request for this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

License

Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.