Skip to Content

Create an API Proxy

Learn how SAP Integration Suite, API Management can leverage the OData catalog service to retrieve relevant information from a SAP Gateway system and pre-populate required information for an API proxy.
You will learn

SAP Integration Suite, API Management uses three main components to expose APIs.
- The API Provider is used to abstract the connection to the backend / target system
- The API Proxy is the actual API which contains the logic to connect to the target system. Here you can model the flow, add security policies, transform the incoming message or look for content injections
- The API Product which bundles one or more API Proxies before they are exposed in the API Business Hub Enterprise so they can be consumed by a developer

mhassett92Meredith HassettJuly 19, 2021
Created by
mhassett92
August 22, 2017
Contributors
mhassett92

Prerequisites

In this tutorial you will learn how to create an API Proxy based on the API Provider created in the previous step. You will learn how SAP Integration Suite, API Management can leverage the OData catalog service to retrieve relevant information from a SAP Gateway system and pre-populate required information for the API Proxy

  • Step 1

    Create an API proxy and take a look at the Policy Editor. You will start to look into the details of building an API Proxy that contains some real life functionality.

    Does an API Proxy contain any functionality?

    Log in to complete tutorial
  • Step 2

    Open the API Management, API Portal (you can get the URL from Integration Suite Launchpad, click on Design Develop, and Manage APIs).

    Open SAP API Management API Portal
    Log in to complete tutorial
  • Step 3

    From the Home screen under the Quick Actions tile, click on API. This will bring up the Create API wizard.

    Click on API
    Log in to complete tutorial
  • Step 4

    To view your APIs that you have previously created, select from the Hamburger Menu in the upper left corner and click Develop.

    Click on Develop

    This will open the list of previously created APIs.

    To create a new API from this page, click Create.

    Click on Create
    Log in to complete tutorial
  • Step 5

    From the drop-down select the SAPDeveloperSystemES5 API Provider created in the previous tutorial.

    Select Provider System
    Log in to complete tutorial
  • Step 6

    Click on Discover.

    Click on Discover
    Log in to complete tutorial
  • Step 7

    Select the GWSAMPLE_BASIC services by using the search bar to search for sample.

    You can use the Search to narrow down the list.

    Select the GWSAMPLE_BASIC service

    Click on OK.

    The remaining fields from the API Proxy creation screen are populated. Click Create.

    In the trial version, there is only 1 option for the Host Alias which is your default trial account. Leave this as is.

    Click on Create
    Log in to complete tutorial
  • Step 8

    Click on Save.

    Click on Save
    Log in to complete tutorial
  • Step 9

    Status of the API Proxy is Not Deployed as we have not deployed the API

    Click on the arrow next to Create API to go back to the overview page

    Go back to Overview

    A new API Proxy has been created

    API Proxy has been created
    Log in to complete tutorial
  • Step 10

    Click on action button from right side and select Deploy

    Deploy Proxy

    API proxy is deployed.

    Log in to complete tutorial
  • Step 11

    To Test your API proxy, navigate to Test from navigation bar.

    Navigate Test

    Select your API and provide the user name and password and click OK.

    Test Authentication

    Click on Send.

    Get Request

    You should get the response.

    Log in to complete tutorial
Back to top