Skip to main content
Via the external data interface, additional content and supplementary data (e.g. extended product/category information or CMS content) can be integrated into the WEBSALE storefront. There is no classic API endpoint: the data is stored as files (currently JSON) in the shop’s own S3 and is read and rendered in the storefront via the template engine. The data thus primarily serves output in templates and is only available to a very limited extent for shop functions or other dynamic processes. Further details on integration and output can be found in the

​
Provision in the shop

The external data interface is a standard part of every WEBSALE shop and can generally be used. Access credentials for uploading to the S3 area are not automatically provided with the shop, but must be requested separately via the ordering portal of WEBSALE AG.

​
Data storage in S3

​
Bucket external-data

In external-data, files that are provided by the project team are stored — e.g. manually by the template manager or automatically by external systems/programs (e.g. PIM).

​
Bucket system

The system bucket is filled exclusively by WEBSALE components. This also includes JSON data from the WEBSALE Strapi instance, which is provided per shop by default.
system is not intended for your own uploads or for data from external, customer-owned systems.

​
Supported data formats

Currently, only data in JSON format is processed. Further formats may be added in the future. If needed, contact your WEBSALE contact.

​
Use in the storefront

The data from the buckets external-data and system can be read in and output in the storefront via the template engine. More information on data access and use in templates can be found here. For embedding the data into the template, GitHub is required; more info on this can be viewed here.