Data Exchange
Edit on GitHubData Exchange refers to the process of transferring data between Spryker and third-party systems.
Spryker offers the following options to import and export data:
- Data Exchange API: available in SCCOS by default
- Data Importers and Data Exporters: available in Spryker Cloud Commerce OS (SCCOS) by default
Spryker Integration Apps
The Integration Apps let you import data between your Spryker system and third-party systems without any development effort and without the need to configure mapping and transformation of data, as the configurations are preset.
To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following:
- Have a user account on Spryker Middleware powered by Alumio.
- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform.
- Make minimum adjustments to the existing mapping and transformation of data.
Reach out to Spryker support or to your Customer Success Manager if you need access to the Spryker Middleware powered by Alumio and the Integration Apps.
We recommend considering Integration Apps for data exchange in the following cases:
- You require a quick setup of the data exchange process, which should take up to a few hours.
- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system, so you would have to make minimum adjustments.
- For your project, it’s important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc.
With the Spryker Integration Apps, the data exchange process looks like this:
Spryker provides Early Access to the Akeneo PIM Integration App. This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS.
The middleware allows customers to configure data that is to be transferred to Spryker, for example, attributes and super attributes.
Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App doesn’t include the transfer of “hot data” such as stock or pricing.
For details on how to import data from Akeneo to Spryker, see Configure the Akeneo PIM Integration App.
Custom integrations with custom connectors
If you have legacy systems or old version systems with which you need to exchange data and for which Alumio doesn’t provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build connectors.
Before beginning to implement any custom connector, double check if the connector with the third-party system you want to integrate with is on the list of existing Alumio standard connectors: Alumio iPaasS Connector Packages. This list is continuously updated. If the system you wish to integrate with isn’t on the list, you can submit a request for the implementation of a standard connector. This will give you an opportunity to assess if it aligns with your project timelines. For details on how to submit the request, refer to How do I request a new connector package?.
To build a data integration for a legacy system, you need to do the following:
- Have a user account on Spryker Middleware powered by Alumio.
- Build a connector to the legacy system using the Alumio SDK. Building a connector with the Alumio SDK usually takes up to a few weeks.
- Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, and changing them takes up to a few hours.
With the data integration with custom connectors, the data exchange process looks like this:
We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio doesn’t have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the time, this solution is still faster and, in the long term, more cost-efficient than, for example, using the default Data Importers and Data Exporters.
For information on how to build Alumio connectors with the Alumio SDK, check the Alumio documentation: Creating Alumio Connector Packages.
Data Exchange API
Data Exchange API is a dynamic database API that facilitates data transfer in real-time, ensuring data is exchanged across all integrated platforms. It’s part of the SCCOS platform core.
Data Exchange API lets you build, customize, and manage database APIs tailored to your specific business requirements through a user interface.
The main benefits of the Data Exchange API include the following:
- No coding is required: The API endpoints are created from the user interface.
- Rapid API generation: The APIs are generated within minutes.
- Flexibility and customization: You can tailor APIs to your needs. You can define parameters to ensure compatibility with your systems.
- Real-time updates: The infrastructure supports dynamic changes, so you can modify APIs on the fly.
- Security and Access Control: The infrastructure incorporates strong security measures and access controls, which safeguards sensitive information.
We recommend considering the Data Exchange API if you want to create your own data integration engine via API, without using any middleware software.
Data Importers and Data Exporters
Data Importers and Data Exporters are tools that let you bring external data into and send data from SCCOS, using .CSV files. Data Importers and Data Exporters are part of the SCCOS platform core. Data Importers and Data Exporters require extensive customization development for each project and ongoing development effort, which makes them less suitable for demanding data exchange.
For information on how Data importers and Exporters work, see Data import and Data export.
Thank you!
For submitting the form