Schnittstellen

Die Schnittstellen des WEBSALE-Shopsystems ermöglichen die Integration externer Systeme und Anwendungen mit dem Shopsystem. Sie bilden die technische Grundlage für den Datenaustausch zwischen Frontend, Backend und angebundenen Drittsystemen wie ERP-, CRM- oder Warenwirtschaftslösungen.

Diese Dokumentation richtet sich an Entwicklerinnen und Entwickler, Systemintegratoren sowie technische Partner, die eine Verbindung zu WEBSALE herstellen oder bestehende Datenflüsse automatisieren möchten.

Grundlegende Kenntnisse in REST-APIs, HTTP-Requests und JSON werden vorausgesetzt. Von Vorteil sind Erfahrungen im Umgang mit Authentifizierungsverfahren (z. B. OAuth) und Webhooks.

Die Dokumentation unterscheidet folgende Hauptbereiche:

Admin Interface API

Die Admin Interface API (REST API des Adminbereichs) ermöglicht den automatisierten Zugriff auf Verwaltungs- und Systemfunktionen des Shops.  Sie dient ausschließlich zur Kommunikation mit dem Administrations-Backend des Shops und unterstützt Abläufe wie Bestellabruf, Kundendatenverwaltung oder Statusaktualisierungen und richtet sich an technische Integrationen und Schnittstellenlösungen, die Daten aus dem Backend lesen oder dort verarbeiten, synchronisieren oder administrieren – beispielsweise für Warenwirtschaft, ERP, CRM oder andere externe Systeme.

Diese API ist nicht für den Aufbau oder Betrieb einer Storefront geeignet.

→ Zu den Endpunkten der Admin Interface API

Storefront API

Die Storefront API dient zur Anbindung von Frontends (z. B. Headless-Storefronts, Progressive Web Apps, Mobile Apps etc.) an das WEBSALE-Shopsystem. Über diese API werden Daten und Funktionen bereitgestellt, die für den Aufbau und Betrieb der sichtbaren Shopoberfläche benötigt werden – etwa Produktdaten, Warenkorbaktionen, Kundenkonten oder Bestellprozesse etc.

→ Zu den Endpunkten der Storefront API

Search API

Die Search API stellt den HTTPS-basierten Zugriff auf das versionsunabhängige Suchmodul WEBSALE Search bereit.

→ Zu den Endpunkten der Search API

ASSE-Schnittstelle (Server-Side-Events)

Über die ASSE-Schnittstelle (Asynchronous-Server-Side-Events) können beliebige Daten aus dem Shop asynchron per HTTPS an externe Systeme übermittelt werden (z. B. Newsletter-, Such- oder Tracking-Dienste). Die Übertragung erfolgt serverseitig (Shop-Server → Empfänger-Server) und unabhängig vom Client.

→ Zur ASSE-Schnittstelle

Externe Datenschnittstelle (Datei-/Bucket-basiert)

Über die externe Datenschnittstelle können zusätzliche Inhalte und Zusatzdaten (z. B. erweiterte Produkt-/Kategorieinformationen oder CMS-Inhalte) in die WEBSALE Storefront eingebunden werden.

→ Zur externen Datenschnittstelle