Interfaces

The interfaces of the WEBSALE shop system enable the integration of external systems and applications with the shop system. They form the technical foundation for data exchange between the frontend, backend, and connected third-party systems such as ERP, CRM, or merchandise management solutions. This documentation is aimed at developers, system integrators, and technical partners who want to establish a connection to WEBSALE or automate existing data flows. Basic knowledge of REST APIs, HTTP requests, and JSON is assumed. Experience with authentication procedures (for example OAuth) and webhooks is an advantage. The documentation distinguishes the following main areas:

​

Admin Interface API

The Admin Interface API (REST API of the admin area) enables automated access to the management and system functions of the shop. It is used exclusively for communication with the administration backend of the shop and supports processes such as order retrieval, customer data management, or status updates. It is aimed at technical integrations and interface solutions that read, process, synchronize, or administer data from the backend – for example for merchandise management, ERP, CRM, or other external systems. This API is not suitable for building or operating a storefront. → To the endpoints of the Admin Interface API

​

Storefront API

The Storefront API is used to connect frontends (for example headless storefronts, progressive web apps, mobile apps, etc.) to the WEBSALE shop system. This API provides data and functions required for building and operating the visible shop interface – such as product data, basket actions, customer accounts, or order processes, etc. → To the endpoints of the Storefront API

​

Search API

The Search API provides HTTPS-based access to the version-independent search module WEBSALE Search. → To the endpoints of the Search API

​

ASSE interface (server-side events)

Via the ASSE interface (Asynchronous Server-Side Events), arbitrary data from the shop can be transmitted asynchronously via HTTPS to external systems (for example newsletter, search, or tracking services). The transmission takes place server-side (shop server → recipient server) and is independent of the client. → To the ASSE interface

​

External data interface (file/bucket-based)

Via the external data interface, additional content and supplementary data (for example extended product/category information or CMS content) can be integrated into the WEBSALE storefront. → To the external data interface