Configuration

The Configuration tab allows for specifying the connection information to SAP API Business Hub for the download and testing of public SAP S/4HANA Cloud APIs and connection to production tenant.

Repository

In the Repository panel of the Configuration tab, you can specify the options for connecting to the SAP API Business Hub for downloading SAP S/4HANA Cloud APIs and testing these same APIs against a SAP-provided sandbox. The following table lists the configurations in the Repository panel:
Field Module Property Description
URL Yes URL of SAP API Hub

Default value is https://api.sap.com.

Caution: The URL property is editable but the default value should not be changed.
User Name Yes The user name for logging in to the SAP API Business Hub.
Password Yes The password for logging in to the SAP API Business Hub.

Tenant

In the Tenant panel of the Configuration tab, you can specify the connection information for the plug-in runtime for calling SAP S/4HANA Cloud APIs in a SAP provided sandbox or production tenant.
Field Module Property Description
Type No The type of tenant. The plug-in provides the following types:
  • Sandbox
    Note: When using the Sandbox environment, only GET operations are supported since the Sandbox environment provided by SAP is read-only.
  • Production
URL Yes URL of production tenant.
Authentication Type No The type of authentication.
The plug-in provides the following authentication types:
  • Basic Authentication
  • OAuth 2.0
  • SSL
Communication User Name Yes The communication user name for connecting to the tenant.
Note: Required if 'Basic Authentication' or 'OAuth 2.0' is selected as Authentication Type.
Communication User Password Yes The communication user password for connecting to the tenant.
Note: Required if 'Basic Authentication' or 'OAuth 2.0' is selected as Authentication Type.
Business User Email Yes The email address of business user in tenant.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Note: Do not configure the same email address in more than one shared resource.
Client ID Yes The client ID configured in tenant.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Note: Do not configure the same client ID in more than one shared resource.
Service No. of Threads Yes The number of concurrent threads for processing requests to the activity. The default value is 8.
Note: If the value is less than 1 then it would default to 8. See the Job Tuning section for more information in how this field should be configured.

Security

In the Security panel of the Configuration tab, you can specify additional connection information that is required when the Authentication Type is 'SSL'.
Field Module Property Description
Confidentiality No Needs to be selected when Authentication Type is 'SSL'.
Note: When the check box is selected, the SSL Client reference would be appear.
SSL Client Yes Reference to SSL Client Configuration shared resource.
Note: Required if 'SSL' is selected for Authentication Type.

OAuth 2.0

In the OAuth 2.0 panel of the Configuration tab, you can specify additional connection information that is required when the Authentication Type is 'OAuth 2.0'.
Field Module Property Description
Keystore Type No The type of keystore being used.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Note: JKS, JCEKS and PKCS#12 keystore types are supported.
Keystore URL Yes The location of the keystore file.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Note: When doing configuration for cloud environment, you must store the keystore file in the workspace and use relative paths when specifying the keystore URL.
Keystore Password Yes The password used when creating the keystore file.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Key Alias Name Yes The key alias name.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.
Key Alias Password Yes The key alias password.
Note: Required if 'OAuth 2.0' is selected for Authentication Type.

Schema

In the Schema panel of the Configuration tab, you can browse and download SAP S/4HANA Cloud APIs.

For filtering on specific APIs, enter search string for the API column.

For getting information on the operations available for a specific APIs or service, click the Service column to expand.

For downloading a specific API or service, select the API Name and select the Download API at bottom of panel. To refresh the API list, click Refresh APIs.

Note: Only one API can be downloaded at a time.