SAP Commerce Cloud account details

To establish a connection to SAP Commerce Cloud, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters

You can define one or more accounts for SAP Commerce Cloud.

For each account that you require, you can specify a new set of account details in any of the following ways:

  • If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
  • If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

You can obtain values for the clientId and clientSecret parameters from the SAP Commerce Cloud Backoffice at https://host or IP address:port number/backoffice.

Field Parameter Values Condition Description

Account name

name

User defined

Required

The name of an SAP Commerce Cloud account that is used in the exported flow.

Authentication type

authType

BASIC

Required

The mechanism that is used for user authorization.

Base site ID

baseSiteId

User defined

Required

The SAP Commerce Cloud base site or store ID.

User name

username

User defined

Required

The user name for your SAP Commerce Cloud account.

Password

password

User defined

Required

The password for your SAP Commerce Cloud account.

Client ID

clientId

User defined

Required

The client ID for your SAP Commerce Cloud account.

Client secret

clientSecret

User defined

Required

The client secret for your SAP Commerce Cloud account.

Application version

applicationVersion

1808

Required

The SAP Commerce Cloud version number. The supported (and default) version is 1808.

Endpoint URL

endpointUrl

User defined

Required

The SAP Commerce Cloud URL in the format https://host or IP address:port number.

Example

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

  saphybris:
        - name: "Account 1"
          credentials:
              authType: BASIC
              baseSiteId: "store1"
              username: "user@email.com"
              password: "abcde123fghij456klm"
              clientId: "abcdefghijklmnop"
              clientSecret: "aB1Cde23Fgh456iJ"
              applicationVersion: "1808"
          endpoint:
              endpointUrl: "https://123.4.5.6:78"