Building API Provider

Objective

After completing this lesson, you will be able to create an API provider using the SAP Integration Suite.

API Provider Creation

In this lesson, we will cover the following topics:

  • Role of an API provider
  • Procedure for creating an API provider

Role of an API Provider

An API provider defines the connection details for services running on specific hosts whose details you want to access. Use an API provider to define the following:

  • Details of the host that you want an application to reach.
  • Define any further details that are necessary to establish the connection, for example, proxy settings.
Flowchart of API management system showing connections between API providers, consumers, products, policies, debugging, monitoring metrics, and credential storage. The diagram includes five API sources.

An API provider can connect to the following sources:

  • No. 1: Open Connectors
  • No. 2: Through Cloud Connector to all SAP On-Prem backends (ECC, SAP S/4HANA On-Prem, PI, PO, and more)
  • No. 3: Cloud Integration, which delivers an OData or SOAP API
  • No. 4: APIs from the Internet
  • No. 5: From the SAP Business Accelerator Hub for prototyping

Procedure for Creating an API Provider

The following steps must be carried out in order:

  1. Start the wizard by choosing the Create button:SAP Integration Suite interface open on Configure tab, showing API Providers section with 24 entries and a Create button highlighted in orange. Left sidebar displays options: Home, Discover, Design, Test, Configure.
  2. Enter a name and description in the Overview tab.SAP Integration Suite screenshot showing the addition of an API provider named GWSAMPLE_BASIC_API_Provider with a description of CLD Training, under the Overview tab.
  3. Enter the connection data in the Connection tab.Screenshot of SAP Integration Suite configuration screen showing API settings for GWSAMPLE_BASIC_API_Provider with connection details, and navigation menu on the left side.

    Note

    Use your own Host details to connect to your backend system.

    The following assignment applies:

    • Internet: No. 4
    • On-Premise: No. 2
    • Open Connectors: No. 1
    • Cloud Integration: No. 3

    Each type uses different configuration data. A detailed list of the parameters that must be set can be found at: Create an API Provider

  4. Enter the Catalog Service Settings data in the Catalog Service Settings tab.SAP Integration Suite Add API Provider page showing GWSAMPLE_BASIC_API_Provider Catalog Service Settings with fields for Path Prefix, Service Collection URL, Authentication type, Username, and Password.

    The path information (No. 1) is standardized in SAP S/4HANA. The catalog service and path can be found in the transaction /n/IWFND/MAINT_SERVICE on the SAP backend system. A basic authorization is required to access the catalog server.

  5. Test your API Provider. When you save the entries, the created API provider can be tested. To do this, use the Save button first.When you save the entries, the created API provider can be tested. To do this, use the Save button first.
    Choose Test Connection.

    Depending on the Type, a successful test is one of the following:

    HTTP Status Code
    The HTTP Status code 200 means that the connection to the backend system is correctly set up:Screenshot of the message that appears to show that the connection to the system was successful.
    HTTP Status Code with 404 Message
    The HTTP status code is not 200, but in this case it is correct since this is only a ping:Screenshot of a message that states System is up and reachable. However, the ping check responded with code: 404; Message: Not Found.

Sources

Read more: API Providers

Summary

An API provider encapsulates access to APIs from various sources. More than 260 third-party REST-based APIs are connected through the Open Connector. SAP backend systems such as SAP S/4HANA On-Prem or ECC/PI/PO can be connected through the Cloud Connector. SOAP APIs can also be made available through Cloud Integration. Ultimately, almost all APIs can be connected. The procedure for connecting a foreign API is wizard-controlled.

Create an API Provider Based on ES5 Demosystem

Business Scenario

For the utilization of the GWSAMPLE_BASIC API via the ES5 database, we are creating an API provider, which encapsulates the original interface. The API provider components and accompanying artifacts are marked in red in the following diagram.

Diagram of API management workflow showing connections from third-party APIs, SAP Backends, Cloud Integration, Internet, and more, through OpenConnectors and API-Provider to API management tools like API Designer and Discover.

Task Flow

In this exercise, you will perform the following steps:

  1. Log in to the API Management capability.
  2. Check the virtual Host name.
  3. Create an API Provider.
  4. Test the connection.

Prerequisites

You have a functioning API Management within the Integration Suite.

Exercise Outcome

A running API provider based on the ES5 demo system.

What will you learn from this exercise?

You get familiar with how to create and use an API provider of the Internet type into the API Management.

ExerciseStart Exercise

Learning

SAP FacebookSAP YoutubeSAP LinkedIn