In this lesson, the following topics are discussed:
- The role of an API provider.
- Procedure for creating an API provider.
The 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.
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 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:
- Start the wizard by choosing the Create button:
- Enter a name and description in the Overview tab.
- Enter the connection data in the Connection tab.
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
- Enter the Catalog Service Settings data in the Catalog service Settings tab. You start the wizard using Configuration → APIs and choose the Create button.
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.
- Test your API Provider.
When you save the entries, the created API provider can be tested. To do this, use the Test Connection button.
Depending on the Type, a successful test is one of the following:
- Type Internet and On-Prem
- The HTTP status code is 200, that means OK:
- Type Open Connectors and Cloud integration
- The HTTP status code is not 200, but in this case it is correct since this is only a ping:
The following sources can be found at the SAP Help Portal: API Providers
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 the Cloud Integration. Ultimately, almost all APIs can be connected. The procedure for connecting a foreign API is wizard-controlled.