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 Emporix Digital Commerce Platform.
For more information about Emporix visit www.emporix.com. Lean more about their API here.
- Server running node 18 or later
- A tenant on the Emporix Digital Commerce Platform
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. |
| 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 Emporix. |
| BASE_URL | The base URL of the Emporix API |
| EMPORIX_TENANT | The ID of the Emporix Tenant used for products and categories. |
| CLIENT_ID | The client ID used to authenticate to Emporix using OAuth2. |
| CLIENT_SECRET | The client secret used to identify to Emporix using OAuth2. |
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:8080/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.
The FirstSpirit Connect for Emporix Digital Commerce Platform bridge is a product of neteleven GmbH, Germany. The FirstSpirit Connect for Emporix Digital Commerce Platform bridge is subject to the Apache-2.0 license.
Details regarding any third-party software products in use but not created by neteleven 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. neteleven 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. neteleven 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.