There are hardware, software and service prerequisites for participating in this CodeJam. The exercises will be developed using the SAP API Management capability of SAP Integration Suite and communicating with remote services that will be made available for the CodeJam.
In this CodeJam, you will see that across exercises, there are references to files that will help you get started or that are needed to complete the activities. To access these files, you can download the individual files directly from the repository website, or you can make a copy of the repository on your local machine by following one of the options below:
-
(Recommended) Clone the git repository in your local machine with the following command:
$ git clone https://github.com/SAP-samples/manage-apis-codejam.git
If you've set up SSH to communicate with GitHub from your local machine, you can clone it using the following command:
git clone [email protected]:SAP-samples/manage-apis-codejam.gitUsing
gitis recommended as there might be future updates on the CodeJam content; updating your local copy will just be a command away.$ git pull origin main
-
Alternatively, download the repository as a zip, and unzip it.
None.
A web browser supported by the SAP Integration Suite1: For the UIs of the service, the following browsers are supported on Microsoft Windows PCs and, where mentioned below, on macOS. Note that, however, certain limitations might apply for specific browsers:
Cloud Integration has been tested using the following browsers:
- Google Chrome (latest version)
- Microsoft Edge (latest version)
- Mozilla Firefox (latest version)
- Windows Internet Explorer (as of version 10)
The application can also be used with Safari browser and Internet Explorer 9. However, some features might not work as expected.
Postman, used to get familiar with the SAP S/4HANA Cloud API and send some requests to an SAP Cloud Integration iFlow. Follow the installation instructions included in this tutorial: Install Postman REST Client.
Once installed you can import the collection and environments included in the
./manage-apis-codejam/assets/postmanfolder.
Using the SAP BTP Free Tier (⚡️ recommended ⚡️)
- Get a free SAP Business Technology Platform account (if you don't already have one):
- Subscribe to the SAP Integration Suite service by following the instructions included in step 2 of the Set up the SAP Integration Suite trial tutorial.
Using the SAP BTP Trial account
- Get an SAP Business Technology Platform trial account:
Once subscribed to the SAP Integration Suite service, we will need to provision the following capabilities:
- API Management
To provision the SAP Integration Suite capabilities, follow the instructions included in step 3 of the Set up the SAP Integration Suite trial tutorial.
🚨 This is only required if you are running in a non-trial environment
Complete setup of SAP API Management (👉 when not running in the trial environment 👈)
Before being able to access API Management, you will need to complete the setup. Go to the API Management settings by navigating within the Integration Suite UI to *Settings > APIs*.
API Management settings
Enter a host alias, add a notification contact (your email address) and click the Set Up button on the upper right corner.
Set up API Management capability
Set up API Management - Complete
For detailed steps, follow the instructions included in step 5 - Configure the API Management Service of the Set Up API Management from Integration Suite tutorial.
Once the capability is active, make sure you assigned the following role collections to your user:
- APIManagement.*
- APIPortal.*
- AuthGroup.*
For simplicity purposes, assign all the roles that match the patterns provided below
Go to your SAP BTP Cockpit. Navigate to Security > Users, select your User and click the Assign Role Collections button.
Once you've set up SAP API Management, you can access the API Business Hub Enterprise from the SAP Integration Suite home page.
Navigate to the API Business Hub Enterprise
Link to API Business Hub Enterprise
Hover over the Enterprise Manager item in the navigation bar and select Manage - Users. Go to the Registered Users tab and click the Add User button. Enter your user details, assign the required roles and click the Add button.
Add user to Registered Users
If everything went fine, you've successfully registered your user as a registered user of the API Business Hub Enterprise.
If you are going through the CodeJam content on your own or don't have access to a live system, you can use the sandbox environment available as part of the SAP Business Accelerator Hub. To communicate with the sandbox environment you will need an API key. The gif below shows you how you can get an API key from the SAP Business Accelerator Hub.
Show API key in the SAP Business Accelerator Hub
An alternative would be going to your profile settings and clicking the Show Key button in your profile.
Show Key button in profile settings