The bridge API serves as a REST interface which is able to fetch content, product and category information from any shop backend and to display them in reports in the FirstSpirit ContentCreator.
In order to connect the bridge API with a given shop backend a bridge is needed. It acts as a microservice between the shop backend and FirstSpirit. Further information about how to implement and use a bridge can be found in the official documentation.
For more information about FirstSpirit or Connect for Commerce please use this contact form to get in touch.
This project implements the bridge API to connect FirstSpirit and the SAP Commerce Cloud e-commerce platform.
For more information about SAP Commerce Cloud visit the SAP commerce website. Lean more about their API here and here.
- Server running node 18 or later
- SAP Commerce Cloud instance
- Access to the SAP OCC API
- Access to the SAP CMS Item API
The configuration is done by copying the .env.template file in the root directory to a .env file and editing it.
| Param | Description |
|---|---|
| PORT | The port on which the bridge is started. |
| BRIDGE_AUTH_USERNAME | The username to access the bridge's API. |
| BRIDGE_AUTH_PASSWORD | The password to access the bridge's API. |
| DEFAULT_LANG | The default bridge language used to retrieve fallback languages in the PUT/POST bodies. |
| CONN_MODE | Whether to use HTTP or HTTPS for the bridge's API. |
| SSL_CERT | The path to the certificate file to use when using HTTPS. |
| SSL_KEY | The path to the private key file to use when using HTTPS. |
| OAUTH_TOKEN_URL | The URL where the Oauth token can be retrieved from SAP Commerce. |
| OCC_BASE_URL | The base URL of the SAP Commerce Server to retrieve categories and products (the URL without any paths). |
| CMS_BASE_URL | The base URL of the SAP Commerce Server to retrieve content pages (the URL without any paths). |
| MEDIA_CDN_URL | The URL of the Server where the Media files (Images) reside. (SAP Commerce default: the same as the BASE_URL). |
| OCC_PATH | The path of the OCC V2 api, relative to the BASE_URL (SAP Commerce default: "/occ/v2/"). |
| CMS_PATH | The Path of the CMS webservices API, relative to the BASE_URL (SAP Commerce default: "/cmswebservices/v1/sites/"). |
| BASE_SITE_ID | The ID of the SAP Commerce Basesite used for content and products. |
| CATALOG_ID | The ID of the product catalog used in SAP Commerce. |
| CATALOG_VERSION | The version of the product catalog used in SAP Commerce. |
| CONTENT_CATALOG_ID | The ID of the content catalog used in SAP Commerce. |
| CONTENT_CATALOG_VERSION | The version of the content catalog used in SAP Commerce. |
| API_USERNAME | The username to authenticate to SAP Commerce. |
| API_PASSWORD | The password to authenticate to SAP Commerce. |
| CLIENT_ID | The client ID used to authenticate to SAP Commerce using OAuth2. |
| CLIENT_SECRET | The client secret used to identify to SAP Commerce using OAuth2. |
| AIR_KEY | The AIR (Application Interface Register) Key, as obtained from SAP (optional). |
To map FirstSpirit Templates to SAP Commerce Cloud Templates this Bridge uses a simple .json file, which can be found at 'src/resources/FStoSAPTemplateMapping.json'. To add to this map simply use the FirstSpirit template Ids as keys and the SAP Commerce Cloud template Ids as values.
Before starting the bridge for the first time, you have to install its dependencies:
npm install
To start the bridge run:
npm start
To start the bridge and re-start it whenever a file changed:
npm run start:watch
Open http://localhost:3000/docs in your browser to display the bridge's interactive API documentation.
In order to enable the Connect for Commerce FirstSpirit Module to communicate with the bridge, you have to configure it. Please refer to the documentation to learn how to achive this.
We provide an example Dockerfile and docker-compose.yml to enable multi-tenant support for this service.
Build and tag the Docker image with a custom name and version:
docker build -t <IMAGE_NAME>:<VERSION> .
The docker-compose.yml demonstrates how to define multiple instances of the bridge with a different configuration.
Replace <IMAGE_NAME>:<VERSION> with the name and tag that you chose for your Docker image.
Each configuration for an instance is set with a different .env.* file. The path to it needs to be defined under env_file.
Start the containers:
docker compose up -d
Stop the containers:
docker compose down
Please be aware that the Docker containers need to be accessible from your FirstSpirit instance in order to work with the Connect for Commerce module. A deployment to a Cloud provider might be necessary for this.
The FirstSpirit Connect for Commerce SAP Commerce Cloud bridge is a product of Crownpeak Technology GmbH, Dortmund, Germany. The FirstSpirit Connect for Commerce SAP Commerce Cloud bridge is subject to the Apache-2.0 license.
Details regarding any third-party software products in use but not created by Crownpeak Technology GmbH, as well as the third-party licenses and, if applicable, update information can be found in the file THIRD-PARTY.txt.
This document is provided for information purposes only. Crownpeak may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. Crownpeak specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.